imaqDrawShapeOnImage

NI Vision for LabWindows/CVI Function

imaqDrawShapeOnImage

Usage

int imaqDrawShapeOnImage(Image* dest, const Image* source, Rect rect, DrawMode mode, ShapeMode shape, float newPixelValue);

Purpose

Draws a shape on an image.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL, IMAQ_IMAGE_SGL

Parameters

Name

Type

Description

dest Image* The destination image.
source const Image* The source image.
rect Rect The bounding rectangle of the shape.
mode DrawMode The method that the function uses to draw the shape.
shape ShapeMode The shape to draw.
newPixelValue float If you set mode to IMAQ_DRAW_VALUE or IMAQ_PAINT_VALUE, newPixelValue sets the pixel value that the function uses to draw a shape.

Return Value

Type

Description

int On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError().