PEXOCCEncodedAnnoText2D - Encoded 2D Annotation Text Primitive (5.0)


Synopsis

 
     void PEXOCCEncodedAnnoText2D(
          PEXOCC context,
          PEXCoord2D *origin,
          PEXCoord2D *offset,
          unsigned int count,
          PEXEncodedTextData *encoded_text
     )
 

 
     void PEXEncodedAnnoText2D(
          Display *display,
          XID resource_id,
          PEXOCRequestType req_type,
          PEXCoord2D *origin,
          PEXCoord2D *offset,
          unsigned int count,
          PEXEncodedTextData *encoded_text
      )
 

Arguments

context
An OC context returned by a successful PEXCreateOCC call.

display (OCC)
A pointer to a display structure returned by a successful XOpenDisplay call.

resource_id (OCC)
The resource identifier of the renderer or structure.

req_type (OCC)
The request type for the output command (PEXOCRender, PEXOCStore, PEXOCRenderSingle or PEXOCStoreSingle).

origin
The origin of the text string.

offset
The relative position of the text string from the origin.

count
The number of encoded text strings.

encoded_text
An array of encoded text strings.

Returns

None.

Description

Invoke PEXOCCEncodedAnnoText2D to create a two-dimensional annotation text primitive output command (PEXOCAnnotationText2D).

This primitive is similar to the PEXAnnotationText2D primitive, except that you can specify multiple encoded text strings. Each text string in the encoded text array has a character set, a character set width, an encoding state, and a list of characters.

The character set is an index into the current font group. Font groups contain individual fonts which are numbered starting at one; a value of three selects the third font in the font group currently being used. If a character set is not available in the current font group, then the implementation uses the default font group to render the entire string. If a character set value is not available in the default font group, then the implementation renders that portion of the string in an implementation-dependent way.

The character set width indicates the width or size of characters in the strings. PEXlib defines the following character set widths: PEXCSByte, PEXCSShort and PEXCSLong. The PEX implementation does not interpret the encoding state; only the application uses it.

All other aspects of this primitive are the same as PEXAnnotationText2D.

Errors

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadPEXStructure
The specified structure resource identifier is invalid.

See Also

For primitives similar to this one, see:

For PEXlib 5.1 compatibility primitives similar to this one, see:

For attributes that affect this primitive, see Annotation Text Attributes.

For an overview, see Output Command Functions.