version 2.8
gdisp_image.h File Reference

Go to the source code of this file.

Data Structures

struct  gdispImage
 The structure for an image. More...
 

Functions

void gdispImageInit (gdispImage *img)
 Initialise a gdispImage object. More...
 
gdispImageError gdispImageOpenGFile (gdispImage *img, GFILE *f)
 Open an image using an open GFILE and get it ready for drawing. More...
 
void gdispImageClose (gdispImage *img)
 Close an image and release any dynamically allocated working storage. More...
 
bool_t gdispImageIsOpen (gdispImage *img)
 Is an image open. More...
 
void gdispImageSetBgColor (gdispImage *img, color_t bgcolor)
 Set the background color of the image. More...
 
gdispImageError gdispImageCache (gdispImage *img)
 Cache the image. More...
 
gdispImageError gdispGImageDraw (GDisplay *g, gdispImage *img, coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t sx, coord_t sy)
 Draw the image. More...
 
delaytime_t gdispImageNext (gdispImage *img)
 Prepare for the next frame/page in the image file. More...
 
uint16_t gdispImageGetPaletteSize (gdispImage *img)
 Get the number of entries in the color palette. More...
 
color_t gdispImageGetPalette (gdispImage *img, uint16_t index)
 Get an entry in the color palette. More...
 
bool_t gdispImageAdjustPalette (gdispImage *img, uint16_t index, color_t newColor)
 Modify an entry in the color palette. More...
 

Macros

#define gdispImageOpenFile(img, filename)   gdispImageOpenGFile((img), gfileOpen((filename), "rb"))
 Open an image in a file and get it ready for drawing. More...
 
#define gdispImageOpenBaseFileStream(img, BaseFileStreamPtr)   gdispImageOpenGFile((img), gfileOpenBaseFileStream((BaseFileStreamPtr), "rb"))
 Open an image in a ChibiOS basefilestream and get it ready for drawing. More...
 
#define gdispImageOpenMemory(img, ptr)   gdispImageOpenGFile((img), gfileOpenMemory((void *)(ptr), "rb"))
 Open an image in memory and get it ready for drawing. More...
 

Typedefs

typedef uint16_t gdispImageType
 The type of image. More...
 
typedef uint16_t gdispImageError
 An image error code. More...
 
typedef uint16_t gdispImageFlags
 Image flags. More...
 
typedef struct gdispImage gdispImage
 The structure for an image. More...