MbufCopyMask

This function copies the specified source buffer data to the specified destination buffer, modifying only the bits of the destination that have a non-zero corresponding bit in the mask.

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. Note that the source data buffer cannot be of type floating-point.

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. Note that the destination data buffer cannot be of type floating-point.

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.

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.

MaskValue

Specifies the mask value. Even though this value is of type MIL_UINT64, it is treated as if it had the same depth as the destination buffer; the most-significant bits that are not required are ignored.

Compilation information

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