MgraAlloc

See also

User Guide:

2D graphics context 2D graphics list Image statistics Masking the model Steps to performing annotations Using child buffers, ROIs, or a copy to manipulate specific data areas Working with real-world units

Reference:

MgraControl MgraFree MgraInquire 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

- ContextGraIdPtr

Return value

Compilation information

Synopsis

Allocate a 2D graphics context.

Syntax

MIL_ID MgraAlloc(

MIL_ID SysId,	//in
MIL_ID *ContextGraIdPtr	//out

)

Description

This function allocates a 2D graphics context on the specified system. A 2D graphics context is required to use MIL graphics to perform annotations. Whenever an annotation is done, 2D graphics context settings are inherited by the graphics. Different contexts can coexist; use their identifier to specify which to use or change. When a 2D graphics context is no longer required, you should release its memory, using MgraFree().

To modify or inquire 2D graphics context settings, use MgraControl() and MgraInquire().

Note that, upon allocation of an application, a default 2D graphics context is automatically allocated. Rather than using MgraAlloc() to allocate a 2D graphics context, you can use this default 2D graphics context, by specifying M_DEFAULT wherever a 2D graphics context identifier is required. Note that there is a different default 2D graphics context for each thread.

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 INQ

Specifies the system on which to allocate the 2D graphics context.

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().

ContextGraIdPtr

Specifies the address of the variable in which the 2D graphics context identifier is to be written. Since MgraAlloc() also returns the buffer 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 2D graphics context identifier if the allocation is successful. If allocation fails, M_NULL is returned.

Compilation information

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