Warning: main(/www/www/htdocs/style/globals.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pf/pfextenttext.html on line 1
Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/globals.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pf/pfextenttext.html on line 1
Warning: main(/www/www/htdocs/style/header.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pf/pfextenttext.html on line 8
Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/header.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pf/pfextenttext.html on line 8
Calculate the extent rectangle of a text string
#include <photon/Pf.h>
PhRect_t *PfExtentText( PhRect_t *extent,
PhPoint_t const *pos,
const char *font,
const char *str,
int len);
- extent
- A pointer to a
PhRect_t
structure where the function stores the string's extent.
For the interpretation of the members of this structure, see below.
- pos
- NULL, or a pointer to a
PhPoint_t
structure that defines an offset that you want to apply to the extent.
- font
- The base font to use when calculating the extent.
You should create this argument by calling
PfGenerateFontName().
- str
- The UTF-8 multibyte string whose extent you want to determine.
- len
- The number of bytes in the string.
If len is 0, PfExtentText() assumes that it's
strlen(str).
ph
This function calculates the extent rectangle of a text string.
The base font determines the ascender and descender values of the extent.
The width is dependent on
the string — the actual font used by characters within the
string may be different than this base font (as specified in the
fontext and fontmap files).
PfExtentText() stores the text extent in the
PhRect_t that extent points to.
The members are used as follows:
- 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 height of the string is lr.y - ul.y + 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.
A pointer to the extent rectangle (extent) if successful, NULL
otherwise.
Photon
Safety: | |
Interrupt handler |
No |
Signal handler |
No |
Thread |
No |
PfExtent(),
PfExtentCx(),
PfExtentTextToRect(),
PfExtentWideText(),
PfFractionalExtentText(),
PfGenerateFontName(),
PfLoadMetrics(),
PgExtentText(),
PhPoint_t,
PhRect_t
Fonts
chapter of the Photon Programmer's Guide
Warning: main(/www/www/htdocs/style/footer.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pf/pfextenttext.html on line 188
Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/footer.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pf/pfextenttext.html on line 188