Main Page | Modules | Related Pages

Text Functions

Functions


Function Documentation

void hel_CustomTextClear TCustomTextInfo *  pTextInfo  ) 
 

Clear the entire custom text background.

Parameters:
pTextInfo Pointer to TCustomTextInfo structure
This function will clear the entire custom text background using the SPACE letter. If no SPACE letter was specified in "pTextInfo->CharOrder", this function will fail.

See also:
hel_CustomTextClearRow()

void hel_CustomTextClearRow TCustomTextInfo *  pTextInfo,
u32  y
 

Clear a row.

Parameters:
pTextInfo Pointer to TCustomTextInfo structure
y Y character number
Call this function will use the SPACE letter to clear the row. If no SPACE letter was specified in "pTextInfo->CharOrder", this function will fail.

See also:
hel_CustomTextClear()

void hel_CustomTextInit TCustomTextInfo *  pTextInfo,
void *  pSrcTiles,
u16  SizeU16,
u8  ColMode,
u8  PalNo,
u8  MapSize,
u8  MapRot
 

Initialize the custom textdraw system.

Parameters:
pTextInfo Pointer to TCustomTextInfo structure
pSrcTiles Pointer to the tile source data
SizeU16 Size of the tiles to be copied into Tile RAM, in number of 16bit chunks
ColMode Color mode of the tile set: 0 = 16colors/16 palettes 1 = 256 colors / 1 palette
PalNo When ColMode is 0, this parameter specifies the palette-bank (0..15)
MapSize The size of the map (0-3). This depends on the MapRot parameter! See ham_InitMapEmptySet() for more information
MapRot 0 = normal map 1 = rotation map
IMPORTANT: Call this function before you use any of the hel_CustomText routines! It will only work in tile modes!.
VERY IMPORTANT: The function-prototype has been changed in HEL v0.9, due to the new introduced PalNo parameter to fix a very bad bug. Sorry :(

See also:
hel_CustomTextPrint(), hel_CustomTextType()

void hel_CustomTextPrint TCustomTextInfo *  pTextInfo,
u32  x,
u32  y,
char *  pText
 

Output a string on a tiles mode GBA screen.

Parameters:
pTextInfo Pointer to TCustomTextInfo structure
x X character number the string should start on
y Y character number the string should start on
text The string to output
This function will output a string to the GBA display, it does not support formatting.
Before you can use this function, you must call hel_CustomTextInit()!

This function is faster than hel_CustomTextPrintFmt()

See also:
hel_CustomTextInit(), hel_CustomTextPrintFmt(), hel_CustomTextType()

void hel_CustomTextPrintFmt TCustomTextInfo *  pTextInfo,
u32  x,
u32  y,
char *  pFmt,
... 
 

Output a formatted string on a tiles mode GBA screen.

Parameters:
pTextInfo Pointer to TCustomTextInfo structure
x X character number the string should start on
y Y character number the string should start on
fmt The Format string (see "printf" documentation in your local C tutorial)
This function will output a formatted string to the GBA display. Before you can use this function, you must call hel_CustomTextInit()!

This function is slower than hel_CustomTextPrint()

See also:
hel_CustomTextInit(), hel_CustomTextPrintFmt(), hel_CustomTextType()

u8 hel_CustomTextType TCustomTextInfo *  pTextInfo,
u32  x,
u32  y,
u8  Delay,
u16  Wait,
char *  pText
 

Output a string on a tiles mode GBA screen letter by letter.

Parameters:
pTextInfo Pointer to TCustomTextInfo structure
x X character number the string should start on
y Y character number the string should start on
Delay The Delay of typing. When calling this function once per VBL, it's usually specified in frames.
Wait The "time" to Wait after the entire text has been drawn When calling this function once per VBL, it's usually specified in frames.
text The string to output
This function will output a string to the GBA display letter by letter, like a typingmachine. It does not support formatting. Before you can use this function, you must call hel_CustomTextInit()!

This function returns true when the entire text has been typed and the specified "Wait" value has been reached.

Returns:
TRUE : Done
FALSE : Still typing or waiting
See also:
hel_CustomTextInit(), hel_CustomTextPrintFmt(), hel_CustomTextType()


Generated on Tue Jun 29 21:45:30 2004 by DoxyGen 1.3.6