IC Imaging Control C++

Grabber::getOverlay Method

Grabber::getOverlay Method

This method returns a pointer to an instance of the OverlayBitmap object. The OverlayBitmap is used to draw text and graphics on the video stream.
smart_ptr<OverlayBitmap> getOverlay() const;
smart_ptr<OverlayBitmap> getOverlay( tPathPosition PathPositionToFetch ) const;

Return value:

A pointer to the instance of OverlayBitmap for the specified path position.


When no path position is specified, the OverlayBitmap for the device path is returned.

To see the things you draw in live video and grabbed images, you have to activate the OverlayBitmaps, using setOverlayBitmapPathPosition.


This example demonstrates how to enable the overlay bitmap and draw the text "Hello Word" in the upper left corner of the live video.

// Make sure, the overlay for the text is enabled
// Draw the text
m_Grabber.getOverlay()->drawText( RGB(255,0,0),  0, 0, "Hello World" );

See also: Grabber, OverlayBitmap, setOverlayBitmapPathPosition

<< Grabber

Get in touch with us

About The Imaging Source

Established in 1990, The Imaging Source is one of the leading manufacturers of industrial cameras, video converters and embedded vision components for factory automation, quality assurance, medicine, science, security and a variety of other markets.

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

ISO 9001:2015 certified MVTEC | Edge AI + Vision Alliance | EMVA

Contact us