Developer

API Reference

IHFont_SetFontOutlineColor()

Brew Release
Brew MP 1.0.2
See Also
- IHFont
- IWidget_SetProperty()
Description
Applications use this function to specify the color of the glow effect the IHFont object will apply to the characters it draws on screen.
For example, an application might call this routine and specify RGB_WHITE as the outline color. This would be allow dark text drawn on a dark background to be more easily read. Any RGB value may be specified that looks best with your text color and background.
Parameters
  • po
    []:
    Pointer to the IHFont object.
  • rgb
    []:
    Tthe RGBVAL the IHFont will use for the outline
Interface
Prototype
   int IHFont_SetFontOutlineColor(IHFont *po, RGBAVAL rgb);
Return
   AEE_SUCCESS - if IHFont was able to set the outline color.
   AEE_EFAILED - if an error occurred setting the outline color.
Side Effect
None.
Comment
Calling this routine is equivalent to calling IHFont_SetProperty() with PROP_FONT_OUTLINECOLOR.
  • Follow