Overlay
Top  Previous  Next

Description

Enables/disables the overlay.

Syntax


[VB]
objActiveUSB.Overlay [= Value]


[C/C++]
HRESULT get_Overlay ( bool *pOverlay );
HRESULT put_Overlay( bool Overlay );


Data Type
[VB]

Boolean

Parameters
[C/C++]

pOverlay [out,retval]  
Pointer to the Boolean that is TRUE if the overlay is enable, or FALSE otherwise  
Overlay [in]  
Set to TRUE to enable the overlay, or set to FALSE to disable it.  


Return Values


S_OK  
Success  
E_FAIL  
Failure.  

Example


The following VB example overlays a red circle on the live video:

ActiveUSB1.Acquire = 
True

ActiveUSB1.OverlayEllipse 100,100,200,200
ActiveUSB1.OverlayColor=RGB(255,0,0)
ActiveUSB1.Overlay=  
True

 

Remarks


Overlay feature allows you to display custom graphics and text on the live video image. Setting this property to true causes ActiveUSB to show the overlay. Disabling this property hides the overlay. Note that hiding the overlay does not erase graphics and text from it. To clear the overlay, use OverlayClear. Also see OverlayColor, OverlayPixel, OverlayLine, OverlayRectangle, OverlayEllipse, OverlayText.