File_Image Class Reference

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

#include <hV_File_Image.h>

Inheritance diagram for File_Image:

Collaboration diagram for File_Image:

Public Member Functions
	File_Image (Screen_EPD *screen)
	Constructor object.
uint8_t	saveScreen (STRING_CONST_TYPE name)
	Screen saved as image header file to SD-card.
uint8_t	saveWindow (STRING_CONST_TYPE name, uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy)
	Save partial screen as header file to SD-card.
uint8_t	readScreen (image_s image)
	Read an image from a header file.
	File_Image (Screen_EPD *screen)
	Constructor object.
uint8_t	saveScreen (STRING_CONST_TYPE name)
	Screen saved as image header file to SD-card.
uint8_t	saveWindow (STRING_CONST_TYPE name, uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy)
	Save partial screen as header file to SD-card.
uint8_t	readScreen (image_s image)
	Read an 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.
	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	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 image header file on SD-card.

Shared header for Linux and MCU

Note

For monochrome screens only, 1 bit per pixel

Header file to be included in project

Warning

MCU requires an SD-card library

Constructor & Destructor Documentation

File_Image() [1/2]

File_Image::File_Image

(

Screen_EPD *

screen

)

Constructor object.

Parameters

screen

&screen to link File_Image to

File_Image() [2/2]

File_Image::File_Image

(

Screen_EPD *

screen

)

Constructor object.

Parameters

screen

&screen to link File_Image to

Member Function Documentation

readScreen() [1/2]

uint8_t File_Image::readScreen

(

image_s

image

)

Read an image from a header file.

Frame-buffer updated, flush required

Note

Image compiled as header file at build-time

Parameters

image

image_s image

readScreen() [2/2]

uint8_t File_Image::readScreen

(

image_s

image

)

Read an image from a header file.

Frame-buffer updated, flush required

Note

Image compiled as header file at build-time

Parameters

image

image_s image

saveScreen() [1/2]

uint8_t File_Image::saveScreen

(

STRING_CONST_TYPE

name

)

Screen saved as image header file to SD-card.

Parameters

name	file name, only letters and numbers

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

saveScreen() [2/2]

uint8_t File_Image::saveScreen

(

STRING_CONST_TYPE

name

)

Screen saved as image header file to SD-card.

Parameters

name	file name, only letters and numbers

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

saveWindow() [1/2]

uint8_t File_Image::saveWindow	(	STRING_CONST_TYPE	name,
		uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy )

Save partial screen as header file to SD-card.

Parameters

name	file name, only letters and numbers
x0	top left coordinate, x-axis
y0	top left coordinate, y-axis
dx	width to be copied, x-axis
dy	height to be copied, y-axis

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

saveWindow() [2/2]

uint8_t File_Image::saveWindow	(	STRING_CONST_TYPE	name,
		uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy )

Save partial screen as header file to SD-card.

Parameters

name	file name, only letters and numbers
x0	top left coordinate, x-axis
y0	top left coordinate, y-axis
dx	width to be copied, x-axis
dy	height to be copied, y-axis

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

---

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

• PDLS_Commercial/hV_File/src/hV_File_Image.h
• PDLS_Viewer/hV_File_Viewer/src/hV_File_Image.h