File_PBM Class Reference

Screen saved as PBM pixmap file. More...

#include <hV_File_PBM.h>

Inheritance diagram for File_PBM:

Collaboration diagram for File_PBM:

Public Member Functions
	File_PBM (Screen_EPD *screen)
	Constructor object.
uint8_t	saveScreen (STRING_CONST_TYPE name)
	Screen saved as PBM pixmap file to SD-card.
uint8_t	readScreen (STRING_CONST_TYPE name)
	Read PBM file.
Public Member Functions inherited from File_System
	File_System ()
	Constructor.
uint8_t	beginFileSystem (uint8_t pinCS=NOT_CONNECTED, uint8_t port=0, int8_t pinDetect=-1, int level=LOW)
	File system initialisation.
uint8_t	endFileSystem ()
	Close file system.
uint8_t	setFolder (STRING_CONST_TYPE name)
	Set the folder for files.
uint8_t	suspendFileSystem ()
	Suspend file system.
uint8_t	resumeFileSystem ()
	Resume file system after suspend.
uint8_t	saveScreen (STRING_CONST_TYPE name, uint8_t multiplier=1)
	Screen saved as file to SD-card.
uint8_t	saveWindow (STRING_CONST_TYPE name, uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint8_t multiplier=1)
	Save partial window as file to SD-card.
uint8_t	readScreen (STRING_CONST_TYPE name, uint8_t multiplier=1)
	Load and display BMP file.
void	printFileSystemError ()
	Print the file system error.

Detailed Description

Screen saved as PBM pixmap file.

Shared header for Linux and MCU

Note

For monochrome screens only, 1 bit per pixel

Warning

MCU requires an SD-card library

Constructor & Destructor Documentation

File_PBM()

File_PBM::File_PBM

(

Screen_EPD *

screen

)

Constructor object.

Parameters

screen

&screen to link File_PBM to

Member Function Documentation

readScreen()

uint8_t File_PBM::readScreen

(

STRING_CONST_TYPE

name

)

Read PBM file.

Frame-buffer updated, flush required

Parameters

name

file name

Note

The resulting P4 file is pixmap PBM coded.

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

Warning

Prefer P4 file generated by saveScreen()

saveScreen()

uint8_t File_PBM::saveScreen

(

STRING_CONST_TYPE

name

)

Screen saved as PBM pixmap file to SD-card.

Parameters

name	file name, only letters and numbers

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

Note

The resulting P4 file is pixmap PBM coded.

---

The documentation for this class was generated from the following file:

• hV_File_PBM.h