Vault 7: Projects
This publication series is about specific projects related to the Vault 7 main publication.
pString Pointer to the location of the string that will be rendered.
String can have multiple lines where each line is terminated
by a new line character.
length Total number of characters to be rendered. When set to 0,
the function will terminate until the null character is detected.
align The alignment of the rendered text.
Function
GFX_STATUS FX_TextStringBoxDraw(
uint16_t x,
uint16_t y,
uint16_t width,
uint16_t height,
GFX_XCHAR *pString,
uint16_t length,
GFX_ALIGNMENT align)
1.6.1.1.6.10 GFX_TextStringDraw Function
This function renders the given string of character using the currently set color using the currently set font.
File
gfx_primitive.h
Syntax
GFX_STATUS GFX_TextStringDraw(uint16_t x, uint16_t y, GFX_XCHAR * pString, uint16_t length);
Returns
The status of the string rendering. GFX_STATUS_SUCCESS - the string was rendered GFX_STATUS_FAILURE - the string
was not rendered, or is not yet finished. The function must be called again to render the remaining characters.
Description
This function renders the given string of character using the currently set font, and color to the location defined by the given
x,y position. The color is set by GFX_ColorSet() while the font is set by GFX_FontSet().
The text rendered by this function is always left aligned. When a newline character is encountered, the next character after
the newline character will be rendered left aligned on the next line. The next line position is determined by the height of the
font used.
When the length parameter is set to 0, the string will be rendered until the null character is reached. When the length
parameter is greater than 0, the string will be rendered until one of the following cases occurs:
• null character is reached before the total rendered characters is less than the value of length
• total rendered characters is equal to the value of length before the null character is reached.
The rendering of the character becomes undefined when any one of the following is true:
• x,y position is set to locations outside the frame buffer.
• Color is not set, before this function is called.
• Font is not set, before this function is called.
Preconditions
Color must be set by GFX_ColorSet(). Font must be set by GFX_FontSet().
Example
// assume WHITE is a valid GFX_COLOR data
1.6 Library Interface MLA - Graphics Library Help Graphics Primitive Layer
105
Protego_Release_01_05-Related-OEM-Documentation-MLA_v2013_12_20-help_mla_gfx.pdf