PgDrawString(), PgDrawStringv(), PgDrawStringCx(), PgDrawStringCxv()

Draw a string of characters

Synopsis:

int PgDrawString( char const *ptr,
                  PhPoint_t const *pos );

int PgDrawStringv( char const *ptr,
                   PhPoint_t const *pos );

int PgDrawStringCx( void *dc,
                    char const *ptr,
                    PhPoint_t const *pos );

int PgDrawStringCxv( void *dc,
                     char const *ptr,
                     PhPoint_t const *pos );

Library:

ph

Description:

These convenience functions for PgDrawText*() calculate the length of the string internally using strlen(). They then pass the string, along with its length, its position, and a flags setting of 0, to the corresponding text function.

---

If you call the “v” forms of this function, the data isn't physically copied into the draw buffer. Instead, a pointer to the string is stored until the draw buffer is flushed. Make sure you call PgFlush() before you modify the text.

---

PgDrawString() and PgDrawStringv() work on the current draw context, while you can specify the draw context dc for PgDrawStringCx() and PgDrawStringCxv().

Returns:

0

Success.

-1

The draw buffer is too small to hold the current draw state, the draw command, and the data. Increase the size of the draw buffer, or decrease the size of the string.

Classification:

Photon

See also:

PgDrawMultiTextArea*(), PgDrawText*(), PgDrawTextArea*(), PgFlush*(), PgSetFillColor*(), PgSetFillDither*(), PgSetFillTransPat*(), PgSetFont*(), PgSetTextColor*(), PgSetTextDither*(), PgSetTextTransPat*(), PgSetTextXORColor*(), PgSetUnderline*(), PhPoint_t

“Text” in the Raw Drawing and Animation chapter of the Photon Programmer's Guide

strlen() in the QNX Neutrino Library Reference