CreateTextCel

Creates a text cel.

Synopsis

TextCel * CreateTextCel (FontDescriptor *fDesc, uint32 formatFlags, int32 width, int32 height)

Description

Creates a TextCel using the specified sizes and formatting options. Initially, the cel data buffer is empty; until you place text into the cel all pixels are zero.

If width and/or height are zero, the cel is initially created with a 1 x 1 pixel size. Each time text is placed into the cel, the size automatically changes to reflect the size of the text in the cel.

The formatFlags parameter contains one or more formatting options, ORed together. Available options are:

TC_FORMAT_LEFT_JUSTIFY left-justify text
TC_FORMAT_RIGHT_JUSTIFY right -justify text
TC_FORMAT_CENTER_JUSTIFY center-justify text
TC_FORMAT_WORDWRAP auto-word-wrap text

Use DeleteTextCel() to dispose of the cel when you are finished with it.

Arguments

fDesc: Pointer to a FontDescriptor structure.

formatFlags: Text-formatting options.

width: Width of the cel.

height: Height of the cel.

Return Value

Pointer to the newly created TextCel structure; NULL if there isn't enough memory to create the new TextCel.

Associated Files