OverlayBitmap::fill Method

Fills the entire overlay bitmap with the specified color.
Syntax:
bool fill( COLORREF color );
Parameter Description
color

Specifies the color that is used to fill the overly. The color can be specified with the RGB macro.

Return value:

true on success, false otherwise.

Remarks:

This method fills the entire overlay bitmap with the specified color. The bitmap will be completely overwritten. This method can be used to clear the overlay bitmap, if the specified color is the currently used dropout color.

Sample:

This example demonstrates how to fill the complete overlay bitmap with the color magenta that was set as the current dropout color before. This makes the complete overlay bitmap transparent (invisible) on the video stream.

smart_ptr<DShowLib::OverlayBitmap> pOverlayBitmap;
pOverlayBitmap = m_Grabber.getOverlay( ePP_DEVICE );
// Make sure, the overlay is enabled.
pOverlayBitmap->setEnable(true);
pOverlayBitmap->setDropOutColor( RGB(255,0,255));   // Magenta
// Fill the bitmap with the dropout color to make it completely transparent.
pOverlayBitmap->fill(pOverlayBitmap->getDropOutColor());

See also: OverlayBitmap, OverlayBitmap::setDropOutColor, OverlayBitmap::getDropOutColor

<< OverlayBitmap