MdispAlloc

See also

User Guide:

Allocating, displaying, and annotating an image buffer Annotating the displayed image non-destructively C/C++ MILweb function reference Controlling configuration Dealing with color Displaying an image in a user-defined window Fundamentals for creating your MILweb client application JavaScript MILweb function reference Mandatory allocations: allocating an application context and its systems Monitoring configuration Overview Types of displays Using the defaults

Reference:

MappControl MdispFree MdispSelect MobjControl 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 Host system (a)

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 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 Rapixo CXP (Update 75 or Update 84) (y)

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

Fully supported on:

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 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 GenTL driver (Update 34) (v)

* 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

3dgapandflush.cpp
3dplanarity.cpp
3dprofilemetrology.cpp
adaptivefiltering.cpp
advancedmeasurement.cpp
alphablending.cpp
autodetect.cpp
binarybasedcircledetection.cpp
blisterpackinspection.cpp
blobmerge.cpp
blobtransform.cpp
bottlecapinspection.cpp
calgenchessgrid.cpp
calibratedruler.cpp
calibrationfromlist.cpp
cameraonrobotarmcalibration.cpp
charactercreator.cpp
cielabconversion.cpp
circlemeasurement.cpp
circleshapefinder.cpp
classcnncompletetrain.cpp
classprintedchar.cpp
classseafoodinspect.cpp
classsurfacesteel.cpp
classtreeensembletrain.cpp
codedetect.cpp
codegrading.cpp
codetrain.cpp
cookiedetection.cpp
deadpixelcorrection.cpp
defectdetectionexample.cpp
depthfromfocus.cpp
depthmapgoldentemplate.cpp
dmiladdconstantmain.cpp
dmilbasic.cpp
dmilmdigprocesssharedmemory.cpp
dmilmultisystem.cpp
dmilobjecttracking.cpp
dmilremap.cpp
dmilsyncasyncmain.cpp
dotspacing.cpp
ellipseshapefinder.cpp
exampleinterface.cpp
examplemanager.cpp
extendeddepthoffield.cpp
findimageorientation.cpp
fixturedcoderead.cpp
fixturingusingblob.cpp
flatfieldcorrection.cpp
foodinspectioncereal.cpp
foodinspectionmango.cpp
gearinspection.cpp
gentl.cpp
gumpackinspection.cpp
histogramdisplay.cpp
histogramequalizeadaptive.cpp
imagedownscalingmodes.cpp
imageflattening.cpp
imageupscalingmodes.cpp
isodpmgrading.cpp
laserprofilemetrologyanalysis.cpp
m3dreg.cpp
m3dreg.cs
m3dreg.vb
mapptrace.cpp
mapptrace.cs
mapptrace.vb
mbufbayer.cpp
mbufcreate.cpp
mbufcreate.cs
mclass.cpp
mclass.cs
mclass.vb
mdiggrabmultiple.cpp
mdigprocess16vd.cpp
mdigprocessmultiple.cpp
mdispgtkview.cpp
mdispmfcview.cpp
mdispqtview.cpp
mdispweb.cpp
mdispwindowgtk.cpp
mdispwindowqt.cpp
meas2stepoverview.cpp
measoverviewexample.cpp
measuredfeaturesoverview.cpp
mechanicalpartscan.cpp
medgecustomderivatives.cpp
metrologyonblobs.cpp
mgenlutfunction.cpp
mgraweb.cpp
milapplication.cs
milapplication.vb
mildisplaymanager.cpp
milsamplegrabber.cpp
mimbinarizeadaptive.cpp
mimboundingbox.cpp
mimdeinterlace.cpp
mimdeinterlace.cs
mimdeinterlace.vb
mimiirfilter.cpp
mmoddefinemodelatangle.cpp
morphischannelswitchingdlg.cpp
morphology.cpp
mpatdefinemodelatangle.cpp
mpatfindmultiplemodels.cpp
mpmenu.cpp
mpprocessing.cpp
muart.cpp
multicamera.cpp
multicameralasercalibration.cpp
multicastmaster.cpp
multicastmonitor.cpp
multicastslave.cpp
multipledatamatrixcoderead.cpp
multiviewannotations.cpp
objectlocalization3d.cpp
objectseparation.cpp
pcbmodelmatching.cpp
photometricstereo.cpp
photometricstereowithmotion.cpp
pointconstructions.cpp
polarizationimaging.cpp
productidentificationoasis.cpp
profiledisplay.cpp
projection.cpp
rectangleshapefinder.cpp
registeredgoldentemplate.cpp
scriptpreprocessing.cpp
segmentationandanalysisofcells.cpp
semiocr.cpp
simple3dbinpicking.cpp
simpledilateerode.cpp
simplehdr.cpp
specularreflectionreduction.cpp
sphereinspection.cpp
stereocalibration.cpp
stereorectification.cpp
studinspection.cpp
superresolution.cpp
superresolutioncode.cpp
systemdetection.cpp
systemdetection.cs
systemdetection.vb
texturestatistics.cpp
tirestringread.cpp
tolerancesoverview.cpp
unwarpmultiviewcylinder.cpp
usdotnumberstr.cpp
utilmatchcolormap.cpp
variouscodereadings.cpp
variousdenoising.cpp
variousdotmatrixreadings.cpp
variousstatistics.cpp
visualizefont.cpp
wavelettransformation.cpp

Function Map

- SystemId

Table:

For specifying the system

- DispNum

Table:	For specifying the display device
Table:	For specifying the position of the device to use for an exclusive display

- DispFormat

Table:	For specifying the default display format
Table:	For exclusive displays

- InitFlag

Table:	For specifying the display type
+ combination:	For controlling where and how the display is allocated

- DisplayIdPtr

Return value

Compilation information

Synopsis

Allocate a display.

Syntax

MIL_ID MdispAlloc(

MIL_ID SystemId,	//in
MIL_INT DispNum,	//in
MIL_CONST_TEXT_PTR DispFormat,	//in
MIL_INT64 InitFlag,	//in
MIL_ID *DisplayIdPtr	//out

)

Description

This function allocates a display on the specified system so that it can be used by subsequent MIL display functions. Use MdispSelect() to select the image buffer to display. Note that the buffer and the display should be allocated on the same system.

In general, the display is presented on the computer running the main MIL application. However, if you are developing a Distributed MIL application or a MILweb server application, you can allocate a display to be shown on a remote computer.

If you are developing a Distributed MIL controlling application and you allocate a display on a DMIL remote system, you can select image buffers allocated on that DMIL remote system to the display. By default, these buffers are displayed on the master computer. However, to display the buffers on the remote computer, combine M_EXCLUSIVE or M_WINDOWED with M_REMOTE_DISPLAY when allocating the display. This type of display is referred to as a remote display.

If you are developing a MIL application that also acts as a MILweb server, you can allocate a display that can be presented in one or more instances of a MILweb client application (for example, running in a compatible web browser). To do so, use M_WEB when allocating the display. This type of display is referred to as a MILweb display.

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

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 system on which to allocate the 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 INQ

Specifies the device to use for image display.

For a non-exclusive display, or for an exclusive display that you want MIL to choose the display device, set this parameter to the following value:

For specifying the display device
Value	Description
M_DEFAULT	Specifies that MIL will use the most appropriate device for display purposes. If your imaging board has a display section, and it is available, MIL will typically use it for display purposes. (summarize) Specifies that MIL will use the most appropriate device for display purposes. (more details...)

For an exclusive display for which you want to specify the position of the display device in screen arrangements of up to 3x3 screens, this parameter can be set to a combination of the following values.

For specifying the position of the device to use for an exclusive display
Value	Description
M_BOTTOM	Specifies to use the bottom-most device for an exclusive display. Note that this option cannot be combined with M_TOP. (summarize) Specifies to use the bottom-most device for an exclusive display. (more details...)
M_CENTER	Specifies to use the center device for an exclusive display.
M_LEFT	Specifies to use the left-most device for an exclusive display. Note that this option cannot be combined with M_RIGHT. (summarize) Specifies to use the left-most device for an exclusive display. (more details...)
M_RIGHT	Specifies to use the right-most device for an exclusive display. Note that this option cannot be combined with M_LEFT. (summarize) Specifies to use the right-most device for an exclusive display. (more details...)
M_TOP	Specifies to use the top-most device for an exclusive display. Note that this option cannot be combined with M_BOTTOM. (summarize) Specifies to use the top-most device for an exclusive display. (more details...)

DispFormat INQ

Specifies the format of the display. For windowed displays, this parameter has no effect and should be set to "M_DEFAULT". For exclusive displays, this parameter specifies the screen resolution.

For any type of display, this parameter can be set to the following value:

For specifying the default display format
Value	Description
MIL_TEXT("M_DEFAULT") ¹	Specifies the default display format. For windowed displays, this is the only supported setting. For exclusive displays, this specifies the default video configuration format (VCF), which can be set during installation and later modified using the MILConfig utility (Defaults tab). (summarize) Specifies the default display format. (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

For exclusive displays, the DispFormat parameter can be set to the following:

For exclusive displays
Value	Description	MIL system-specific tooltip (‡)
M_CURRENT_RESOLUTION	Specifies to use the current resolution of the screen. This option is only available for a M_EXCLUSIVE display. (summarize) Specifies to use the current resolution of the screen. (more details...)	‡	c M10	g	h	l	m	o	v
MIL_TEXT("vcf-file-name.vcf") ¹	Specifies the name of the video configuration format (VCF) that defines the resolution and refresh rate to use. The file typically has a VCF extension. The drive, directory, and name of the file must be specified, for example: "C:\mydirectory\myfile". For a file on the remote computer (under Distributed MIL), the path and file name must be preceded by "remote:///" (for example, "remote:///C:\mydirectory\myfile"). The file name string can be specified in, for example, the "1024x768x32@60hz.vcf" format. For the current list of video configuration format (VCF) files, see the MATROX IMAGING\DRIVERS\HOST\VCF folder. (summarize) Specifies the name of the video configuration format (VCF) that defines the resolution and refresh rate to use. (more details...)	‡	c M10	g	h	l	m	o	v

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

InitFlag INQ

Specifies your display's type. This parameter can be set to one of the following:

For specifying the display type
Value	Description
M_DEFAULT	Specifies the default display type, which can be set using the MILConfig utility. Typically, the default display type is M_WINDOWED. (summarize) Specifies the default display type, which can be set using the MILConfig utility. (more details...)
M_EXCLUSIVE +	Specifies to present the image buffer selected for display full-screen, without a windowed border, in one of Windows desktop screens. The image buffer is presented at the center of the screen. Exclusive displays work with any graphic controller and are compatible with all video hardware acceleration modes. To use an exclusive display, your Windows desktop should be using more than one screen. Allocating an exclusive display on the main screen might not be convenient; if you do so, the MIL exclusive display will hide third-party applications designed to start on the main screen and hide the Windows taskbar if it is displayed the main screen. (summarize) Specifies to present the image buffer selected for display full-screen, without a windowed border, in one of Windows desktop screens. (more details...)
M_WEB	Specifies to present the image buffer selected for display in one or more instances of a MILweb client application (for example, running in a compatible web browser). To use a MILweb display, you must enable MILweb server functionality in your application using MappControl() with M_WEB_CONNECTION. You must also publish the display using MobjControl() with M_WEB_PUBLISH. A MILweb display cannot be presented by your MIL application. It can only be presented by a connected MILweb client application (running on the local computer or a remote computer). (summarize) Specifies to present the image buffer selected for display in one or more instances of a MILweb client application (for example, running in a compatible web browser). (more details...)
M_WINDOWED +	Specifies to present the image buffer selected for display in its own window on the Windows desktop screen(s). The display window is tracked and updated with the image buffer selected for display; that is, if the window moves or is occluded, the window is updated with the image buffer accordingly. (summarize) Specifies to present the image buffer selected for display in its own window on the Windows desktop screen(s). (more details...)

Combination value for M_EXCLUSIVE; M_WINDOWED.

You can add the following value to the above-mentioned values to set where and how the display is allocated.

For controlling where and how the display is allocated
Combination value	Description	MIL system-specific tooltip (‡)
M_REMOTE_DISPLAY	Specifies that the display is displayed on the remote computer in a DMIL application. This setting is only available when the display is allocated on a DMIL remote system. If the display is allocated on a DMIL remote system but this setting is not specified, the display is presented on the local computer. To present the display on the remote computer, the Distributed MIL server cannot be running as a service; you must start it manually. To do so, assuming that Distributed MIL has already been installed during the setup, you must logon to the remote computer and, from the MILConfig utility, push the Start Server button, found in the Server Settings pane under the Distributed MIL item. For more information, see the Setting up the Distributed MIL server on remote computers subsection of the Preparing computers for Distributed MIL section of Chapter 48: Distributed MIL. (summarize) Specifies that the display is displayed on the remote computer in a DMIL application. (more details...)	‡	a	c M10	g	h	j	k M10	l	m	o	p	r U27	v	y U75	aa

DisplayIdPtr

Specifies the address of the variable in which to write the display identifier. Since the MdispAlloc() 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 display 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; mildisplay.dll.