MbufInquire

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

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.

Inquires the band offset relative to the ancestor buffer.

Inquires the bit offset relative to the ancestor buffer.

Inquires the X-offset relative to the ancestor buffer.

Inquires the Y-offset relative to the ancestor buffer.

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

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

Inquires the buffer data type. SET SET

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

Inquires the actual 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.

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.

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, you can determine its Host address by allocating a child buffer for the required band and then using M_HOST_ADDRESS to determine its Host address.

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

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

Inquires the maximum pixel value possible in the buffer. SET

Inquires the minimum pixel value possible in the buffer. SET

Inquires the current value of the modification counter of the image buffer. The modification counter is initialized to a number that is unique to the image buffer and is given its own unique range.

This number is incremented each time the image buffer is modified.

If the image buffer is freed, this number will not be reassigned to a new image buffer.

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.

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

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

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

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.

Inquires the band offset relative to the parent buffer.

Inquires the X-offset relative to the parent buffer.

Inquires the Y-offset relative to the parent buffer.

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.

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.

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

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

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

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

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

Inquires the number of buffer color bands. SET SET

Inquires the depth per band. SET SET

Inquires the size of the buffer.

If the buffer has an M_JPEG2000_LOSSY attribute, this value might be smaller than the requested size of the compressed buffer (M_TARGET_SIZE). This is the case if the data could be compressed into a size smaller than the target buffer.

Use M_SIZE_BYTE to establish the real size of the buffer.

Inquires the width of the buffer. SET SET

Inquires the height of the buffer. SET SET

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

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

Inquires whether or not pixel values are limited to a signal's YCBCR range. SET