Struct daisy::UiCanvasDescriptor¶
ClassList > daisy > UiCanvasDescriptor
A descriptor for a canvas in the UI system.More...
#include <UI.h>
Public Types¶
| Type | Name |
|---|---|
| typedef void(*)(const UiCanvasDescriptor &canvasToClear) | ClearFuncPtr |
| typedef void(*)(const UiCanvasDescriptor &canvasToFlush) | FlushFuncPtr |
Public Attributes¶
| Type | Name |
|---|---|
| ClearFuncPtr | clearFunction_ |
| FlushFuncPtr | flushFunction_ |
| void * | handle_ |
| uint8_t | id_ |
| bool | screenSaverOn = [**false**](classdaisy_1_1Apds9960.md) |
| uint32_t | screenSaverTimeOut = 0 |
| uint32_t | updateRateMs_ |
Detailed Description¶
Author:
jelliesen
A descriptor for a generic display / led / output device that's used in the UI system.
Public Types Documentation¶
typedef ClearFuncPtr¶
A function to clear the display before the UiPages are drawn.
typedef FlushFuncPtr¶
A function to call when all UIPages have finished the drawing procedure and the results can be flushed out to the device.
Public Attributes Documentation¶
variable clearFunction_¶
variable flushFunction_¶
variable handle_¶
A pointer to some object that allows to draw to the canvas. In your UI pages, you will use the id_ to identify which canvas this is, and then cast this pointer to whatever object it represents, e.g. OledDisplay.
variable id_¶
An id number to tell apart various types of canvases that are used concurrently in your system.
variable screenSaverOn¶
variable screenSaverTimeOut¶
The desired timeout in ms before a display will shut off. This defaults to 0, which will keep the display on all the time. Nonzero values are useful for displays that can suffer from burn-in, such as OLEDs.
variable updateRateMs_¶
The desired update rate in ms
The documentation for this class was generated from the following file external-docs/libDaisy/src/ui/UI.h