MbufAllocContainer

See also

User Guide:

3D containers overview Basic concepts for 3D processing and analysis Cameras and video sources Child containers Grabbing from 3D sensors overview Preparing a container for display or processing Steps to display 3D data Steps to grab from compliant 3D sensors Working with 3D Working with compliant cameras Working with non-compliant cameras

Reference:

MappGetError MbufAllocComponent MbufFree MbufInquireContainer MsysAlloc

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Partially supported on:

Partially supported on Matrox Morphis (g)

Partially supported on Matrox Morphis QxT (h)

Partially supported on Matrox Orion HD (i)

Partially supported on Matrox Radient eCL (j)

Partially supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Partially supported on Matrox Solios eA/XA (l)

Partially supported on Matrox Solios ecl/xcl/ev-cl (m)

Partially supported on Matrox RadientPro-CL (Update 7) (p)

Partially supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Partially supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Partially supported on Matrox Clarity UHD (Update 36 or 76) (u)

Partially supported on Matrox GenTL driver (Update 34) (v)

Partially supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Partially supported on Matrox Rapixo CL Pro (Update 96) (aa)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

Function Map

- SystemId

Table:

For specifying the MIL system

- Attribute

Table:

For specifying the container usage

- ControlFlag

- ContainerBufIdPtr

Return value

Compilation information

Synopsis

Allocate a container.

Syntax

MIL_ID MbufAllocContainer(

MIL_ID SystemId,	//in
MIL_INT64 Attribute,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContainerBufIdPtr	//out

)

Description

This function allocates a container on the specified system. A container is a data object that stores related buffers, referred to as the container's buffer components. By default, a container is empty. Components are automatically added to a container, when you grab into it or use it as a destination of a supported function. You can also add components to a container using MbufAllocComponent().

A buffer component can be any type of buffer that can be allocated using MbufAlloc...(). The component type indicates what type of data is stored in that component. For example, a component with the component type M_COMPONENT_INTENSITY contains an intensity map.

After allocating a container, we recommend that you check if the operation was successful, using MappGetError(), or by verifying that the container identifier returned is not M_NULL.

When a container is no longer required, release it, using MbufFree(). This will also release all components of the container.

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

SystemId INQ

Specifies the MIL system on which to allocate the container. This parameter should be set to one of the following values:

For specifying the MIL system
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

Attribute INQ

Specifies the container usage.

This attribute is one of the factors used to determine whether a container can be used for a specific purpose. This attribute will also be automatically applied to all image buffer components added to the container.

The values in the tables below can be added together to specify multiple attributes. For example, to allocate a container for both grabbing and display, specify M_GRAB + M_DISP.

For specifying the container usage
Value	Description	MIL system-specific tooltip (‡)
M_DISP	Specifies that image buffer components of the container can be displayed, and that the container can become 3D-displayable. You can inquire whether a container is currently 3D-displayable using MbufInquireContainer() with M_3D_DISPLAYABLE. (summarize) Specifies that image buffer components of the container can be displayed, and that the container can become 3D-displayable. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_GRAB	Specifies that the image buffer components of the container can be used to grab data, and that the container itself can be used to grab data.	‡	a	c U85								o
M_PROC	Specifies that image buffer components of the container can be processed, and that the container can become 3D-processable. You can inquire whether a container is currently 3D-processable using MbufInquireContainer() with M_3D_PROCESSABLE. (summarize) Specifies that image buffer components of the container can be processed, and that the container can become 3D-processable. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ContainerBufIdPtr

Specifies the address of the variable in which to write the container identifier. Since the MbufAllocContainer() function also returns the container identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

Return value

The returned value is the container identifier. If allocation fails, M_NULL is returned.

Compilation information

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