IC Imaging Control C++

OverlayBitmap::setFontBKColor Method

OverlayBitmap::setFontBKColor Method

Sets the background color for drawing text to the specified color value, or to the nearest physical color if the device cannot represent the specified color value.
bool setFontBKColor( COLORREF background );
Parameter Description

Specifies the color of the text background. The color can be specified with the RGB macro.

Return value:

true on success, false otherwise.


The background color is used to fill gaps between styled lines, gaps between hatched lines in brushes and character cells.

The text background is only visible, if the text background mode is opaque. This is to be done by a call to setFontTransparent(false). Otherwise, the text background is not drawn.

If the background color is set to the current dropout color, the background of the text is not visible.

The specified background color is used for all text drawings, until a new background color is set.

This method implements the same behavior as the GDI function SetBkColor().

See also: OverlayBitmap, OverlayBitmap::drawText, OverlayBitmap::getFontBKColor, OverlayBitmap::setFontTransparent, OverlayBitmap::getFontTransparent

<< OverlayBitmap

Get in touch with us

About The Imaging Source

Established in 1990, The Imaging Source is one of the leading manufacturers of industrial cameras, frame grabbers and video converters for production automation, quality assurance, logistics, medicine, science and security.

Our comprehensive range of cameras with USB 3.1, USB 3.0, USB 2.0, GigE interfaces and other innovative machine vision products are renowned for their high quality and ability to meet the performance requirements of demanding applications.

Automated Imaging Association ISO 9001:2015 certified

Contact us