M3ddispAlloc

See also

User Guide:

3D reconstruction using laser line profiling overview Basic concepts for 3D processing and analysis Steps to display 3D data Working with 3D

Reference:

M3ddispFree 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)

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 Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

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

Fully supported on Matrox Solios eA/XA (l)

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

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

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

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

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

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

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

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

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

* 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

- SysId

Table:

For specifying the system

- DispNum

- DispFormat

- InitFlag

- Disp3dIdPtr

Return value

Compilation information

Synopsis

Allocate a 3D display.

Syntax

MIL_ID M3ddispAlloc(

MIL_ID SysId,	//in
MIL_INT64 DispNum,	//in
MIL_CONST_TEXT_PTR DispFormat,	//in
MIL_INT64 InitFlag,	//in
MIL_ID *Disp3dIdPtr	//out

)

Description

This function allocates a 3D display on the specified system so that it can be used by subsequent MIL 3D display functions.

There are additional hardware requirements to use MIL 3D displays. For more information, see the Hardware requirements subsection of the Requirements to run MIL section of Chapter 1: Introduction.

When a 3D display is no longer required, you should free it, using M3ddispFree().

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

SysId

Specifies the system on which to allocate the 3D display. This parameter should be set to one of the following values:

For specifying the 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().

DispNum

Reserved for future expansion and must be set to M_DEFAULT.

DispFormat

Reserved for future expansion and must be set to MIL_TEXT("M_DEFAULT").

InitFlag

Reserved for future expansion and must be set to M_DEFAULT.

Disp3dIdPtr

Specifies the address of the variable in which to write the 3D display identifier. Since the M3ddispAlloc() function also returns the display 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 3D display identifier if the allocation is successful. If allocation fails, M_NULL is returned.

Compilation information

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