Skip to main content

MbufPutColor2d

Put data from a user-supplied array into an area of one or all bands of a data buffer.

Syntax​

void MbufPutColor2d(
    AIL_ID       DestBufId,    //out
    AIL_INT64    DataFormat,   //in
    AIL_INT      Band,         //in
    AIL_INT      OffX,         //in
    AIL_INT      OffY,         //in
    AIL_INT      SizeX,        //in
    AIL_INT      SizeY,        //in
    const void * UserArrayPtr  //in
)

Description​

This function copies data from a user-supplied array to a specified area in one or all bands of a specified Aurora Imaging Library destination buffer.

Parameters​

DestBufId (out, AIL_ID)​

Specifies the identifier of the destination buffer.

DataFormat (in, AIL_INT64)​

Specifies the data format of the user-supplied array. The internal data format of the destination buffer need not match the specified data format of the user-supplied array; an internal conversion will be performed if necessary. Note, however, if the formats do match, the operation will be much faster.

Band (in, AIL_INT)​

Specifies the index of the band in which to copy. This parameter can be set to one of the values below.

For specifying the index of the band

ValueDescription
M_ALL_BANDSCopies to all bands.
M_BLUECopies to the blue band (for RGB buffers).
M_GREENCopies to the green band (for RGB buffers).
M_HUECopies to the hue band (for HSL, and HSV buffers).
M_LUMINANCECopies to the luminance band (for HSL buffers).
M_REDCopies to the red band (for RGB buffers).
M_SATURATIONCopies to the saturation band (for HSL and HSV buffers).
M_VSpecifies the V band (for HSV buffers).
0 <= Value < #bandsSpecifies the index of the band to copy.

The relationship between index value and band for RGB, HSL, and HSV buffers is the following:

0Corresponds to the red band for RGB buffers, or the hue band for HSL and HSV buffers.
1Corresponds to the green band for RGB buffers, or the saturation band for HSL and HSV buffers.
2Corresponds to the blue band for RGB buffers, or the luminance band for HSL buffers, or the V band for HSV buffers.

OffX (in, AIL_INT)​

Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate.

OffY (in, AIL_INT)​

Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate.

SizeX (in, AIL_INT)​

Specifies the width of the destination buffer area in which to put the data.

SizeY (in, AIL_INT)​

Specifies the height of the destination buffer area in which to put the data.

UserArrayPtr *(in, void)​

Specifies the address of the user array from which to copy data into the destination buffer. Ensure that user array is large enough to contain the data to be copied to the destination buffer.

Parameter Associations​

For specifying the data format​

Note that SizeX and SizeY denote the destination buffer's width and height, respectively.

M_PACKED​

Copies the bands in an interleaved manner (for example, RGB RGB RGB...). This format is only valid when the Band parameter is set to M_ALL_BANDS.

M_PLANAR​

Copies the bands one after the other. This format is to be used when copying to all bands (M_ALL_BANDS) of the destination buffer.

M_SINGLE_BAND​

Copies to a single band. This format is not valid when the Band parameter is set to M_ALL_BANDS.

Combination Constants — For setting the packed data format​

Essential.

Usage: You must add one of the following values to the above-mentioned values to set the packed data format.

For more information on these formats, see RGB buffers.

M_BGR24​

Stores the data in a BGR24 packed format. In this format, each pixel is internally stored as three consecutive bytes.

M_BGR32​

Stores the data in a BGR32 packed format. In this format, each pixel is internally stored as four consecutive bytes. Every fourth byte is a "don't care" byte.

M_RGB15​

Stores the data in a RGB15 packed format. In this format, each pixel is internally stored as a 16-bit word with a 5-bit blue value (least significant), a 5-bit green value, a 5-bit red value, and a "don't care" bit (most significant), in little-endian order (RGB 5:5:5).

M_RGB16​

Stores the data in a RGB16 packed format. In this format, each pixel is internally stored as a 16-bit word with a 5-bit blue value (least significant), a 6-bit green value, and a 5-bit red value (most significant), in little-endian order (RGB 5:6:5).

M_RGB24​

Stores the data in a RGB24 packed format. In this format, each pixel is internally stored as three consecutive bytes.

Copyright © 2026 Zebra Technologies.