| MIL 10 Reference
| Customize Help
| Save Settings

MbufChildMove



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
Synopsis
Move and resize a child buffer within the parent buffer.
Syntax
void MbufChildMove(
MIL_ID BufId, //in
MIL_INT OffsetX, //in
MIL_INT OffsetY, //in
MIL_INT SizeX, //in
MIL_INT SizeY, //in
MIL_INT64 ControlFlag //in
)
Description

This function moves and resizes a child buffer within the parent buffer. If the specified new offset or size causes the child buffer to be partially outside of the parent buffer, the child buffer can be clipped to the parent buffer (using M_CLIP).

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
BufId

Specifies the identifier of the child buffer to move and/or resize. This buffer should be allocated using MbufChild...().

This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

OffsetX

Specifies the new X-offset of the child buffer relative to the parent buffer's top-left pixel.

function map For the X-offset
CollapseValue Description
Collapse M_DEFAULT

Specifies the default value. The default is the current X-offset of the child buffer.

(summarize)
Collapse Value

Specifies the X-offset, in pixels.

OffsetY

Specifies the new Y-offset of the child buffer relative to the parent's top-left pixel.

function map For the Y-offset
CollapseValue Description
Collapse M_DEFAULT

Specifies the default value. The default is the current Y-offset of the child buffer.

(summarize)
Collapse Value

Specifies the Y-offset, in pixels.

SizeX

Specifies the new width of the child buffer.

function map For the width
CollapseValue Description
Collapse M_DEFAULT

Specifies the default value. The default is the current width of the child buffer.

(summarize)
Collapse Value > 0

Specifies the width, in pixels.

SizeY

Specifies the new height of the child buffer.

function map For the height
CollapseValue Description
Collapse M_DEFAULT

Specifies the default value. The default is the current height of the child buffer.

(summarize)
Collapse Value > 0

Specifies the height, in pixels.

ControlFlag

Specifies the function's control flag. This parameter must be set to one of the following:

function map For specifying the function's control flag
CollapseValue Description
Collapse M_DEFAULT

Specifies to use the values passed to the offset and size parameters as is, when moving the child buffer. Note that, if you try to move the child buffer outside the limits of the parent buffer, an error is reported.

(summarize)
Collapse M_CLIP

Specifies that the values passed to the offset and size parameters are automatically adjusted (if necessary) to ensure that the child buffer stays within the limits of the parent buffer. Note that, if you try to move the child buffer completely outside the limits of the parent buffer, an error is reported.

(summarize)
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
NONE DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT CLIP