Filters
Filter values by
Buffer type
  • Array buffer
  • Image buffer
    • Common to all
    • Compressed attribute specific
    • Processing attribute specific
  • Kernel buffer
  • LUT buffer
  • Structuring element buffer
Component type
  • Range component
  • Disparity component
| Customize Help
| Save Settings

MbufInquire



Function Map
Parameter Associations
Table: For inquiring general buffer settings
+ combination: Returns the location of the buffer
+ combination: Returns whether the buffer was allocated in paged or non-paged memory
Table: For M_KERNEL and M_STRUCT_ELEMENT data buffers
Table: For M_KERNEL data buffers only
Table: For M_STRUCT_ELEMENT data buffers only
Table: For M_IMAGE data buffers only
+ combination: Returns the intended purpose of the image buffer
+ combination: Returns the compression type
+ combination: Returns whether the buffer was allocated with an overscan region
+ combination: Returns the storage format and location specifier
+ combination: Returns whether the buffer is FPGA accessible
+ combination: Returns the memory bank used
+ combination: For specifying a location in a specific type of memory
+ combination: Returns the format in which color buffers were stored
+ combination: Returns the packed or planar color buffer format
+ combination: Returns the packed color buffer format
+ combination: Returns the planar color buffer format
Table: For M_IMAGE + M_COMPRESS image buffers
Table: For M_IMAGE + M_COMPRESS (with M_JPEG_LOSSY, M_JPEG_LOSSY_INTERLACED, or M_JPEG2000_LOSSY)
Table: For M_IMAGE + M_COMPRESS (with M_JPEG2000_LOSSY or M_JPEG2000_LOSSLESS)
+ combination: For M_DECOMPOSITION_LEVEL, M_NUMBER_SUBBAND, M_Q_FACTOR (for JPEG2000 lossy buffers), and M_QUANTIZATION (for JPEG2000 lossy buffers)
Table: For M_IMAGE + M_COMPRESS (with M_JPEG2000_LOSSY)
Table: For M_IMAGE + M_COMPRESS (with M_JPEG_LOSSY, M_JPEG_LOSSY_INTERLACED, M_JPEG_LOSSLESS, or M_JPEG_LOSSLESS_INTERLACED)
Table: For M_IMAGE + M_COMPRESS (with M_JPEG_LOSSLESS, or M_JPEG_LOSSLESS_INTERLACED)
Table: For M_IMAGE + M_COMPRESS (with M_JPEG_LOSSY, or M_JPEG_LOSSY_INTERLACED)
Table: For inquiring settings useful with buffers that are components
+ combination: For getting the string size
Table: For inquiring settings useful with M_IMAGE buffers that store 3D data and are components
Synopsis
Inquire about a MIL data buffer setting.
Syntax
MIL_INT MbufInquire(
MIL_ID BufId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about a specified setting of a MIL data 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 which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
BufId

Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor() or MbufImport()).

InquireType

Specifies the type of buffer setting about which to inquire.

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

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
  • same type as the buffer (BufId)
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MbufInquire() function also returns the requested information, you can set this parameter to M_NULL, except when the specified InquireType requires the UserVarPtr parameter to be set to the address of a MIL_INT64 or MIL_DOUBLE. In this case, you must set this parameter to the address of a MIL_INT64 or MIL_DOUBLE, respectively.

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

The following inquire types allow you to inquire about general types of buffer settings.

function map For inquiring general buffer settings
Click to summarize
InquireType
Description MIL system-specific
tooltip (‡)
UserVarPtr
- Possible values returned
Click to summarize M_ALLOCATION_OVERSCAN_SIZE

Inquires the size of the overscan region of the image buffer. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the size of the overscan region, in pixels.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ANCESTOR_ID

Inquires the MIL identifier of the ancestor buffer. Only child buffers have an ancestor buffer. The ancestor buffer is the buffer from which the specified buffer (BufId) ultimately originated. It is the root buffer; it does not have a parent buffer (it is not a child buffer of another buffer). Note that the identifier of the specified buffer is returned if it does not have an ancestor buffer.

To establish the parent buffer of the specified buffer, use M_PARENT_ID instead.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize MIL Buffer ID

Specifies the MIL identifier of the ancestor buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ANCESTOR_OFFSET_BAND

Inquires the band offset relative to the ancestor buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the band offset.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ANCESTOR_OFFSET_BIT

Inquires the bit offset relative to the ancestor buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the offset, in bits.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ANCESTOR_OFFSET_X

Inquires the X-offset relative to the ancestor buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the X-offset.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ANCESTOR_OFFSET_Y

Inquires the Y-offset relative to the ancestor buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the Y-offset.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ASSOCIATED_LUT

Inquires the identifier of the LUT buffer associated with the image buffer (returns M_DEFAULT if no LUT). SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DEFAULT

Specifies that no LUT buffer is associated with the image buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize MIL LUT buffer identifier

Specifies the MIL identifier of the LUT buffer that is associated with the image buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_BITMAPINFO
[This is only applicable to Windows]

Inquires a pointer (LPBITMAPINFO) to the header of the DIB associated with the MIL buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that there is no DIB associated with the MIL buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the pointer to the DIB header.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DATA_FORMAT

Inquires the color or monochrome storage format of the buffer. This includes whether it is packed or planar format. Note that to retrieve the entire list of attributes, use MbufInquire() with M_EXTENDED_ATTRIBUTE or M_EXTENDED_FORMAT. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v w
U53
y
U75
z aa
Click to summarize M_PACKED +

Specifies that the buffer's bands are stored in packed format (color buffer only); that is, the pixel components are stored together (RGB RGB RGB...). INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PLANAR +

This value can have multiple meanings, as indicated below.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
//Initially, if a color buffer was allocated at the same time as its memory

Specifies that the buffer's bands are stored in planar format (color buffer only); that is, each pixel is stored as three component planes (RRR... GGG... BBB...). INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
//Initially, if a color buffer was created from preallocated memory

Specifies that the buffer's bands are stored in planar format (color buffer only); that is, each pixel is stored as three component planes (RRR... GGG... BBB...). INFO

a g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Click to summarize M_DATA_TYPE

Inquires the buffer data type. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_FLOAT

Specifies that the buffer uses the float data type.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SIGNED

Specifies that the buffer uses the signed data type.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_UNSIGNED

Specifies that the buffer uses the unsigned data type.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DC_HANDLE
[This is only applicable to Windows]

Inquires the device context handle (HDC) of the buffer. The buffer device context must have been successfully allocated using MbufControl() with M_DC_ALLOC.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that no device context is associated with the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the handle of the device context that is associated with the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DIB_HANDLE
[This is only applicable to Windows]

Inquires the handle (HBITMAP) of the DIB associated with the MIL buffer. To ensure that the buffer has a DIB handle, the buffer must have been successfully allocated using with M_DIB + M_GDI.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that no DIB handle is associated with the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the handle of the DIB associated with the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_EXTENDED_ATTRIBUTE

Inquires the attributes of the specified buffer. This inquire type only returns attributes that were explicitly set; any attribute left to its default is not returned.

To retrieve only the color or monochrome storage format of the buffer, use MbufInquire() with M_DATA_FORMAT. To retrieve the actual format of the specified buffer, use MbufInquire() with M_EXTENDED_FORMAT.

Note that you cannot set the UserVarPtr parameter to M_NULL when InquireType is set to M_EXTENDED_ATTRIBUTE. In addition, a valid MIL_INT64 pointer must be passed to the function; otherwise, an error will occur.

To convert the returned attributes, select the Benchmarks and Utilities item in the tree structure of the MILConfig utility. Then, select the Buffer format item. On the Value type pane, paste the returned attributes in the text box provided. Then, click on the Value lookup button. The results of the translation are presented below the Value lookup button. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ARRAY +

Specifies a buffer to store array type data. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_IMAGE +

Specifies a buffer to store image data.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_KERNEL +
//For 1D or 2D data

Specifies a kernel buffer to store a custom filter for convolution functions. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_LUT +

Specifies a buffer to store lookup table data. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_STRUCT_ELEMENT +
//For 1D or 2D data

Specifies a buffer to store structuring element data for morphology functions. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_EXTENDED_ATTRIBUTE_NAME +

Inquires the M_EXTENDED_ATTRIBUTE of the buffer, expressed in a human readable format.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_EXTENDED_FORMAT

Inquires the color or monochrome storage format of the specified buffer.

When you inquire M_EXTENDED_FORMAT, the returned value includes any buffer attributes that you set, any setting that was left to its default, and values that were internally calculated by MIL. To retrieve only the color or monochrome storage format of the buffer that you set, use MbufInquire() with M_DATA_FORMAT. To retrieve all the attributes of the buffer as set using MbufAlloc...() with Attribute, use MbufInquire() with M_EXTENDED_ATTRIBUTE.

You can determine generally whether the buffer is in an RGB/BGR, YUV, or monochrome storage format using the buffer's extended format with the M_IS_FORMAT_RGB_BGR, M_IS_FORMAT_YUV, or M_IS_FORMAT_MONO macro respectively.

Note that you cannot set the UserVarPtr parameter to M_NULL when InquireType is set to M_EXTENDED_FORMAT. In addition, a valid MIL_INT64 pointer must be passed to the function; otherwise, an error will occur.

Some buffer attributes are not returned when using a remote computer because they are not applicable to a remote computer. These attributes include, but are not limited to, M_LINUX_MXIMAGE, M_DIB, M_GDI, M_HOST_MEMORY, and M_VIDEO_MEMORY.

To convert the returned attributes, select the Benchmarks and Utilities item in the tree structure of the MILConfig utility. Then, select the Buffer format item. On the Value type pane, paste the returned attributes in the text box provided. Then, click on the Value lookup button. The results of the translation are presented below the Value lookup button.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
MIL system specific

Note that this inquire type only returns attributes that were explicitly set; any attribute left to its default value is not returned.

v
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ARRAY +

Specifies a buffer to store array type data. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_IMAGE +

Specifies a buffer to store image data.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_KERNEL +
//For 1D or 2D data

Specifies a kernel buffer to store a custom filter for convolution functions. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_LUT +

Specifies a buffer to store lookup table data. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_STRUCT_ELEMENT +
//For 1D or 2D data

Specifies a buffer to store structuring element data for morphology functions. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_EXTENDED_FORMAT_NAME +

Inquires the M_EXTENDED_FORMAT of the buffer, expressed in a human readable format.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_HOST_ADDRESS

Inquires the Host address of the buffer, if the buffer is visible from the Host address space and is not a planar 3-band buffer. For a planar 3-band buffer, use M_HOST_ADDRESS_BAND + n instead.

If available, this address can be used to directly access the data of a MIL buffer with the Host CPU.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of the same type as BufId MORE
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that the buffer is not visible from the Host address space or the buffer is a planar 3-band buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the Host address of the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_HOST_ADDRESS_BAND + n

Inquires the Host address for the band of the buffer identified by n, if the buffer exists the Host address space and is a planar 3-band buffer. For any other buffer, use M_HOST_ADDRESS instead.

If available, this address can be used to directly access the data of a MIL buffer with the Host CPU.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of the same type as BufId MORE
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that the buffer is not visible from the Host address space or the buffer is not a planar 3-band buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the Host address of the specified band of the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_LOCATION

Inquires whether the buffer is allocated on a local system or a DMIL remote system.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_LOCAL

Specifies that the buffer is allocated on a local system.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_REMOTE

Specifies that the buffer is allocated on a remote system.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_MAP

Inquires whether the buffer is mapped to the address space of the process.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DISABLE

Specifies that the buffer is not mapped to the memory address space of the process.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ENABLE

Specifies that the buffer is mapped to the memory address space of the process.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_MAX

Inquires the maximum pixel value possible in the buffer. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the expected maximum pixel value within the range of the buffer type. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_MIN

Inquires the minimum pixel value possible in the buffer. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the expected minimum pixel value within the range of the buffer type. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_MODIFICATION_COUNT

Inquires the current value of the modification counter of the image buffer. When the image buffer is allocated, the modification counter is initialized to a random non-zero value. The modification counter is incremented each time the image buffer is modified by a MIL function.

If the image buffer is accessed externally, for example, when using MbufCreateColor() or MbufCreate2d(), MbufControl() with M_MODIFIED must be called to indicate that the image buffer's contents have been modified. Calling this function will increment the counter.

This feature is useful for optimization. For example, you can avoid repeating certain computations (for example, analysis computations) if you know that the image buffer has not been modified. In this case, inquire the count before the first computation in the sequence of computations, and then inquire it again before repeating the same sequence. If no modifications have been made to the image buffer, you can avoid repeating the sequence unnecessarily.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the current value of the modification counter.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_MODIFICATION_HOOK

Inquires the status of the modification hook, which runs a user-defined function upon an event. These user-defined functions are initially hooked to the buffer modification event using MbufHookFunction(). SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DISABLE

Specifies that the user-defined functions should not be called. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ENABLE

Specifies that the user-defined functions should be called.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_OWNER_CONTAINER_ID

Inquires the MIL identifier of the container of which this buffer is a component.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that the buffer is not a component of a container.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize ContainerID

Specifies the identifier of the container of which this buffer is a component.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_OWNER_SYSTEM

Inquires the identifier of the system on which the buffer has been allocated. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_OWNER_SYSTEM_TYPE

Inquires the type of system on which the buffer was allocated. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SYSTEM_CLARITY_UHD_TYPE

Specifies a MIL Clarity UHD system.

u
U36
Click to summarize M_SYSTEM_GENTL_TYPE

Specifies a MIL GenTL system.

v
Click to summarize M_SYSTEM_GIGE_VISION_TYPE

Specifies a MIL GigE Vision system.

c
M10
Click to summarize M_SYSTEM_HOST_TYPE

Specifies the Host.

a
Click to summarize M_SYSTEM_IRIS_GTR_TYPE

Specifies a MIL Iris GTR system.

t
U28
Click to summarize M_SYSTEM_MORPHIS_TYPE

Specifies a MIL Morphis system.

g
Click to summarize M_SYSTEM_MORPHISQXT_TYPE

Specifies a MIL Morphis QxT system.

h
Click to summarize M_SYSTEM_ORION_HD_TYPE

Specifies a MIL Orion HD system.

i
Click to summarize M_SYSTEM_RADIENT_TYPE

Specifies a MIL Radient system.

j
Click to summarize M_SYSTEM_RADIENTCXP_TYPE

Specifies a MIL Radient eV-CXP system.

k
M10
Click to summarize M_SYSTEM_RADIENTEVCL_TYPE

Specifies a MIL Radient eV-CL system.

r
U27
aa
Click to summarize M_SYSTEM_RADIENTPRO_TYPE

Specifies a MIL Radient Pro system.

p
Click to summarize M_SYSTEM_RAPIXOCL_TYPE

Specifies a MIL Rapixo Pro CL system.

aa
Click to summarize M_SYSTEM_RAPIXOCXP_TYPE

Specifies a MIL Rapixo CXP system.

y
U75
Click to summarize M_SYSTEM_SOLIOS_TYPE

Specifies a MIL Solios system.

l m
Click to summarize M_SYSTEM_USB3_VISION_TYPE

Specifies a MIL USB3 Vision system.

o
Click to summarize M_PARENT_ID

Inquires the MIL identifier of the parent buffer. Only child buffers have a parent buffer. The parent buffer is the buffer from which the specified buffer (BufId) was defined. The parent buffer can itself have a parent buffer. If the specified buffer has no parent buffer, the identifier of the specified buffer is returned.

To establish the ancestor buffer (root buffer) of the specified buffer, use M_ANCESTOR_ID instead.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize MIL Buffer ID

Specifies the MIL identifier of the parent buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PARENT_OFFSET_BAND

Inquires the band offset relative to the parent buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the band offset.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PARENT_OFFSET_X

Inquires the X-offset relative to the parent buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the X-offset.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PARENT_OFFSET_Y

Inquires the Y-offset relative to the parent buffer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the Y-offset.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PHYSICAL_ADDRESS

Inquires the physical address of the buffer if it is not a planar 3-band buffer. For a planar 3-band buffer, you can determine its physical address by allocating a child buffer for the required band and then using M_PHYSICAL_ADDRESS to determine its physical address.

This type of address is available only for a non-paged buffer mapped to the Host or for a buffer allocated in a frame grabber's on-board memory. This type of address is used mostly for access by bus masters other than the Host CPU.

To use this inquire type, the buffer must not have been allocated on a DMIL remote system. If it is, use M_PHYSICAL_ADDRESS_REMOTE instead.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that the buffer is not visible from the physical address space.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the address of the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PHYSICAL_ADDRESS_REMOTE

Inquires the physical address of the buffer on a DMIL remote system, if it is not a planar 3-band buffer. For a planar 3-band buffer, you can determine its physical address by allocating a child buffer for the required band and then using M_PHYSICAL_ADDRESS_REMOTE to determine its physical address.

This type of address is available only for a non-paged buffer mapped to the DMIL remote system. This type of address is used mostly for access by bus masters other than the Host CPU.

To use this inquire type, the buffer must have been allocated on a DMIL remote system. If it is not, use M_PHYSICAL_ADDRESS instead.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that the buffer is not visible from the physical address space.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the address of the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PITCH

Inquires the number of pixels between the beginnings of any two adjacent lines of the buffer data. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the pitch, in pixels.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_PITCH_BYTE

Inquires the number of bytes between the beginnings of any two adjacent lines of the buffer data. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the pitch, in bytes.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SIZE_BAND

Inquires the number of buffer color bands. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize 1

Specifies the buffer has one band.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize 2

Specifies the buffer has two bands.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize 3

Specifies the buffer has three bands.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SIZE_BIT

Inquires the depth per band. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the depth per band, in bits.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SIZE_X

Inquires the width of the buffer. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the width of the buffer, in pixels.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SIZE_Y

Inquires the height of the buffer. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the height of the buffer, in pixels.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SYSTEM_LOCATION

Inquires whether the specified buffer is allocated on a system on the master computer or the remote computer.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_LOCAL

Specifies that the buffer is allocated on a system on the master computer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_REMOTE

Specifies that the buffer is allocated on a system on the remote computer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_TYPE

Inquires the buffer data type and depth. Depth is returned in bits. SET SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_FLOAT + Depth value

Specifies the data depth and that the data type is floating-point.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_SIGNED + Depth value

Specifies the data depth and that the data type is signed.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_UNSIGNED + Depth value

Specifies the data depth and that the data type is unsigned.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_XPIXMAP_HANDLE
[This is only applicable to Linux]

Inquires the device context of the X11 pixmap of the buffer. The buffer device context must have been successfully allocated using MbufControl() with M_XPIXMAP_ALLOC.

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_NULL

Specifies that no device context is associated with the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize Value

Specifies the handle of the device context that is associated with the buffer.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_YCBCR_RANGE

Inquires whether pixel values are limited to a signal's YCbCr range. SET

(summarize)
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
MIL system specific

When grabbing into the specified buffer from a source that transmits in a YCbCr format (for example, an SDI source), the data is not converted to match the encoding that you specify. Instead, this control type is automatically changed to match the encoding of the grabbed data.

i u
U36
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_DISABLE

Specifies not to encode the YUV buffer's pixel values in YCbCr.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_YCBCR_HD

Specifies to encode the YUV buffer's pixel values using the high-definition YCbCr standard.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_YCBCR_SD

Specifies to encode the YUV buffer's pixel values using the standard-definition YCbCr standard.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_YCBCR_UHD

Specifies to encode the YUV buffer's pixel values using the ultra-high-definition YCbCr standard.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Combination values for M_ARRAY (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_ARRAY); M_ARRAY (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_ARRAY); M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE); M_KERNEL (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_KERNEL); M_KERNEL (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_KERNEL); M_LUT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_LUT); M_LUT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_LUT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_STRUCT_ELEMENT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_STRUCT_ELEMENT).

One of the following values might be combined with the above-mentioned values to determine the location of the buffer.

function map Returns the location of the buffer
Click to summarize
Combination value
Description MIL system-specific
tooltip (‡)
Click to summarize M_HOST_MEMORY +

Specifies that the buffer is in Host memory.

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_MAPPABLE

Specifies that the buffer is in non-paged memory. INFO

a c
M10
g h j k
M10
l m o p r
U27
t
U28
v y
U75
aa
Click to summarize M_OFF_BOARD

Specifies that the buffer is not in on-board memory. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Click to summarize M_ON_BOARD +

Specifies that the buffer is in on-board memory. INFO

g h i j k
M10
l m p r
U27
t
U28
u
U36
y
U75
aa
Click to summarize M_VIDEO_MEMORY

Specifies that the buffer is in (off-screen) display memory of your graphics controller. INFO

a c
M10
g h i j k
M10
l m o p r
U27
t
U28
u
U36
v y
U75
aa
Combination values for M_ARRAY (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_ARRAY); M_ARRAY (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_ARRAY); M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE); M_KERNEL (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_KERNEL); M_KERNEL (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_KERNEL); M_LUT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_LUT); M_LUT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_LUT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_STRUCT_ELEMENT); M_STRUCT_ELEMENT (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_STRUCT_ELEMENT).

One of the following values might be combined with the above-mentioned values to determine whether the buffer was allocated in paged or non-paged memory.

function map Returns whether the buffer was allocated in paged or non-paged memory
Click to summarize
Combination value
Description
Click to summarize M_NON_PAGED

Specifies that the buffer is in MIL reserved, non-pageable memory.

Click to summarize M_PAGED

Specifies that the buffer is in pageable memory.

For M_KERNEL and M_STRUCT_ELEMENT data buffers only (see MbufControl() for possible values), you can set the InquireType parameter to one of the following values.

function map For M_KERNEL and M_STRUCT_ELEMENT data buffers
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_OFFSET_CENTER_X

Inquires the X-coordinate of the center of the kernel or structuring element. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize 0 <= Value < SizeX

Specifies the value of the X-coordinate.

Click to summarize M_OFFSET_CENTER_Y

Inquires the Y-coordinate of the center of the kernel or structuring element. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize 0 <= Value < SizeY

Specifies the value of the Y-coordinate.

Click to summarize M_OVERSCAN

Inquires the overscan type. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DEFAULT

Specifies that MIL automatically selects the type of overscan to optimize speed and logic according to the specified operation and the target system.

Click to summarize M_DISABLE

Specifies that no overscan will be used, unless processing the border pixels is faster than ignoring them; in the latter case, MIL automatically selects the overscan to optimize speed according to the specified operation and the target system.

Click to summarize M_FAST

Specifies that MIL automatically selects the overscan to optimize speed according to the specified neighborhood operation and the target system. INFO

Click to summarize M_MIRROR

Specifies a type of overscan that processes the border pixels of a source image using overscan pixel values that mirror the source buffer pixel values. INFO

Click to summarize M_REPLACE

Specifies a type of overscan that processes the border pixels of a source image using overscan pixel values set to the overscan replacement value (M_OVERSCAN_REPLACE_VALUE).

Click to summarize M_REPLICATE

Specifies a type of overscan that processes the border pixels of a source image using overscan pixel values that replicate the border pixels. INFO

Click to summarize M_TRANSPARENT

Specifies a type of overscan that processes the border pixels of a source image using transparent overscan pixel values. INFO

Click to summarize M_OVERSCAN_REPLACE_VALUE

Inquires the replacement value for the overscan pixel values. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_REPLACE_MAX

Specifies that the overscan neighborhood pixel values will be set to the maximum value of the source buffer.

Click to summarize M_REPLACE_MIN

Specifies that the overscan neighborhood pixel values will be set to the minimum value of the source buffer.

Click to summarize Value

Specifies the value of the overscan neighborhood pixels.

Click to summarize M_SATURATION

Inquires whether results are saturated. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

Specifies not to saturate results, except when MIL can take advantage of optimization routines to accelerate the processing. INFO

Click to summarize M_ENABLE

Specifies to saturate results. INFO

For M_KERNEL data buffers only (see MbufControl() for possible values), you can set the InquireType parameter to one of the following values.

function map For M_KERNEL data buffers only
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_ABSOLUTE_VALUE

Inquires whether the absolute value should be taken. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

Specifies not to take the absolute value of the result.

Click to summarize M_ENABLE

Specifies to take the absolute value of the result. INFO

Click to summarize M_NORMALIZATION_FACTOR

Inquires the normalization factor. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value > 0

Specifies the normalization factor. INFO

For M_STRUCT_ELEMENT data buffers only, you can set the InquireType parameter to one of the following values.

function map For M_STRUCT_ELEMENT data buffers only
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_NUMBER_OF_ELEMENT_VALUES_VALID

Inquires the number of valid structuring element values in the structuring element. This is the number of values that were not set to M_DONT_CARE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the number of valid structuring element values.

For M_IMAGE data buffers only, you can set the InquireType parameter to one of the following values.

function map For M_IMAGE data buffers only
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_PFNC_NAME +

Inquires the name of the buffer's pixel format, as defined by the GenICam Pixel Format Naming Convention.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_PFNC_SIZE_BIT

Inquires the number of bits per pixel, as per the GenICam Pixel Format Naming Convention.

Note that this is the total number of bits used to store each pixel across all bands. For example, if the buffer has 3 8-bit bands that store RGB information, this value will be 24.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value

Specifies the number of bit per pixel as per the PFNC.

Click to summarize M_PFNC_SUPPORT

Inquires whether MIL supports processing the buffer's given it's pixel format. Note that this setting will only return M_NO if M_PFNC_VALUE was set to an unsupported value during a grab.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_NO

Specifies that image processing is not supported for the buffer's pixel format. An error will be generated when you attempt to use a MIL processing function with the buffer.

(summarize)
Click to summarize M_WITH_COMPENSATION

Specifies that MIL will process the buffer by copying its data to a temporary buffer with a supported pixel format.

Click to summarize M_YES

Specifies that the buffer will be processed as normal.

Click to summarize M_PFNC_VALUE

Inquires the pixel format of the buffer, as defined by the GenICam Pixel Format Naming Convention. This value is either set by the digitizer when grabbing into the buffer, or is determined based on the M_COMPONENT_TYPE of the buffer and the attributes specified when the buffer was allocated.

If this value is determined from the attributes of the buffer, and there is no ratified format in the PFNC corresponding to those attributes, the value will be 0.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize PFNCvalue

Specifies the pixel format of the buffer using a value from PFNC (as defined in pfnc.h).

(summarize)
Click to summarize M_REGION_ACTIVE

Inquires whether the image buffer has an active ROI. The ROI associated with a buffer is active when the buffer has M_REGION_USE set to M_USE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the image buffer does not have an active ROI.

Click to summarize M_TRUE

Specifies that the image buffer has an active ROI.

Click to summarize M_REGION_LINK

Inquires whether the image buffer is a child buffer with an ROI linked to that of its parent. A child buffer's ROI is linked by default, or using MbufSetRegion() with M_LINK_TO_PARENT.

Note, it is possible for the ROI of the child buffer to be linked even if there is no ROI currently defined for the parent buffer. In this case, setting the ROI for the parent buffer will automatically set the ROI for the child buffer.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_LINK_TO_PARENT

Specifies that the image buffer is a child buffer with an ROI linked to that of its parent.

Click to summarize M_NONE

Specifies that the image buffer is not a child buffer, or that its ROI is not linked to that of its parent.

Click to summarize M_REGION_TYPE

Inquires whether the image buffer is associated with ROI information, and, if so, in which format the ROI is saved. ROIs are set with MbufSetRegion().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_NONE

Specifies that no ROI is defined.

Click to summarize M_RASTER

Specifies that the ROI is in raster format.

Click to summarize M_VECTOR

Specifies that the ROI is in vector format.

Click to summarize M_VECTOR_AND_RASTER

Specifies that the ROI is in raster and vector format.

Click to summarize M_REGION_USE

Inquires whether the ROI associated with the buffer is used with supported image processing operations.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_IGNORE

Specifies that image processing functions will ignore the ROI associated with the buffer.

Click to summarize M_USE

Specifies that image processing functions will use the ROI associated with the buffer.

Click to summarize M_RESOLUTION_X

Inquires the X resolution of the image buffer in pixels per inch (PPI). If M_RESOLUTION_X in MbufControl() is not set, the inquire returns 0. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value > 0.0

Specifies the X resolution in PPI.

Click to summarize M_RESOLUTION_Y

Inquires the Y resolution of the image buffer in pixels per inch (PPI). If M_RESOLUTION_Y in MbufControl() is not set, the inquire returns 0. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value > 0.0

Specifies the Y resolution in PPI.

Combination values for M_IMAGE (when InquireType=M_EXTENDED_ATTRIBUTE and UserVarPtr=M_IMAGE); M_IMAGE (when InquireType=M_EXTENDED_FORMAT and UserVarPtr=M_IMAGE).

One or more of the following values are combined with the above-mentioned values to determine the intended purpose of the buffer.

function map Returns the intended purpose of the image buffer
Click to summarize
Combination value
Description
Click to summarize M_COMPRESS +

Specifies an image buffer that can hold compressed data. INFO

Click to summarize M_DISP

Specifies an image buffer that can be displayed.

Click to summarize M_GRAB

Specifies an image buffer in which to grab data. INFO

Click to summarize M_PROC +

Specifies an image buffer that can be processed. INFO

Combination values for M_COMPRESS.

One of the following values might be combined with the above-mentioned value to determine the compression type.

function map Returns the compression type
Click to summarize
Combination value
Description
Click to summarize M_JPEG2000_LOSSLESS

Specifies that the buffer will be used to hold JPEG2000 lossless data. INFO

Click to summarize M_JPEG2000_LOSSY

Specifies that the buffer will be used to hold JPEG2000 lossy data. INFO

Click to summarize M_JPEG_LOSSLESS

Specifies that the buffer will be used to hold JPEG lossless data. INFO

Click to summarize M_JPEG_LOSSLESS_INTERLACED

Specifies that the buffer will be used to hold JPEG lossless data in separate fields. INFO

Click to summarize M_JPEG_LOSSY

Specifies that the buffer will be used to hold JPEG lossy data. INFO

Click to summarize