| Customize Help
| Save Settings

MbufCopyClip



Function Map
Synopsis
Copy buffer, clipping data outside the destination buffer.
Syntax
void MbufCopyClip(
MIL_ID SrcBufId, //in
MIL_ID DestBufId, //in
MIL_INT DestOffX, //in
MIL_INT DestOffY //in
)
Description

This function copies the source buffer data to the destination buffer, starting at the specified offset. Data outside of the destination buffer is not copied (it is clipped).

If the source buffer depth is greater than that of the destination, the most significant bits are truncated when the data is copied to the destination. If the destination depth is greater than that of the source, the source data is zero or sign-extended (depending on the type of the source) when copied to the destination.

Note, when copying from a non-binary buffer to a binary buffer, all non-zero pixels in the source buffer are represented as ones (1) in the binary buffer. When copying a binary buffer to a buffer of a different depth, each bit is copied into the least-significant bit of a different destination pixel. The remaining bits of the destination pixel are set to 0; to propagate the bit value to all bits, use MimBinarize().

When copying from a floating-point buffer to an integer buffer, the decimal point values are ignored and the most significant bits are truncated.

You can limit this function's results to a region of an image buffer using a region of interest (ROI) set using MbufSetRegion(). The ROI must be defined in raster format (M_RASTER or M_VECTOR_AND_RASTER). An error is generated if the ROI is only in vector format (M_VECTOR). If you specify multiple image buffers with an ROI, results are limited to the portion of the ROIs that intersect.

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 data buffer.

If you specify an image buffer that has an ROI associated with it, the ROI must be in raster format; otherwise, you will get an error.

DestBufId

Specifies the identifier of the destination data buffer.

If you specify an image buffer that has an ROI associated with it, the ROI must be in raster format; otherwise, you will get an error.

DestOffX

Specifies the horizontal pixel offset of the destination buffer area at which to start copying data. The offset is relative to the top-left corner of the destination buffer (0, 0). Also, this parameter can be set to a negative value, and can be specified anywhere outside the destination buffer. Data extending beyond the limits of the destination buffer is not copied (it is clipped).

DestOffY

Specifies the vertical pixel offset of the destination buffer area at which to start copying data. The offset is relative to the top-left corner of the destination buffer (0,0). Also, this parameter can be set to a negative value and can be specified anywhere outside the destination buffer. Data extending beyond the limits of the destination buffer is not copied (it is clipped).

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