PfFractionalExtentText()

Calculate the extent rectangle of a text string, using fractional scaling

Synopsis:

#include <photon/Pf.h>

PhRect_t *PfFractionalExtentText( 
             PhRect_t *extent, 
             PhPoint_t const *pos, 
             const char *font,
             long xsize,
             long ysize,
             const char *str, 
             int len);

Library:

ph

Description:

This function calculates the extent rectangle of a text string. The base font is identified by font, which you should create by calling PfGenerateFontName(). The base font determines the ascender and descender values of the extent. The xsize and ysize arguments define the size of the font in 16.16 fixed-point format.

This function is intended to be used with scalable fonts. If a bitmap font is provided, an attempt is made to map the font to a scalable equivalent, though success isn't guaranteed.

The string str is a UTF-8, multibyte string of len bytes. If len is 0, strlen(str) is assumed.

The text extent is returned in a PhRect_t structure whose members are:

ul.x

The left bearing.

lr.x

The maximum x distance.

ul.y

The ascender.

lr.y

The descender.

The baseline of the font is at position y=0; the width of the string is lr.x - min(ul.x, 0) + 1.

The resulting extent is offset by the point passed in the PhPoint_t structure pointed to by pos. If pos is NULL, no offset is applied.

If metrics for the base font have been loaded locally (see PfLoadMetrics()) then this extent may be calculated internally; otherwise a request is sent to the font server.

Returns:

A pointer to the extent rectangle (extent) if successful, NULL otherwise.

Classification:

Photon

See also:

PfExtent(), PfExtentCx(), PfExtentText(), PfExtentTextToRect(), PfFractionalRenderText(), PfGenerateFontName(), PfLoadMetrics(), PgExtentText(), PhPoint_t, PhRect_t

Fonts chapter of the Photon Programmer's Guide