PEXText(3) — Subroutines

Name

PEXText - 3D Text Primitive

Synopsis

void PEXText(Display ∗display, XID resource_id, PEXOCRequestType req_type, PEXCoord ∗origin, PEXVector ∗vector1, PEXVector ∗vector2, int length, char ∗string)

Arguments

displayA pointer to a display structure returned by a successful XOpenDisplay call.

resource_idThe resource identifier of the renderer or structure.

req_typeThe request type for the output command (PEXOCRender, PEXOCStore, PEXOCRenderSingle or PEXOCStoreSingle).

originThe origin of the text string.

vector1A vector defining the positive x-direction of the text local coordinate system.

vector2A vector defining the positive y-direction of the text local coordinate system.

lengthThe number of bytes in the text string.

stringA pointer to the text string.

Returns

None

Description

This function creates a text output primitive.

The first character set in the text font will be used.

The text string is located on a plane defined by its position and direction vectors. The origin defines the position, in model coordinates, at which to render the text string. The two direction vectors define the positive x- and y-directions of the text local coordinate system. If the two vectors are parallel or if one of the vectors has zero length, the vector values <1,0,0> and <0,1,0> are used.

During rendering, the string’s position is transformed to a position in device coordinates. The string’s color is only affected by depth-cueing and is mapped to a device color. The text string is clipped depending on the current text precision attribute. If the text precision is PEXStringPrecision, clipping is done in an implementation-dependent fashion. If the text precision is PEXCharPrecision, clipping is done on at least a character-by-character basis. If the text precision is PEXStrokePrecision, clipping is performed at the clipping boundaries for each character.

Depending on the text ASF values, the text color, text precision, character expansion, character spacing, and text font attributes are obtained either directly from the current text attribute values or from the entry in the text bundle specified by the current text bundle index attribute. The current character height, text path, text alignment attributes and character up vector are also used to render the text string. The directions specified by the character up vector and text path are relative to the text local coordinate system.

Data Structures

See the PEXStructuresman page.

Errors

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadPEXStructure
The specified structure resource identifier is invalid.

Museum