GetFontCharInfo

Retrieves character information.

Synopsis

int32 GetFontCharInfo (FontDescriptor *fDesc,int32 character, void **blitInfo)

Description

Returns information about the specified character. The return value is the width of the character (not including inter-character spacing). The void pointer at *blitInfo will contain a special value to speed up processing within BlitFontChar().

GetFontCharInfo() supports the internals of the text library; it should never be necessary to call this function directly from an application program. If you are implementing your own replacement text library, use GetFontcharInfo() to obtain information about font character pixels before blitting them into your own memory buffer. You can use the standard text library source code as a guide in creating your own text library.

Arguments

fDesc: Pointer to a FontDescriptor structure.

character: The specific character you're looking for.

blitInfo: A void pointer updated by this call and then passed to the BlitFontChar() call.

Return Value

Width of the character; zero if the character is not present in the font.

Associated Files