MbufGet2d

This function copies data from a specified two-dimensional area of a MIL source buffer to a user-supplied array. If the source buffer has multiple bands, this function linearly copies the data from the specified two-dimensional area of each band (for example, RRR...GGG...BBB...). The internal data format of the source buffer need not match the data format of the user-supplied array (planar); an internal conversion will be performed if necessary. Note, however, if the formats do match, the operation will be much faster. For more information, refer to MbufGetColor2d() with M_PLANAR.

If the specified buffer is a binary image buffer, any extra bits to complete a byte in the array are undefined.

If the source buffer is compressed, MIL decompresses the data before copying it to the user-supplied array.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

SrcBufId

Specifies the identifier of the source buffer.

If the specified buffer is an image buffer with an associated region of interest (ROI), an error will occur.

OffX

Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer.

OffY

Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer.

SizeX

Specifies the width of the required area of the source buffer.

SizeY

Specifies the height of the required area of the source buffer.

UserArrayPtr

Accepts the address of one of the following:

array of same type as the buffer

Specifies the address of the user array in which to copy the data from the source buffer. Ensure that the user array is large enough to receive the data to be copied from the source buffer.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.