MbufPutColor
- See also
Availability
Function map
- Examples
MbufPutColor2d
- MbufPutLine
- array of the same type as the buffer (DestBufId) [optionally, in C++: a reference to a std::vector of the same type as the buffer]
- array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
-
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:(defined elsewhere) * (defined elsewhere)
Note: For the number of bytes (n), refer to the combination constants For setting the packed data format. -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:(defined elsewhere) * (defined elsewhere)
Note: For the number of bytes (n), refer to the combination constants For setting the packed data format. -
Data type: array of the same type as the buffer (DestBufId) [optionally, in C++: a reference to a std::vector of the same type as the buffer]
Required array size: MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) * MbufInquire ( M_SIZE_BAND ) -
Data type: array of the same type as the buffer (DestBufId) [optionally, in C++: a reference to a std::vector of the same type as the buffer]
Required array size: MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) * MbufInquire ( M_SIZE_BAND ) -
Data type: array of the same type as the buffer (DestBufId) [optionally, in C++: a reference to a std::vector of the same type as the buffer]
Required array size: MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of the same type as the buffer (DestBufId) [optionally, in C++: a reference to a std::vector of the same type as the buffer]
Required array size: MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:3 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:3 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:4 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:4 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:2 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:2 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:2 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:2 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:3 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y ) -
Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
Required array size:3 * MbufInquire ( M_SIZE_X ) * MbufInquire ( M_SIZE_Y )
| Table: | For specifying the data format |
| + combination: | For setting the packed data format |
| MIL_ID DestBufId, | //in |
| MIL_INT64 DataFormat, | //in |
| MIL_INT Band, | //in |
| const void *UserArrayPtr | //in |
DescriptionThis function copies data from a user-supplied array to one or all bands of a specified MIL destination buffer.
ParametersSpecifies the identifier of the destination buffer.
If the specified buffer is an image buffer with an associated region of interest (ROI), an error will occur.
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 MIL destination buffer (planar); an internal conversion will be performed if necessary. Note, however, if the formats do match, the operation will be much faster.
See the Parameter associations section for possible values that can be specified.
Specifies in which color band to put the data. Set this parameter to one of the following values:
|
For specifying the color band |
|||||||||||||||||||||||||||||||||||||||
| Value |
Description | ||||||||||||||||||||||||||||||||||||||
| M_ALL_BANDS |
Specifies all color bands (for RGB, HSL, HSV, and YUV 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 <= 2 |
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:
Specifies the index of the band to copy. (more details...) |
||||||||||||||||||||||||||||||||||||||
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.
See the Parameter associations section for possible values that can be specified.
The table below lists possible values for the DataFormat and UserArrayPtr parameters.
Note that SizeX and SizeY denote the destination buffer's width and height, respectively.
|
For specifying the data format
|
|||||||||||||||||||||||||||||||||||||||
|
|
Description | ||||||||||||||||||||||||||||||||||||||
| UserArrayPtr | |||||||||||||||||||||||||||||||||||||||
| 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. You must specify a combination value from the following table: Copies the bands in an interleaved manner (for example, RGB RGB RGB...). (more details...) |
||||||||||||||||||||||||||||||||||||||
  UserArrayPtr extra info |
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
|
||||||||||||||||||||||||||||||||||||||
| M_PLANAR |
Copies the bands one after the other (RRR...GGG...BBB...). This format is to be used when copying to all bands (M_ALL_BANDS) of the destination buffer. (summarize)Copies the bands one after the other (RRR...GGG...BBB...). (more details...) |
||||||||||||||||||||||||||||||||||||||
| UserArrayPtr extra info |
Data type info: Data
type: array of the same type as the buffer
(DestBufId)
[optionally, in C++: a reference to a std::vector of the same type
as the buffer] MORE
Data type info: Data
type: array of the same type as the buffer
(DestBufId)
[optionally, in C++: a reference to a std::vector of the same type
as the buffer] MORE
|
||||||||||||||||||||||||||||||||||||||
| M_SINGLE_BAND |
Copies to a single band. This format is not valid when the Band parameter is set to M_ALL_BANDS. (summarize)Copies to a single band. (more details...) |
||||||||||||||||||||||||||||||||||||||
| UserArrayPtr extra info |
Data type info: Data
type: array of the same type as the buffer
(DestBufId)
[optionally, in C++: a reference to a std::vector of the same type
as the buffer] MORE
Data type info: Data
type: array of the same type as the buffer
(DestBufId)
[optionally, in C++: a reference to a std::vector of the same type
as the buffer] MORE
|
||||||||||||||||||||||||||||||||||||||
You must add one of the following values to the above-mentioned value to set the packed data format.
For more information on these formats, see the RGB buffers section of Chapter 21: Data buffers.
|
For setting the packed data format
|
|||||||||||||||||||||||||||||||||||||||
| DataFormat |
Description | ||||||||||||||||||||||||||||||||||||||
| UserArrayPtr | |||||||||||||||||||||||||||||||||||||||
| M_BGR24 |
Stores the data in a BGR24 packed format. In this format, each pixel is internally stored as three consecutive bytes. (summarize)Stores the data in a BGR24 packed format. (more details...) |
||||||||||||||||||||||||||||||||||||||
| UserArrayPtr
extra info |
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
|
||||||||||||||||||||||||||||||||||||||
| 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. (summarize)Stores the data in a BGR32 packed format. (more details...) |
||||||||||||||||||||||||||||||||||||||
| UserArrayPtr
extra info |
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
|
||||||||||||||||||||||||||||||||||||||
| 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). (summarize)Stores the data in a RGB15 packed format. (more details...) |
||||||||||||||||||||||||||||||||||||||
| UserArrayPtr
extra info |
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
|
||||||||||||||||||||||||||||||||||||||
| 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). (summarize)Stores the data in a RGB16 packed format. (more details...) |
||||||||||||||||||||||||||||||||||||||
| UserArrayPtr
extra info |
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
|
||||||||||||||||||||||||||||||||||||||
| M_RGB24 |
Stores the data in a RGB24 packed format. In this format, each pixel is internally stored as three consecutive bytes. (summarize)Stores the data in a RGB24 packed format. (more details...) |
||||||||||||||||||||||||||||||||||||||
| UserArrayPtr
extra info |
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
Data type info: Data
type: array of type MIL_UINT8 [optionally, in C++:
a reference to a constant std::vector<MIL_UINT8>
] MORE
|
||||||||||||||||||||||||||||||||||||||
| Header | Include mil.h. |
| Library | Use mil.lib. |
| DLL | Requires mil.dll. |