MT2523 API Reference  LinkIt SDK v4
Font engine

This section provides APIs to get string information and draw string with specified font size and font color. More...

Overview

This section provides APIs to get string information and draw string with specified font size and font color.

Terms and Acronyms

Terms Details
SSC Supplementary Service Codes. For more information, please refer to Wikipedia.
ISO International Organization for Standardization. For more information, please refer to Wikipedia.
BDF Bitmap Distribution Format. For more information, please refer to Wikipedia.

How to use the font engine module

Functions

uint8_t gdi_font_engine_set_font_size (gdi_font_engine_size_t font_size)
 This function sets the current font size. More...
 
void gdi_font_engine_get_font_size (gdi_font_engine_size_t *font_size)
 This function gets the current font size. More...
 
void gdi_font_engine_set_text_color (gdi_font_engine_color_t color)
 This function sets the text color. More...
 
gdi_font_engine_color_t gdi_font_engine_get_text_color (void)
 This function gets the text color. More...
 
uint32_t gdi_font_engine_display_string (gdi_font_engine_display_string_info_t *parameter)
 This function displays the specific string. More...
 
uint32_t gdi_font_engine_get_string_information (gdi_font_engine_string_info_t *query)
 This function gets the detailed information of the specified string. More...
 

Modules

 Define
 This section defines the macros for the font engine.
 
 Struct
 This section defines the structures for the font engine.
 

Function Documentation

uint32_t gdi_font_engine_display_string ( gdi_font_engine_display_string_info_t parameter)

This function displays the specific string.

Parameters
[in]parameteris the user-defined data to draw the string.
Returns
GDI_FONT_ENGINE_OK, the operation completed successfully.
void gdi_font_engine_get_font_size ( gdi_font_engine_size_t font_size)

This function gets the current font size.

Parameters
[out]font_sizeis the size of the current font.
Returns
void.
uint32_t gdi_font_engine_get_string_information ( gdi_font_engine_string_info_t query)

This function gets the detailed information of the specified string.

Parameters
[in,out]queryis the user-defined query information and query the result provided by the font engine.
Returns
Indicates the number of characters to get the information.
gdi_font_engine_color_t gdi_font_engine_get_text_color ( void  )

This function gets the text color.

Returns
The text color.
uint8_t gdi_font_engine_set_font_size ( gdi_font_engine_size_t  font_size)

This function sets the current font size.

Parameters
[in]font_sizeis the font size to set.
Returns
void.
void gdi_font_engine_set_text_color ( gdi_font_engine_color_t  color)

This function sets the text color.

Parameters
[in]coloris the text color.
Returns
void.