PEXOCCSetATextHeight - Set Annotation Text Height (5.0)

Synopsis

 
   void PEXOCCSetATextHeight(
           PEXOCC context,
           double height
     )
 

 
   void PEXSetATextHeight(
           Display *display,
           XID resource_id,
           PEXOCRequestType req_type,
           double height
     )

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).

height

The annotation text character height.

Returns

None.

Description

Invoke PEXOCCSetATextHeight to create an attribute output command which sets the annotation text height attribute in the renderer's pipeline state according to the value specified by height.

The annotation text height defines the nominal height of an uppercase character from its baseline to it capline. Height is specified in the annotation text primitive's local coordinate system.

baseline

a horizontal line upon which the characters sit according to the font. In general there is space between the baseline and the bottomline for placing the lower portions of letters, such as the stems of the lowercase "j" and "q."

capline

a horizontal line which bounds the top of the characters of a character string according to the font. In general there is space between the capline and the topline for placing additional rendering, such as an accent, above the character string.

If the implementation does not support the specified height or the computed width, then the implementation maps the height or width to the nearest supported annotation character height or width. You select a font table entry that defines a font group. The supported annotation character height and width depend on the font files you place in this font group. If all of the fonts are stroked fonts, then the implementation supports a continuous range of character sizes.

This function is a member of the annotation attribute set and affects all annotation text primitives.

Errors

BadPEXRenderer

The specified renderer resource identifier is invalid.

BadPEXStructure

The specified structure resource identifier is invalid.

See Also

For an overview and for a list of all output attribute functions, see Output Attribute Functions.