IC Imaging Control C++

GrabberListener::overlayCallback Method

GrabberListener::overlayCallback Method

This method is called after the video capture device has delivered a new frame and allows modifications to the OverlayBitmap.
virtual void overlayCallback( Grabber& caller, smart_ptr<OverlayBitmap> pBitmap, const tsMediaSampleDesc& desc );
Parameter Description

Identifies the Grabber object that called this method.


Specifies a pointer to an OverlayBitmap object.


Specifies a reference to a tsMediaSampleDesc structure.


This callback method is called directly after a frame has been delivered by the video capture device. In this method, graphics and text can be drawn on the live video that is frame dependent, i.e. a frame counter.

This callback method is only called, if the GrabberListener object was registered by a call to Grabber::addListener with the parameter eOVERLAYCALLBACK or eALL.

The overlayCallback method is called even if the overlay is disabled with a call to OverlayBitmap::setEnable.

Exceptions that occur in the OverlayCallback event will get lost in the system. Therefore, bugs in the code that cause an exception cannot be recognized. To avoid this, all code in the event handler should be enclosed by a try ... catch block. If you need to display error messages, do not use a message box. Use a "debug trace" instead (e.g. TRACE(...) ). This is very important, because otherwise the system may run into a deadlock which will cause the application to hang.

See also: GrabberListener, Grabber::addListener, GrabberListener::tListenerType, GrabberListener::deviceLost, GrabberListener::frameReady, OverlayBitmap, tsMediaSampleDesc

<< GrabberListener

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.

Automated Imaging Association ISO 9001:2015 certified

Contact us