MbufPutColor

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

Syntax

void MbufPutColor(
    AIL_ID       DestBufId,    //out
    AIL_INT64    DataFormat,   //in
    AIL_INT      Band,         //in
    const void * UserArrayPtr  //in
)

Description

This function copies data from a user-supplied array to 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 user-supplied array need not match the data format of the Aurora Imaging Library destination buffer (planar); 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 in which band to put the data. Set this parameter to one of the following values:

For specifying the band

Value	Description
M_ALL_BANDS	Specifies all bands (for multi-band buffers).
M_BLUE	Specifies the blue color band (for RGB buffers).
M_GREEN	Specifies the green color band (for RGB buffers).
M_HUE	Specifies the hue band (for HSL and HSV buffers).
M_LUMINANCE	Specifies the luminance band (for HSL buffers).
M_RED	Specifies the red color band (for RGB buffers).
M_SATURATION	Specifies the saturation band (for HSL and HSV and HSV buffers).
M_U	Specifies the U band (for YUV buffers).
M_V	Specifies the V band (for YUV and HSV buffers).
M_Y	Specifies the Y band (for YUV buffers).
0 <= Value < #bands	Specifies the index of the band to copy.

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

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

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.