[Previous] [Contents] [Index] [Next]

PgDrawString(), PgDrawStringmx()

Draw a string of characters

Synopsis:

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

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

Description:

These convenience functions for PgDrawText() and PgDrawTextmx() 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.


Note: If you call the "mx" form 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.

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

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PgDrawText(), PgDrawTextmx(), PgFlush()

strlen() (in the C Library Reference)


[Previous] [Contents] [Index] [Next]