PEXOCCAnnotationText2D - 2D Annotation Text Primitive (5.0)

Synopsis 

     void PEXOCCAnnotationText2D(
          PEXOCC context,
          PEXCoord2D *origin,
          PEXCoord2D *offset,
          int length,
          char *string
     )


     void PEXAnnotationText2D(
          Display *display,
          XID resource_id,
          PEXOCRequestType req_type,
          PEXCoord2D *origin,
          PEXCoord2D *offset,
          int length,
          char *string
     )

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.

length
The number of bytes in the text string.

string
A pointer to the text string.

Returns

None.

Description

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

This primitive functions like the PEXAnnotationText primitive except that you only need to specify x- and y-components for the origin and offset positions. The z-component is always assumed to be zero. This primitive is two-dimensional only in that the z-component is implied. The implementation still carries out the geometry transformations in three dimensions.

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.