OrxFont

Macros
#define	orxFONT_KZ_DEFAULT_FONT_NAME   "default"

Typedefs
typedef struct __orxFONT_t	orxFONT

Functions
orxDLLAPI orxFONT *orxFASTCALL	orxFont_Create ()
orxDLLAPI orxFONT *orxFASTCALL	orxFont_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_Delete (orxFONT *_pstFont)
orxDLLAPI void orxFASTCALL	orxFont_Exit ()
orxDLLAPI orxFLOAT orxFASTCALL	orxFont_GetCharacterHeight (const orxFONT *_pstFont)
orxDLLAPI const orxSTRING orxFASTCALL	orxFont_GetCharacterList (const orxFONT *_pstFont)
orxDLLAPI orxVECTOR *orxFASTCALL	orxFont_GetCharacterSpacing (const orxFONT *_pstFont, orxVECTOR *_pvSpacing)
orxDLLAPI orxFLOAT orxFASTCALL	orxFont_GetCharacterWidth (const orxFONT *_pstFont, orxU32 _u32CharacterCodePoint)
orxDLLAPI const orxFONT *orxFASTCALL	orxFont_GetDefaultFont ()
orxDLLAPI const orxCHARACTER_MAP *orxFASTCALL	orxFont_GetMap (const orxFONT *_pstFont)
orxDLLAPI const orxSTRING orxFASTCALL	orxFont_GetName (const orxFONT *_pstFont)
orxDLLAPI orxVECTOR *orxFASTCALL	orxFont_GetOrigin (const orxFONT *_pstFont, orxVECTOR *_pvOrigin)
orxDLLAPI orxVECTOR *orxFASTCALL	orxFont_GetSize (const orxFONT *_pstFont, orxVECTOR *_pvSize)
orxDLLAPI orxTEXTURE *orxFASTCALL	orxFont_GetTexture (const orxFONT *_pstFont)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_Init ()
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_SetCharacterHeight (orxFONT *_pstFont, orxFLOAT _fCharacterHeight)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_SetCharacterList (orxFONT *_pstFont, const orxSTRING _zList)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_SetCharacterSpacing (orxFONT *_pstFont, const orxVECTOR *_pvSpacing)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_SetCharacterWidthList (orxFONT *_pstFont, orxU32 _u32CharacterNumber, const orxFLOAT *_afCharacterWidthList)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_SetOrigin (orxFONT *_pstFont, const orxVECTOR *_pvOrigin)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_SetSize (orxFONT *_pstFont, const orxVECTOR *_pvSize)
orxDLLAPI orxSTATUS orxFASTCALL	orxFont_SetTexture (orxFONT *_pstFont, orxTEXTURE *_pstTexture)
orxDLLAPI void orxFASTCALL	orxFont_Setup ()

Detailed Description

Font module Module that handles fonts

Macro Definition Documentation

#define orxFONT_KZ_DEFAULT_FONT_NAME   "default"

Misc defines

Definition at line 54 of file orxFont.h.

Typedef Documentation

typedef struct __orxFONT_t orxFONT

Internal font structure

Definition at line 58 of file orxFont.h.

Function Documentation

orxDLLAPI orxFONT* orxFASTCALL orxFont_Create

(

)

Creates an empty font

Returns

orxFONT / orxNULL

orxDLLAPI orxFONT* orxFASTCALL orxFont_CreateFromConfig

(

const orxSTRING

_zConfigID

)

Creates a font from config

Parameters

[in]

_zConfigID

Config ID

Returns

orxFONT / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxFont_Delete

(

orxFONT *

_pstFont

)

Deletes a font

Parameters

[in]

_pstFont

Concerned font

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxFont_Exit

(

)

Exits from the font module

orxDLLAPI orxFLOAT orxFASTCALL orxFont_GetCharacterHeight

(

const orxFONT *

_pstFont

)

Gets font's character height

Parameters

[in]

_pstFont

Concerned font

Returns

orxFLOAT

orxDLLAPI const orxSTRING orxFASTCALL orxFont_GetCharacterList

(

const orxFONT *

_pstFont

)

Gets font's character list

Parameters

[in]

_pstFont

Concerned font

Returns

Font's character list / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxFont_GetCharacterSpacing	(	const orxFONT *	_pstFont,
		orxVECTOR *	_pvSpacing
	)

Gets font's character spacing

Parameters

[in]	_pstFont	Concerned font
[out]	_pvSpacing	Character's spacing

Returns

orxVECTOR / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxFont_GetCharacterWidth	(	const orxFONT *	_pstFont,
		orxU32	_u32CharacterCodePoint
	)

Gets font's character width

Parameters

[in]	_pstFont	Concerned font
[in]	_u32CharacterCodePoint	Character code point

Returns

orxFLOAT

orxDLLAPI const orxFONT* orxFASTCALL orxFont_GetDefaultFont

(

)

Gets default font

Returns

Default font / orxNULL

orxDLLAPI const orxCHARACTER_MAP* orxFASTCALL orxFont_GetMap

(

const orxFONT *

_pstFont

)

Gets font's map

Parameters

[in]

_pstFont

Concerned font

Returns

orxCHARACTER_MAP / orxNULL

orxDLLAPI const orxSTRING orxFASTCALL orxFont_GetName

(

const orxFONT *

_pstFont

)

Gets font name

Parameters

[in]

_pstFont

Concerned font

Returns

Font name / orxSTRING_EMPTY

orxDLLAPI orxVECTOR* orxFASTCALL orxFont_GetOrigin	(	const orxFONT *	_pstFont,
		orxVECTOR *	_pvOrigin
	)

Gets font's origin

Parameters

[in]	_pstFont	Concerned font
[out]	_pvOrigin	Font's origin

Returns

orxVECTOR / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxFont_GetSize	(	const orxFONT *	_pstFont,
		orxVECTOR *	_pvSize
	)

Gets font's size

Parameters

[in]	_pstFont	Concerned font
[out]	_pvSize	Font's size

Returns

orxVECTOR / orxNULL

orxDLLAPI orxTEXTURE* orxFASTCALL orxFont_GetTexture

(

const orxFONT *

_pstFont

)

Gets font's texture

Parameters

[in]

_pstFont

Concerned font

Returns

Font texture / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxFont_Init

(

)

Inits the font module

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterHeight	(	orxFONT *	_pstFont,
		orxFLOAT	_fCharacterHeight
	)

Sets font's character height

Parameters

[in]	_pstFont	Concerned font
[in]	_fCharacterHeight	Character's height

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterList	(	orxFONT *	_pstFont,
		const orxSTRING	_zList
	)

Sets font's character list

Parameters

[in]	_pstFont	Concerned font
[in]	_zList	Character list

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterSpacing	(	orxFONT *	_pstFont,
		const orxVECTOR *	_pvSpacing
	)

Sets font's character spacing

Parameters

[in]	_pstFont	Concerned font
[in]	_pvSpacing	Character's spacing

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterWidthList	(	orxFONT *	_pstFont,
		orxU32	_u32CharacterNumber,
		const orxFLOAT *	_afCharacterWidthList
	)

Sets font's character width list

Parameters

[in]	_pstFont	Concerned font
[in]	_u32CharacterNumber	Character's number
[in]	_afCharacterWidthList	List of widths for all the characters

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetOrigin	(	orxFONT *	_pstFont,
		const orxVECTOR *	_pvOrigin
	)

Sets font's origin

Parameters

[in]	_pstFont	Concerned font
[in]	_pvOrigin	Font's origin

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetSize	(	orxFONT *	_pstFont,
		const orxVECTOR *	_pvSize
	)

Sets font's size

Parameters

[in]	_pstFont	Concerned font
[in]	_pvSize	Font's size

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetTexture	(	orxFONT *	_pstFont,
		orxTEXTURE *	_pstTexture
	)

Sets font's texture

Parameters

[in]	_pstFont	Concerned font
[in]	_pstTexture	Texture to set

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxFont_Setup

(

)

Setups the font module