McodeDraw

Board	Supported
Host System	Yes
V4L2	Yes
Clarity UHD	Yes
Concord PoE	No
GenTL	Yes
GevIQ	Yes
GigE Vision	Yes
Indio	No
Iris GTX	Yes
Radient eV-CL	Yes
Rapixo CL	Yes
Rapixo CoF	Yes
Rapixo CXP	Yes
USB3 Vision	Yes

Draw specific features of results obtained from an McodeRead, McodeGrade, McodeWrite, or McodeDetect operation.

Syntax

void McodeDraw(
    AIL_ID    ContextGraId,            //in
    AIL_ID    ResultCodeId,            //in
    AIL_ID    DstImageBufOrListGraId,  //out
    AIL_INT64 Operation,               //in
    AIL_INT   ResultIndex,             //in
    AIL_INT   ScanIndex,               //in
    AIL_INT64 ControlFlag              //in
)

Description

This function draws specific features of results, obtained from an McodeRead, McodeGrade, McodeWrite, or McodeDetect operation, in the specified destination image buffer or 2D graphics list.

Parameters

ContextGraId (in, AIL_ID)

Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values:

For specifying the 2D graphics context

Value	Description
M_DEFAULT	Specifies that the default 2D graphics context of the current Aurora Imaging Library application is used.

Note: Note that there is a different default 2D graphics context for each thread. | | 2D graphics context identifier | Specifies a valid 2D graphics context identifier, which you have allocated using MgraAlloc. |

ResultCodeId (in, AIL_ID)

Specifies the identifier of the code read, grade, or detect result buffer from which to extract features to draw. The code result buffer must have been previously allocated on the required system using McodeAllocResult with M_CODE_READ_RESULT, M_CODE_GRADE_RESULT, M_CODE_WRITE_RESULT, or M_CODE_DETECT_RESULT.

DstImageBufOrListGraId (out, AIL_ID)

Specifies the identifier of the destination image buffer or 2D graphics list in which to draw specific features of results.

Operation (in, AIL_INT64)

Specifies the type of drawing operation to perform. Drawing operations can be added together to draw multiple features at a time. For example, to draw both the result occurrence's position and code symbol as it was read using McodeRead, set the Operation parameter to M_DRAW_POSITION+M_DRAW_CODE.

For specifying the type of drawing operation after an

Value	Description
M_DRAW_CODE	Draws the specified code occurrence as it was read by McodeRead or McodeGrade.

This drawing operation is not supported for GS1 Databar, MicroPDF417, and composite code types. | | M_DRAW_DECODED_SCANS | Draws the specified decoded scanline(s) that an McodeRead or McodeGrade operation used to read the specified code occurrence(s). The scanlines are drawn using their start and end points (McodeGetResult with M_DECODED_SCANS_START...and M_DECODED_SCANS_END...).

You can specify the scanline for which to draw results using ScanIndex.

This drawing operation is available for linear and composite code types.

For composite code types, only the scanlines in the 1D portion of the code occurrence(s) are drawn. |

For specifying the type of drawing operation after an

Value

Description

M_DRAW_POSITION

Draws a cross-like symbol at the mid-point of the code occurrence. Note that for a Data Matrix code occurrence, after an McodeRead or McodeGrade operation, the cross symbol is drawn in the middle of the top-left cell. For a composite code occurrence, the cross is drawn at the midpoint of the 1D part of the code. For a Maxicode code occurrence, the cross appears in the center of the bull's eye pattern. Regardless of the code type, the cross is drawn maintaining the angle of the occurrence.

For specifying the type of drawing operation after an

Value	Description
M_DRAW_EXTENDED_AREA	Draws a box around the specified code occurrence, including its extended area, as analyzed by the McodeGrade operation.

Note that this drawing operation is only available if M_EXTENDED_AREA_REFLECTANCE_CHECK was enabled for the McodeGrade operation.

To establish the dimensions of occurrence with its extended area, use McodeGetResult with M_EXTENDED_AREA_TOP... and M_EXTENDED_AREA_BOTTOM....

This drawing operation is available for Aztec, Data Matrix, QR code, and Micro QR code types. | | M_DRAW_REFLECTANCE_PROFILE | Draws the scan reflectance profile of the specified scanline(s) of the code occurrence, as analyzed by the McodeGrade operation. You can specify the scanline for which to draw results using ScanIndex.

The result is not scaled to the size of the destination image buffer. For best results, the image buffer must have a height of at least 256. | | M_DRAW_SCAN_PROFILES | Draws the specified scanline(s) analyzed in the code occurrence by the McodeGrade operation. You can specify the scanline for which to draw results using ScanIndex.

The drawn scanline(s) represents only the region(s) from which the results were successfully located. |

For specifying a drawing operation that is available after either an

Value

Description

M_DRAW_BOX

Draws a box around the code occurrence. This box is drawn according to the corner coordinates of the code occurrence. You can retrieve these coordinates using McodeGetResult with M_BOTTOM... and M_TOP.... The box only contains the part of the code occurrence that was processed; for occurrences of 1D code types from an McodeRead operation performed in low accuracy (McodeControlwith M_POSITION_ACCURACY set to M_LOW), this means that the box might not encompass the entire code occurrence.

The box is drawn maintaining the angle and scale of the occurrence.

When dealing with composite code occurrences (only supported by McodeRead, McodeGrade, and McodeWrite operations), the box is drawn around the 1D component of the code occurrence. To draw the box around the 2D component of a code occurrence, combine M_DRAW_BOX with M_2D_COMPONENT.

Note: Note that after an McodeDetectoperation, you must use this value alone; it cannot be used in combination with any other value. | | M_DRAW_QUIET_ZONE | Draws a box around the specified code occurrence, including its quiet zone, as analyzed by the McodeRead,McodeGrade, or McodeWrite operation.

The box is drawn maintaining the angle and scale of the occurrence.

To establish the dimensions of occurrence with its quiet zone, use McodeGetResult with M_QUIET_ZONE_TOP... and M_QUIET_ZONE_BOTTOM.... The box only contains the part of the code occurrence that was processed; for occurrences of 1D code types from an McodeRead operation performed in low accuracy (McodeControlwith M_POSITION_ACCURACY set to M_LOW), this means that the box might not encompass the entire code occurrence or might include white space.

Note: Note that this drawing operation is not available after an McodeDetect operation. |

For specifying the component of a composite code occurrence for which to perform the drawing after an

Value	Description
M_LINEAR_COMPONENT	Draws the grading result for the 1D component (linear component) of a composite code occurrence.

ResultIndex (in, AIL_INT)

Specifies the code occurrence for which to draw results.

For specifying the occurrence index of the code result

Value	Description
M_DEFAULT
M_ALL (default)	Performs the specified operation for all code occurrences in the code result buffer.
0 <= OccurrenceIndex < M_NUMBER	Specifies the index of the code occurrence in the code result buffer.

See Retrieving results for more information on code occurrence indices. |

ScanIndex (in, AIL_INT)

Specifies the scanline(s) for which to draw results.

For specifying the scanline

Value	Description
M_DEFAULT	Specifies the default value.

For a scanline-specific drawing operation, this value is the same as M_ALL. For a general drawing operation, this value is the same as M_GENERAL. | | M_ALL | Specifies to perform the scanline-specific drawing operation for all scanlines of the specified code occurrence(s). | | M_GENERAL | Specifies to perform the drawing operation without specifying a scanline.

Note: Note that this value is not supported for the M_DRAW_REFLECTANCE_PROFILE and M_DRAW_SCAN_PROFILES drawing operations. | | 0 <= Value < M_NUMBER_OF_DECODED_SCANS | Specifies the index of the decoded scanline for which to perform the drawing operation, for the specified code occurrence.

Note: Note that this value cannot be used if ResultIndex is set to M_ALL or M_DEFAULT. | | 0 <= Value < M_NUMBER_OF_SCANS | Specifies the index of the scanline for which to perform the drawing operation, for the specified code occurrence.

Note: Note that this value cannot be used if ResultIndex is set to M_ALL or M_DEFAULT. |

ControlFlag (in, AIL_INT64)

Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT.