Embedded Artists / DMBasicGUI

A basic graphics package for the LPC4088 Display Module.

Dependents:   lpc4088_displaymodule_demo_sphere sampleGUI sampleEmptyGUI lpc4088_displaymodule_fs_aid ... more

Fork of DMBasicGUI by EmbeddedArtists AB

Embed: (wiki syntax)

« Back to documentation index

Renderer Class Reference
Public Member Functions

Renderer Class Reference

Renderer for the SlideShow engine. More...

#include <Renderer.h>

Public Member Functions

uint32_t registerUser (int layer, int xoff, int yoff, int width, int height)
 Registers a part of the screen on a specific layer to be in use.
uint32_t registerFullscreenUser (int layer)
 Registers the entire screen on a specific layer to be in use.
void unregisterUser (uint32_t handle)
 Removes a previously registered user.
void setFramebuffer (uint32_t handle, const uint16_t *data)
 Informs the renderer that there is new data to render.
void render ()
 Run the renderer.

Detailed Description

Renderer for the SlideShow engine.

The renderer handles all (if more than one) running slideshows and the layer(s) they are drawn on.

For information on how to use the SlideShow and some examples see https://developer.mbed.org/teams/Embedded-Artists/wiki/LPC4088DM-Using-the-SlideShow-Engine

Definition at line 32 of file Renderer.h.

Member Function Documentation

uint32_t registerFullscreenUser ( int  layer )

Registers the entire screen on a specific layer to be in use.

Returns a handle to pass when updating the framebuffer.

Parameters:
layer0 is the bottom of the stack, higher number is on top
Returns:
handle to pass to setFrameBuffer function 0 on failure

Definition at line 138 of file Renderer.cpp.

uint32_t registerUser ( int  layer,
int  xoff,
int  yoff,
int  width,
int  height 
)

Registers a part of the screen on a specific layer to be in use.

Returns a handle to pass when updating the framebuffer.

Parameters:
layer0 is the bottom of the stack, higher number is on top
xofftop left corner of the drawing rectangle
yofftop left corner of the drawing rectangle
widthwidth of the drawing rectangle
heightheight of the drawing rectangle
Returns:
handle to pass to setFrameBuffer function 0 on failure

Definition at line 76 of file Renderer.cpp.

void render (  )

Run the renderer.

Should be called from a high priority thread.

Definition at line 198 of file Renderer.cpp.

void setFramebuffer ( uint32_t  handle,
const uint16_t *  data 
)

Informs the renderer that there is new data to render.

Blocks until the data has been registered. After that point the data must not be modified until next call to setFramebuffer.

Parameters:
handlethe handle from the registerUser() call
datathe image data

Definition at line 183 of file Renderer.cpp.

void unregisterUser ( uint32_t  handle )

Removes a previously registered user.

Parameters:
handlethe handle from the registerUser() call

Definition at line 143 of file Renderer.cpp.

Generated on Tue Jul 12 2022 21:27:04 by  doxygen 1.7.2