PfWideTextWidthChars()

Calculate the width of a uint16_t string of Unicode characters

Synopsis:

#include <photon/Pf.h>
int PfWideTextWidthChars( const char *font,
                          const uint16_t *str,
                          int len );

Arguments:

font: The name of the desired font. Use PfGenerateFontName() to create the name.
str: A uint16_t string of Unicode characters.
len: The number of characters in the string. If len is 0, strlen(str) is assumed.

Library:

ph

Description:

PfWideTextWidthChars() is a convenience function that calculates the width of the given string in the given font, using the formula:

extent.lr.x - min(extent.ul.x, 0) + 1

This function assumes each character is represented by 2 bytes that conform to the ISO/IEC 10646-1 UCS-2 double-byte format.

PfWideTextWidthBytes() is similar, but you pass it the number of bytes in the string, rather than the number of characters.

Returns:

The width of the string, or 0 if an error occurred.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No