orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
OrxText

Macros

#define orxTEXT_KZ_LOCALE_GROUP   "Text"

Typedefs

typedef struct __orxTEXT_t orxTEXT

Functions

orxDLLAPI orxTEXT *orxFASTCALL orxText_Create ()
orxDLLAPI orxTEXT *orxFASTCALL orxText_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxText_Delete (orxTEXT *_pstText)
orxDLLAPI void orxFASTCALL orxText_Exit ()
orxDLLAPI orxFONT *orxFASTCALL orxText_GetFont (const orxTEXT *_pstText)
orxDLLAPI orxU32 orxFASTCALL orxText_GetLineCount (const orxTEXT *_pstText)
orxDLLAPI orxSTATUS orxFASTCALL orxText_GetLineSize (const orxTEXT *_pstText, orxU32 _u32Line, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight)
orxDLLAPI const orxSTRING orxFASTCALL orxText_GetName (const orxTEXT *_pstText)
orxDLLAPI orxSTATUS orxFASTCALL orxText_GetSize (const orxTEXT *_pstText, orxFLOAT *_pfWidth, orxFLOAT *_pfHeight)
orxDLLAPI const orxSTRING orxFASTCALL orxText_GetString (const orxTEXT *_pstText)
orxDLLAPI orxSTATUS orxFASTCALL orxText_Init ()
orxDLLAPI orxBOOL orxFASTCALL orxText_IsFixedSize (const orxTEXT *_pstText)
orxDLLAPI orxSTATUS orxFASTCALL orxText_SetFont (orxTEXT *_pstText, orxFONT *_pstFont)
orxDLLAPI orxSTATUS orxFASTCALL orxText_SetSize (orxTEXT *_pstText, orxFLOAT _fWidth, orxFLOAT _fHeight, const orxSTRING *_pzExtra)
orxDLLAPI orxSTATUS orxFASTCALL orxText_SetString (orxTEXT *_pstText, const orxSTRING _zString)
orxDLLAPI void orxFASTCALL orxText_Setup ()

Detailed Description

Text module Module that handles texts

Macro Definition Documentation

◆ orxTEXT_KZ_LOCALE_GROUP

#define orxTEXT_KZ_LOCALE_GROUP   "Text"

Defines

Definition at line 53 of file orxText.h.

Typedef Documentation

◆ orxTEXT

typedef struct __orxTEXT_t orxTEXT

Internal text structure

Definition at line 57 of file orxText.h.

Function Documentation

◆ orxText_Create()

orxDLLAPI orxTEXT *orxFASTCALL orxText_Create ( )
extern

Creates an empty text

Returns
orxTEXT / orxNULL

◆ orxText_CreateFromConfig()

orxDLLAPI orxTEXT *orxFASTCALL orxText_CreateFromConfig ( const orxSTRING _zConfigID)
extern

Creates a text from config

Parameters
[in]_zConfigIDConfig ID
Returns
orxTEXT / orxNULL

◆ orxText_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxText_Delete ( orxTEXT * _pstText)
extern

Deletes a text

Parameters
[in]_pstTextConcerned text
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxText_Exit()

orxDLLAPI void orxFASTCALL orxText_Exit ( )
extern

Exits from the text module

◆ orxText_GetFont()

orxDLLAPI orxFONT *orxFASTCALL orxText_GetFont ( const orxTEXT * _pstText)
extern

Gets text font

Parameters
[in]_pstTextConcerned text
Returns
Text font / orxNULL

◆ orxText_GetLineCount()

orxDLLAPI orxU32 orxFASTCALL orxText_GetLineCount ( const orxTEXT * _pstText)
extern

Gets text's line count

Parameters
[in]_pstTextConcerned text
Returns
orxU32

◆ orxText_GetLineSize()

orxDLLAPI orxSTATUS orxFASTCALL orxText_GetLineSize ( const orxTEXT * _pstText,
orxU32 _u32Line,
orxFLOAT * _pfWidth,
orxFLOAT * _pfHeight )
extern

Gets text's line size

Parameters
[in]_pstTextConcerned text
[out]_u32LineLine index
[out]_pfWidthLine's width
[out]_pfHeightLine's height
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxText_GetName()

orxDLLAPI const orxSTRING orxFASTCALL orxText_GetName ( const orxTEXT * _pstText)
extern

Gets text name

Parameters
[in]_pstTextConcerned text
Returns
Text name / orxNULL

◆ orxText_GetSize()

orxDLLAPI orxSTATUS orxFASTCALL orxText_GetSize ( const orxTEXT * _pstText,
orxFLOAT * _pfWidth,
orxFLOAT * _pfHeight )
extern

Gets text size

Parameters
[in]_pstTextConcerned text
[out]_pfWidthText's width
[out]_pfHeightText's height
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxText_GetString()

orxDLLAPI const orxSTRING orxFASTCALL orxText_GetString ( const orxTEXT * _pstText)
extern

Gets text string

Parameters
[in]_pstTextConcerned text
Returns
Text string / orxSTRING_EMPTY

◆ orxText_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxText_Init ( )
extern

Inits the text module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxText_IsFixedSize()

orxDLLAPI orxBOOL orxFASTCALL orxText_IsFixedSize ( const orxTEXT * _pstText)
extern

Is text's size fixed? (ie. manually constrained with orxText_SetSize())

Parameters
[in]_pstTextConcerned text
Returns
orxTRUE / orxFALSE

◆ orxText_SetFont()

orxDLLAPI orxSTATUS orxFASTCALL orxText_SetFont ( orxTEXT * _pstText,
orxFONT * _pstFont )
extern

Sets text font

Parameters
[in]_pstTextConcerned text
[in]_pstFontFont / orxNULL to use default
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxText_SetSize()

orxDLLAPI orxSTATUS orxFASTCALL orxText_SetSize ( orxTEXT * _pstText,
orxFLOAT _fWidth,
orxFLOAT _fHeight,
const orxSTRING * _pzExtra )
extern

Sets text's size, will lead to reformatting if text doesn't fit (pass width = -1.0f to restore text's original size, ie. unconstrained)

Parameters
[in]_pstTextConcerned text
[in]_fWidthMax width for the text, remove any size constraint if negative
[in]_fHeightMax height for the text, ignored if negative (ie. unconstrained height)
[in]_pzExtraText that wouldn't fit inside the box if height is provided, orxSTRING_EMPTY if no extra, orxNULL to ignore
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxText_SetString()

orxDLLAPI orxSTATUS orxFASTCALL orxText_SetString ( orxTEXT * _pstText,
const orxSTRING _zString )
extern

Sets text string

Parameters
[in]_pstTextConcerned text
[in]_zStringString to contain
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxText_Setup()

orxDLLAPI void orxFASTCALL orxText_Setup ( )
extern

Setups the text module

Generated for orx by doxygen 1.8.11