Torque Game Engine Documentation
CVS Revision Label 1.3.x

Text Functions

Detailed Description

These functions draw a string on the string with a given font.

Functions

U32 dglDrawText (GFont *font, const Point2I &ptDraw, const void *in_string, const ColorI *colorTable=NULL, const U32 maxColorIndex=9)

Draws text at a location in 2d gui coordinates Also supports color tags to modulate the given text.

U32 dglDrawTextN (GFont *font, const Point2I &ptDraw, const void *in_string, U32 n, const ColorI *colorTable=NULL, const U32 maxColorIndex=9)

Draws "n" number of characters from the string, in_string.

Function Documentation

U32 dglDrawText ( GFont * font,

const Point2I & ptDraw,

const void * in_string,

const ColorI * colorTable = NULL,

const U32 maxColorIndex = 9

)

Draws text at a location in 2d gui coordinates Also supports color tags to modulate the given text.

Returns:
the number of x-pixels traversed

Parameters:

font font to draw with, usually found in the profile

ptDraw point where to start drawing text

in_string string to be drawn

colorTable lookups for the color tags

maxColorIndex size of the colorTable

U32 dglDrawTextN ( GFont * font,

const Point2I & ptDraw,

const void * in_string,

U32 n,

const ColorI * colorTable = NULL,

const U32 maxColorIndex = 9

)

Draws "n" number of characters from the string, in_string.

Returns:
the number of x-pixels traversed

See also:
dglDrawText