XPLMDrawString

From X-Plane SDK
Jump to: navigation, search

XPLMDrawString

XPLM_API void                 XPLMDrawString(
                                   float *              inColorRGB,    
                                   int                  inXOffset,    
                                   int                  inYOffset,    
                                   char *               inChar,    
                                   int *                inWordWrapWidth,    /* Can be NULL */
                                   XPLMFontID           inFontID);    
This routine draws a NULL termianted string in a given font. Pass in the lower left pixel that the character is to be drawn onto. Also pass the character and font ID. This function returns the x offset plus the width of all drawn characters. The color to draw in is specified as a pointer to an array of three floating point colors, representing RGB intensities from 0.0 to 1.0.

WARNING: Custom fonts are going away!

In the future only xplmFont_Basic will be allowed. Non-basic fonts are unpredictable and may not work right. (See KnownBugs.) So in the future we may provide another method for custom fonts (where plugins provide the texture) and not depend on X-Plane's textures.