Pervasive Displays Library Suite - Reference Manual 9.0.3
Library for Pervasive Displays e-paper screens, extension boards and development kits
All Classes Files Functions Variables Enumerations Enumerator Macros Pages
File_Frame Class Reference

Screen saved as raw frame-buffer file on SD-card. More...

#include <hV_File_Frame.h>

Inheritance diagram for File_Frame:
Collaboration diagram for File_Frame:

Public Member Functions

 File_Frame (Screen_EPD *screen)
 Constructor object.
 
uint8_t saveScreen (STRING_CONST_TYPE name)
 Screen saved as image header file to SD-card.
 
uint8_t readScreen (STRING_CONST_TYPE name)
 Read a buffer 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 raw frame-buffer file on SD-card.

Frame-buffer binary file

Note
No check at read
Warning
MCU requires an SD-card library

Constructor & Destructor Documentation

◆ File_Frame()

File_Frame::File_Frame ( Screen_EPD * screen)

Constructor object.

Parameters
screen&screen to link File_Frame to

Member Function Documentation

◆ readScreen()

uint8_t File_Frame::readScreen ( STRING_CONST_TYPE name)

Read a buffer file.

Frame-buffer updated, flush() required

Parameters
namefile name
Returns
RESULT_SUCCESS is successful, RESULT_ERROR otherwise
Warning
Use flush() to refresh the panel

◆ saveScreen()

uint8_t File_Frame::saveScreen ( STRING_CONST_TYPE name)

Screen saved as image header file to SD-card.

Parameters
namefile name, only letters and numbers
Returns
RESULT_SUCCESS is successful, RESULT_ERROR otherwise

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