orx  1.9
Portable Game Engine
OrxText

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

Typedef Documentation

typedef struct __orxTEXT_t orxTEXT

Internal text structure

Definition at line 52 of file orxText.h.

Function Documentation

orxDLLAPI orxTEXT* orxFASTCALL orxText_Create ( )

Creates an empty text

Returns
orxTEXT / orxNULL
orxDLLAPI orxTEXT* orxFASTCALL orxText_CreateFromConfig ( const orxSTRING  _zConfigID)

Creates a text from config

Parameters
[in]_zConfigIDConfig ID
Returns
orxTEXT / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxText_Delete ( orxTEXT _pstText)

Deletes a text

Parameters
[in]_pstTextConcerned text
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxText_Exit ( )

Exits from the text module

orxDLLAPI orxFONT* orxFASTCALL orxText_GetFont ( const orxTEXT _pstText)

Gets text font

Parameters
[in]_pstTextConcerned text
Returns
Text font / orxNULL
orxDLLAPI orxU32 orxFASTCALL orxText_GetLineCount ( const orxTEXT _pstText)

Gets text's line count

Parameters
[in]_pstTextConcerned text
Returns
orxU32
orxDLLAPI orxSTATUS orxFASTCALL orxText_GetLineSize ( const orxTEXT _pstText,
orxU32  _u32Line,
orxFLOAT *  _pfWidth,
orxFLOAT *  _pfHeight 
)

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
orxDLLAPI const orxSTRING orxFASTCALL orxText_GetName ( const orxTEXT _pstText)

Gets text name

Parameters
[in]_pstTextConcerned text
Returns
Text name / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxText_GetSize ( const orxTEXT _pstText,
orxFLOAT *  _pfWidth,
orxFLOAT *  _pfHeight 
)

Gets text size

Parameters
[in]_pstTextConcerned text
[out]_pfWidthText's width
[out]_pfHeightText's height
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI const orxSTRING orxFASTCALL orxText_GetString ( const orxTEXT _pstText)

Gets text string

Parameters
[in]_pstTextConcerned text
Returns
Text string / orxSTRING_EMPTY
orxDLLAPI orxSTATUS orxFASTCALL orxText_Init ( )

Inits the text module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxBOOL orxFASTCALL orxText_IsFixedSize ( const orxTEXT _pstText)

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

Parameters
[in]_pstTextConcerned text
Returns
orxTRUE / orxFALSE
orxDLLAPI orxSTATUS orxFASTCALL orxText_SetFont ( orxTEXT _pstText,
orxFONT _pstFont 
)

Sets text font

Parameters
[in]_pstTextConcerned text
[in]_pstFontFont / orxNULL to use default
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxText_SetSize ( orxTEXT _pstText,
orxFLOAT  _fWidth,
orxFLOAT  _fHeight,
const orxSTRING *  _pzExtra 
)

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
orxDLLAPI orxSTATUS orxFASTCALL orxText_SetString ( orxTEXT _pstText,
const orxSTRING  _zString 
)

Sets text string

Parameters
[in]_pstTextConcerned text
[in]_zStringString to contain
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxText_Setup ( )

Setups the text module


Generated for orx by doxygen 1.8.11