OverlayBitmap

An OverlayBitmap object contains the overlay data, methods and properties for drawing text and graphics on the live video stream.

Example

[C#]
OverlayBitmap ob = ICImagingControl1.OverlayBitmapAtPath[PathPositions.Device]; // Enable the overlay bitmap for drawing. ob.Enable = true; // Set magenta as the dropout color. ob.DropOutColor = System.Drawing.Color.Magenta; // Fill the overlay bitmap with the dropout color. ob.Fill(ob.DropOutColor); // Print some text in red. ob.FontTransparent = true; ob.DrawText(System.Drawing.Color.Red, 10, 10, "IC Imaging Control 2.0");

Information

    Namespace: TIS.Imaging
    Introduced in version 1.x

Properties

Property Description
ColorMode

Set the color mode of this OverlayBitmap. The color mode determines whether the overlay bitmap is painted in color or in grayscale. The images provided by the video capture device are converted into the selected format before drawing the overlay.

DropOutColor

Returns or sets the current dropout color.

Enable

Returns or sets the currently enabled state of the overlay bitmap.

FlipVertical

Returns or sets vertical flipping of the overlay bitmap.

Font

Returns or sets the font for OverlayBitmap.DrawText.

FontBackColor

Returns or sets the background color for OverlayBitmap.DrawText.

FontTransparent

Returns or sets the background mode for OverlayBitmap.DrawText.

OverlayFrameType

This property returns the actual image format of the overlay bitmap.

PathPosition

Returns the path position of this OverlayBitmap.

Methods

Method Description
DrawFrameEllipse

This method draws an empty frame ellipse on the live video.

DrawFrameRect

This method draws an empty frame rectangle on the live video.

DrawLine

This method draws a line on the live video.

DrawSolidEllipse

This method draws a solid, filled ellipse on the live video.

DrawSolidRect

This method draws a solid, filled rectangle on the live video.

DrawText

This method draws text on the live video.

Fill

This method fills the entire overlay bitmap with the passed color.

GetGraphics

The method retrieves a Graphics object that represents the overlay bitmap as a GDI+ drawing surface.

ReleaseGraphics

This method releases the GDI+ Graphics object that was previously retrieved with OverlayBitmap.GetGraphics.

<< Classes