File_P4 Class Reference

Screen saved as pixmap header file on SD-card. More...

#include <hV_File_P4.h>

Inheritance diagram for File_P4:

Collaboration diagram for File_P4:

Public Member Functions
	File_P4 (Screen_EPD *screen)
	Constructor object.
uint8_t	saveScreen (STRING_CONST_TYPE name)
	Screen saved as pixmap header file to SD-card.
uint8_t	readScreen (const uint8_t *imageP4)
	Read an P4 image from a header 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 pixmap header file on SD-card.

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_P4()

File_P4::File_P4

(

Screen_EPD *

screen

)

Constructor object.

Parameters

screen

&screen to link File_P4 to

Member Function Documentation

readScreen()

uint8_t File_P4::readScreen

(

const uint8_t *

imageP4

)

Read an P4 image from a header file.

Framebuffer updated, flush required

Note

P4 compiled as header file at build-time

Parameters

imageP4

PBM P4 pixmap header file

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

saveScreen()

uint8_t File_P4::saveScreen

(

STRING_CONST_TYPE

name

)

Screen saved as pixmap header file to SD-card.

Parameters

name	file name, only letters and numbers

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

Note

The resulting file is a header file.

---

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

• hV_File_P4.h