| MIL 10 Reference
| Customize Help
| Save Settings

MbufControlArea


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
None.
MbufControl
MbufControlNeighborhood
Synopsis
Control a specified area of a buffer.
Syntax
void MbufControlArea(
MIL_ID BufId, //in
MIL_INT OffsetX, //in
MIL_INT OffsetY, //in
MIL_INT SizeX, //in
MIL_INT SizeY, //in
MIL_INT Band, //in
MIL_INT64 ControlType, //in
MIL_DOUBLE ControlValue //in
)
Description

This function allows you to control a specified area of a buffer.

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 buffer to control.

OffsetX

Specifies the horizontal pixel offset of the area.

OffsetY

Specifies the vertical pixel offset of the area.

SizeX

Specifies the width of the area, in pixels.

SizeY

Specifies the height of the area, in pixels.

Band

Specifies the band of the area. This parameter can be set to one of the following values.

function map For the band of the area
CollapseValue Description
Collapse M_DEFAULT

Same as M_ALL_BANDS.
Collapse M_ALL_BANDS

Specifies all color bands (for RGB, HSL, and YUV buffers).
Collapse M_BLUE

Specifies the blue color band (for RGB buffers).
Collapse M_GREEN

Specifies the green color band (for RGB buffers).
Collapse M_RED

Specifies the red color band (for RGB buffers).
ControlType

Specifies the type of buffer setting to control.

See the Parameter associations section for possible values that can be specified.

ControlValue

Specifies the value required for the setting.

See the Parameter associations section for possible values that can be specified.

Parameter associations

The table below lists possible values for the ControlType and ControlValue parameters.

function map For the buffer settings
CollapseControlType Description
ControlValue
Collapse M_MODIFIED

Signals MIL that the content in the specified area of the buffer was modified without using MIL. This control should be used to ensure that MIL updates its internal information on this area of the buffer. For example, if an area of a buffer that is selected on a display is modified using a pointer to its memory, the display will not be updated automatically. You should use this control type to force a display update of this area.

Note that this setting does the same thing as using MbufControl() with M_MODIFIED, but it is faster because it updates a specific area of the buffer, instead of updating the whole buffer.

This setting increments the buffer's modification counter. You can inquire about the counter's current value using MbufInquire() with M_MODIFICATION_COUNT.

(summarize)
Collapse M_DEFAULT

Implements the default behavior.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
DEFAULT ALL BANDS BLUE GREEN RED MODIFIED DEFAULT