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

String Renderer. More...

Include dependency graph for legato_string_renderer.h:

Go to the source code of this file.

Data Structures

struct  leStringRenderRequest
 This struct represents a string render request. More...
 
struct  leUStringRenderRequest
 This struct represents a lechar string render request. More...
 
struct  leCStringRenderRequest
 This struct represents a c-style string render request. More...
 

Typedefs

typedef struct leStringRenderRequest leStringRenderRequest
 This struct represents a string render request. More...
 
typedef struct leUStringRenderRequest leUStringRenderRequest
 This struct represents a lechar string render request. More...
 
typedef struct leCStringRenderRequest leCStringRenderRequest
 This struct represents a c-style string render request. More...
 

Functions

leResult leStringRenderer_DrawString (leStringRenderRequest *req)
 Draw an leString. More...
 
leResult leStringRenderer_DrawCString (leCStringRenderRequest *req)
 Draw leChar string. More...
 
leResult leStringRenderer_DrawUString (leUStringRenderRequest *req)
 Draw C-Style string. More...
 

Detailed Description

String Renderer.

String Renderer functions and definitions

Typedef Documentation

◆ leCStringRenderRequest

This struct represents a c-style string render request.

Defines the arguments necessary to perform a C-style string draw operation.

◆ leStringRenderRequest

This struct represents a string render request.

Defines the arguments necessary to perform an leString draw operation

◆ leUStringRenderRequest

This struct represents a lechar string render request.

Defines the arguments necessary to perform an leChar string draw operation

Function Documentation

◆ leStringRenderer_DrawCString()

leResult leStringRenderer_DrawCString ( leCStringRenderRequest req)

Draw leChar string.

Draws a leChar string using req.

Parameters
reqthe result of the operation.
Returns
LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leStringRenderer_DrawString()

leResult leStringRenderer_DrawString ( leStringRenderRequest req)

Draw an leString.

Draws an leString using req.

Parameters
reqthe render request details.
Returns
LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leStringRenderer_DrawUString()

leResult leStringRenderer_DrawUString ( leUStringRenderRequest req)

Draw C-Style string.

Draws a C-Style string using req.

Parameters
reqis an integer.
Returns
the result of the operation.