GLIB - Graphics Library#

GLIB_Font_Class#

GLIB_Font_Class

Font classes.

GLIB_Align_t#

GLIB_Align_t

Alignment types.

GLIB_contextInit#

EMSTATUS GLIB_contextInit (GLIB_Context_t * pContext)

Define the default font.

An application can override the default font by defining GLIB_NO_DEFAULT_FONT and by providing a custom GLIB_DEFAULT_FONT macro that points to a GLIB_Font_t structure that should be used as a default font.

Initialize the GLIB_Context_t

The context is set to default values and gets information about the display from the display driver.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_displayWakeUp#

EMSTATUS GLIB_displayWakeUp (void )

Returns the display from sleep mode.

Returns

• Returns DMD_OK on success, or else error code

GLIB_displaySleep#

EMSTATUS GLIB_displaySleep (void )

Sets the display in sleep mode.

Returns

• Returns DMD_OK on success, or else error code

GLIB_clear#

EMSTATUS GLIB_clear (GLIB_Context_t * pContext)

Clears the display with the background color of the GLIB_Context_t.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_clearRegion#

EMSTATUS GLIB_clearRegion (const GLIB_Context_t * pContext)

Clears the clipping region by filling it with the background color of the GLIB_Context_t.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_resetDisplayClippingArea#

EMSTATUS GLIB_resetDisplayClippingArea (GLIB_Context_t * pContext)

Reset the display driver clipping area to the whole display.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_resetClippingRegion#

EMSTATUS GLIB_resetClippingRegion (GLIB_Context_t * pContext)

Reset the GLIB_Context_t clipping region to the whole display.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_applyClippingRegion#

EMSTATUS GLIB_applyClippingRegion (const GLIB_Context_t * pContext)

Apply the clipping region from the GLIB_Context_t in the DMD driver.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_colorTranslate24bpp#

void GLIB_colorTranslate24bpp (uint32_t color, uint8_t * red, uint8_t * green, uint8_t * blue)

Extracts the color components from the 32-bit color passed and puts them in the passed in 8-bits ints.

The color is 24-bit RGB.

Example: color = 0x00FFFF00 -> red = 0xFF, green = 0xFF, blue = 0x00.

GLIB_rgbColor#

uint32_t GLIB_rgbColor (uint8_t red, uint8_t green, uint8_t blue)

Convert 3 uint8_t color components into a 24-bit color.

Example: red = 0xFF, green = 0xFF, blue = 0x00 -> 0x00FFFF00 = Yellow

Returns

• Returns a 32-bit unsigned integer representing the color. The 8 LSB is blue, the next 8 is green and the next 8 is red. 0x00RRGGBB

GLIB_rectContainsPoint#

bool GLIB_rectContainsPoint (const GLIB_Rectangle_t * pRect, int32_t x, int32_t y)

Checks if the point passed in is in the interior of the rectangle passed in.

If the point is on the edge of the rectangle the function returns 1.

Returns

• • Returns false if coordinate is outside the rectangle

  • Returns true otherwise

GLIB_normalizeRect#

void GLIB_normalizeRect (GLIB_Rectangle_t * pRect)

Normalize the rectangle that is passed in.

Sets yMin to the minimum value of yMin and yMax. Sets yMax to the maximum value of yMin and yMax. And the same for xMin and xMax

GLIB_setClippingRegion#

EMSTATUS GLIB_setClippingRegion (GLIB_Context_t * pContext, const GLIB_Rectangle_t * pRect)

Sets the clippingRegion of the passed in GLIB_Context_t.

Returns

• • Returns GLIB_OK on success

  • Returns GLIB_ERROR_INVALID_CLIPPINGREGION if invalid coordinates

  • Returns GLIB_OUT_OF_BOUNDS if clipping region is bigger than display clipping area

GLIB_drawCircle#

EMSTATUS GLIB_drawCircle (GLIB_Context_t * pContext, int32_t xCenter, int32_t yCenter, uint32_t radius)

Draws a circle with center at x, y, and a radius.

Draws a circle using the Midpoint Circle Algorithm. See Wikipedia for algorithm. Algorithm is optimized to use only integer arithmetic, so no floating point arithmetic is needed.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawCircleFilled#

EMSTATUS GLIB_drawCircleFilled (GLIB_Context_t * pContext, int32_t xCenter, int32_t yCenter, uint32_t radius)

Draws a filled circle with center at x, y, and a radius.

Draws a circle using the Midpoint Circle Algorithm and using horizontal lines. See Wikipedia for algorithm.

Returns

• Returns GLIB_OK on succes. Returns GLIB_ERROR_NOTHING_TO_DRAW if none of the pixel coordinates were inside the clipping region. Returns error code otherwise.

GLIB_drawPartialCircle#

EMSTATUS GLIB_drawPartialCircle (GLIB_Context_t * pContext, int32_t xCenter, int32_t yCenter, uint32_t radius, uint8_t bitMask)

Draws a partial circle with center at x, y, and a radius.

Draws a partial circle using the Midpoint Circle Algorithm. Algorithm is optimized to use only integer arithmetic, so no floating point arithmetic is needed. The bitMask passed in decides which octant that should be drawn. The octants is numbered 1 to 8 in counterclockwise order.

Example: bitMask == 4 draws only pixels in 3. octant (00000100). bitMask == 5 draws only pixels in 3. and 1. octant (00000101).

Returns

• Returns GLIB_OK on success, or else error code

GLIB_setFont#

EMSTATUS GLIB_setFont (GLIB_Context_t * pContext, GLIB_Font_t * pFont)

Set new font for the library.

Note that GLIB defines a default font in glib.c. Redefine GLIB_DEFAULT_FONT to change the default font.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawString#

EMSTATUS GLIB_drawString (GLIB_Context_t * pContext, const char * pString, uint32_t sLength, int32_t x0, int32_t y0, bool opaque)

Draws a string using the font supplied with the library.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawStringOnLine#

EMSTATUS GLIB_drawStringOnLine (GLIB_Context_t * pContext, const char * pString, uint8_t line, GLIB_Align_t align, int32_t xOffset, int32_t yOffset, bool opaque)

Draws a string on the specified line on the display.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawChar#

EMSTATUS GLIB_drawChar (GLIB_Context_t * pContext, char myChar, int32_t x, int32_t y, bool opaque)

Draws a char using the font supplied with the library.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawBitmap#

EMSTATUS GLIB_drawBitmap (GLIB_Context_t * pContext, int32_t x, int32_t y, uint32_t width, uint32_t height, const uint8_t * picData)

Draws a bitmap.

Sets up a bitmap that starts at x0,y0 and draws bitmap.

For monochrome displays, each 8-bit element contains 8 pixel values. A bit value of 1 indicates a white pixel, while 0 indicates a black pixel. Note that this format may vary with the DMD implementation.

For 3-bit RGB displays, each bit in the array are one color component (red, green and blue) of the pixel, so that 3 bits represent one pixel (0xBGR). Pixel 0: Bits 2:0 (0bBGR) of byte 0 Pixel 1: Bits 5:3 (0bBGR) of byte 0 Pixel 2: Bits 7:6 (0bGR) of byte 0 and bit 0 (0bB) of byte 1 Pixel 3: Bits 3:1 (0bBGR) of byte 1 ...

For RGB displays with 8-bits per color, each pixel is represented by 24-bits, with one byte for each of the red, green and blue components. The data has to be organized like this: picData = { R, G, B, R, G, B, R, G, B ... }

The pixels are ordered by increasing x coordinate, after the last pixel of a row, the next pixel will be the first pixel on the next row.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_invertBitmap#

void GLIB_invertBitmap (GLIB_Context_t * pContext, uint32_t bitmapSize, uint8_t * picData)

Inverts each bit of the bitmap.

For monochrome displays, the result is an inversion of the image.

For RGB displays, the result is the negative of the input image.

Note

• The function inverts entire bytes, meaning that any bits contained within the array that may not be part of the image will also be inverted.

GLIB_drawLine#

EMSTATUS GLIB_drawLine (GLIB_Context_t * pContext, int32_t x1, int32_t y1, int32_t x2, int32_t y2)

Draws a line from x1,y1 to x2, y2.

Draws a straight line using the Bresnham's Midpoint Line Algorithm. Checks for vertical and horizontal line.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawLineH#

EMSTATUS GLIB_drawLineH (GLIB_Context_t * pContext, int32_t x1, int32_t y1, int32_t x2)

Draws a horizontal line from x1, y1 to x2, y2.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawLineV#

EMSTATUS GLIB_drawLineV (GLIB_Context_t * pContext, int32_t x1, int32_t y1, int32_t y2)

Draws a vertical line from x1, y1 to x1, y2.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawRect#

EMSTATUS GLIB_drawRect (GLIB_Context_t * pContext, const GLIB_Rectangle_t * pRect)

Draws a rectangle outline defined by the passed in rectangle.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawRectFilled#

EMSTATUS GLIB_drawRectFilled (GLIB_Context_t * pContext, const GLIB_Rectangle_t * pRect)

Draws a filled rectangle defined by the passed in rectangle.

The filled rectangle is drawn from (xMin, yMin) to (xMax, yMax), inclusive, of the rectangle passed in.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawPolygon#

EMSTATUS GLIB_drawPolygon (GLIB_Context_t * pContext, uint32_t numPoints, const int32_t * polyPoints)

Draws a polygon using Bresnham's Midpoint Line Algorithm.

This function draws a line between all points outlining the polygon. The first and last point doesn't have to be the same. The function automatically draws a line from the start point to the end point.

Returns

• Returns GLIB_OK on if at least one element was drawn, or else error code

GLIB_drawPolygonFilled#

EMSTATUS GLIB_drawPolygonFilled (GLIB_Context_t * pContext, uint32_t numPoints, const int32_t * polyPoints)

Draws a filled polygon using a scan line algorithm.

This function draws a line between all points outlining the polygon. The first and last point doesn't have to be the same. The function automatically draws a line from the start point to the end point.

Returns

• Returns GLIB_OK on success, otherwise a GLIB error code.

GLIB_drawPixelRGB#

EMSTATUS GLIB_drawPixelRGB (GLIB_Context_t * pContext, int32_t x, int32_t y, uint8_t red, uint8_t green, uint8_t blue)

Draws a pixel at x, y with color defined by red, green and blue 1 byte per channel.

Example: To draw a yellow pixel at (10, 10). x = 10, y = 10, red = 0xFF, green = 0xFF, blue = 0x00

Returns

• Returns DMD_OK on success, or else error code

GLIB_drawPixel#

EMSTATUS GLIB_drawPixel (GLIB_Context_t * pContext, int32_t x, int32_t y)

Draws a pixel at x, y using foregroundColor defined in the GLIB_Context_t.

Returns

• Returns GLIB_OK on success, or else error code

GLIB_drawPixelColor#

EMSTATUS GLIB_drawPixelColor (GLIB_Context_t * pContext, int32_t x, int32_t y, uint32_t color)

Draws a pixel at x, y using the color parameter.

Returns

• Returns DMD_OK on success, or else error code

ECODE_GLIB_BASE#

#define ECODE_GLIB_BASE

0x00000000

GLIB Base error code.

GLIB_OK#

#define GLIB_OK

0x00000000

Successful call.

GLIB_ERROR_NOTHING_TO_DRAW#

#define GLIB_ERROR_NOTHING_TO_DRAW

(ECODE_GLIB_BASE | 0x0001)

Function did not draw.

GLIB_ERROR_INVALID_CHAR#

#define GLIB_ERROR_INVALID_CHAR

(ECODE_GLIB_BASE | 0x0002)

Invalid char.

GLIB_OUT_OF_BOUNDS#

#define GLIB_OUT_OF_BOUNDS

(ECODE_GLIB_BASE | 0x0003)

Coordinates out of bounds.

GLIB_ERROR_INVALID_CLIPPINGREGION#

#define GLIB_ERROR_INVALID_CLIPPINGREGION

(ECODE_GLIB_BASE | 0x0004)

Invalid coordinates (ex.

xMin > xMax)

GLIB_ERROR_INVALID_ARGUMENT#

#define GLIB_ERROR_INVALID_ARGUMENT

(ECODE_GLIB_BASE | 0x0005)

Invalid argument.

GLIB_ERROR_OUT_OF_MEMORY#

#define GLIB_ERROR_OUT_OF_MEMORY

(ECODE_GLIB_BASE | 0x0006)

Out of memory.

GLIB_ERROR_FILE_NOT_SUPPORTED#

#define GLIB_ERROR_FILE_NOT_SUPPORTED

(ECODE_GLIB_BASE | 0x0007)

File not supported.

GLIB_ERROR_IO#

#define GLIB_ERROR_IO

(ECODE_GLIB_BASE | 0x0008)

General IO Error.

GLIB_ERROR_INVALID_FILE#

#define GLIB_ERROR_INVALID_FILE

(ECODE_GLIB_BASE | 0x0009)

Invalid file.

GLIB_NO_DEFAULT_FONT#

#define GLIB_NO_DEFAULT_FONT