| MIL 10 Reference
| Customize Help
| Save Settings

MbufPut2d


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MbufPut1d
MbufPut
Synopsis
Put data from a user-supplied array into a two-dimensional area of a buffer.
Syntax
void MbufPut2d(
MIL_ID DestBufId, //in
MIL_INT OffX, //in
MIL_INT OffY, //in
MIL_INT SizeX, //in
MIL_INT SizeY, //in
const void *UserArrayPtr //in
)
Description

This function copies data from a user-supplied array to a two-dimensional area of the specified MIL destination buffer. If the user-supplied array has multiple bands, MIL copies the data from the user-supplied array to the destination buffer sequentially. 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. For more information, refer to MbufPutColor2d() with M_PLANAR.

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
DestBufId

Specifies 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.

OffX

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

OffY

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

SizeX

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

SizeY

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

UserArrayPtr
Accepts the address of one of the following:
  • array of same type as the buffer

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.

Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
NONE