MPLABĀ® Harmony Graphics Suite  GFX v3.13.0
Legato API Documentation
gfx_canvas_api.h File Reference

GFX Canvas Virtual Display definitions and functions. More...

#include "gfx/driver/gfx_driver.h"
Include dependency graph for gfx_canvas_api.h:

Go to the source code of this file.

Macros

#define GFXC_COLOR_FORMAT   gfxColorMode
 
#define GFXC_RESULT   gfxResult
 

Typedefs

typedef void(* gfxcCallback) (unsigned int canvasID, GFXC_FX_TYPE effect, GFXC_FX_STATUS status, void *parm)
 

Enumerations

enum  GFXC_FX_TYPE { GFXC_FX_FADE, GFXC_FX_MOVE }
 
enum  GFXC_STATUS { GFXC_STAT_IDLE = 0, GFXC_STAT_BUSY }
 
enum  GFXC_FX_MOVE_TYPE { GFXC_FX_MOVE_FIXED, GFXC_FX_MOVE_ACC, GFXC_FX_MOVE_DEC }
 
enum  GFXC_FX_STATUS { GFXC_FX_IDLE, GFXC_FX_DONE = GFXC_FX_IDLE, GFXC_FX_START, GFXC_FX_RUN }
 

Functions

int gfxcCreate (void)
 
GFXC_RESULT gfxcDestroy (unsigned int canvasID)
 
GFXC_RESULT gfxcSetPixelBuffer (unsigned int canvasID, unsigned int width, unsigned int height, const GFXC_COLOR_FORMAT format, void *buf)
 
GFXC_RESULT gfxcCopyBuffer (unsigned int srcID, unsigned int destID, const gfxRect *srcRect, const gfxRect *destRect)
 
GFXC_RESULT gfxcSetBaseCanvasID (unsigned int base)
 
GFXC_RESULT gfxcSetLayer (unsigned int canvasID, unsigned int layerID)
 
int gfxcGetlayer (unsigned int canvasID)
 
GFXC_RESULT gfxcClearLayer (unsigned int canvasID)
 
GFXC_RESULT gfxcSetWindowAlpha (unsigned int canvasID, uint8_t alpha)
 
GFXC_RESULT gfxcSetWindowPosition (unsigned int canvasID, int xpos, int ypos)
 
GFXC_RESULT gfxcGetWindowPosition (unsigned int canvasID, int *xpos, int *ypos)
 
GFXC_RESULT gfxcSetWindowSize (unsigned int canvasID, unsigned int width, unsigned int height)
 
GFXC_RESULT gfxcGetWindowSize (unsigned int canvasID, unsigned int *width, unsigned int *height)
 
GFXC_RESULT gfxcSetEffectsCallback (unsigned int canvasID, gfxcCallback cb, void *parm)
 
GFXC_RESULT gfxcShowCanvas (unsigned int canvasID)
 
GFXC_RESULT gfxcHideCanvas (unsigned int canvasID)
 
GFXC_RESULT gfxcCanvasUpdate (unsigned int canvasID)
 
GFXC_RESULT gfxcStartEffectFade (unsigned int canvasID, uint8_t startAlpha, uint8_t endAlpha, uint8_t delta)
 
GFXC_RESULT gfxcStartEffectMove (unsigned int canvasID, GFXC_FX_MOVE_TYPE type, int startX, int startY, int endX, int endY, unsigned int delta)
 
GFXC_RESULT gfxcStopEffect (unsigned int canvasID, GFXC_FX_TYPE effect)
 
GFXC_STATUS gfxcGetStatus (void)
 
void GFX_CANVAS_Initialize (void)
 
void GFX_CANVAS_Task (void)
 

Variables

const gfxDisplayDriver gfxDriverInterface
 

Detailed Description

GFX Canvas Virtual Display definitions and functions.

The GFX Canvas provides a virtual display driver interface.