PEXOCCSetCharHeight - Set Character Height (5.0)

Synopsis 

 
    void PEXOCCSetCharHeight(
         PEXOCC context,
         double height
     )
 


 
     void PEXSetCharHeight(
          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 text character height.

Returns

None.

Description

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

Text height defines the nominal height of an uppercase character from its baseline to its capline.

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.

The character height, along with the text font index (see PEXOCCSetTextFontIndex), determine the character width because each font includes a width:height ratio. The supported heights and widths depend on the font files you place in the font group defined by the font table entry which you select. If the font is a stroked font, then a continuous range of character heights and widths are supported. Otherwise PEXlib uses the closest values supported by the font.

Specify height in the text local coordinate system.

This function is a member of the text attribute set and affects 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 output attribute functions, see Output Attribute Functions.