| MIL 10 Reference
| Customize Help
| Save Settings

MdispControl


See also
Availability
Available in MIL-Lite with restrictions (see remarks)
Available in MIL

Available on Windows with restrictions
Available on Linux with restrictions

Partially supported on:
Partially supported on Host system
Partially supported on Matrox CronosPlus
Partially supported on Matrox GPU processing driver
Partially supported on Matrox GigE Vision driver
Partially supported on Matrox IEEE 1394 IIDC driver
Partially supported on Matrox Iris GT
Partially supported on Matrox Morphis
Partially supported on Matrox Morphis QxT
Partially supported on Matrox Orion HD
Partially supported on Matrox Radient eCL
Partially supported on Matrox Radient eV-CXP
Partially supported on Matrox Solios eA/XA
Partially supported on Matrox Solios ecl/xcl/ev-cl
Partially supported on Matrox USB3 Vision driver (requires Update 19)
Partially supported on Matrox Vio

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
Available on Matrox Supersight
function map Function map
Examples
3dmodelheightdefect.cpp
3dplanefit.cpp
advancedmeasurement.cpp
aimdpmgrading.cpp
autodetect.cpp
binarybasedcircledetection.cpp
blisterpackinspection.cpp
blobmerge.cpp
bottlecapinspection.cpp
calibratedruler.cpp
calibrationfromlist.cpp
cameralasercalibration.cpp
cameraonrobotarmcalibration.cpp
caninspection.cpp
chromasens3dpixa.cpp
circlemeasurement.cpp
circleshapefinder.cpp
codegrading.cpp
colorbasedproductidentification.cpp
colorrelativecalibration.cpp
cookiedetection.cpp
deadpixelcorrection.cpp
defectdetectionexample.cpp
dotspacing.cpp
exampleinterface.cpp
examplemanager.cpp
examplemanagerfor3d.cpp
fdkhistogrammain.cpp
findimageorientation.cpp
fixturedcoderead.cpp
fixturingusingblob.cpp
flatfieldcorrection.cpp
foodinspection_cereal.cpp
foodinspection_mango.cpp
foodinspectioncereal.cpp
foodinspectionmango.cpp
histogramdisplay.cpp
histogramequalizeadaptive.cpp
kinect.cpp
lmigocator2000.cpp
m3dmap.cpp
m3dmap.cs
m3dmap.vb
matroxgatoreye.cpp
mbead.cpp
mbead.cs
mbead.vb
mblob.cpp
mblob.cs
mblob.vb
mbufbayer.cpp
mcal.cpp
mcal.cs
mcal.vb
mcode.cpp
mcode.cs
mcode.vb
mcol.cpp
mcol.cs
mcol.vb
mdigautofocus.cpp
mdigautofocus.cs
mdigautofocus.vb
mdispgtkview.cpp
mdispmfcview.cpp
mdispoverlay.cpp
mdispoverlay.cs
mdispoverlay.vb
mdispqtview.cpp
mdispwindowleveling.cpp
mdispwindowleveling.cs
mdispwindowleveling.vb
meas2stepoverview.cpp
measoverviewexample.cpp
mechanicalpartscan.cpp
medge.cpp
medge.cs
medge.vb
mgrainteractive.cpp
mgrainteractive.cs
mgrainteractive.vb
microsoftkinect.cpp
milapplication.cs
milapplication.vb
mildisplaymanager.cpp
mimfft.cpp
mimfft.cs
mimfft.vb
mimhistogram.cpp
mimhistogram.cs
mimhistogram.vb
mimlocatepeak1d.cpp
mimlocatepeak1d.cs
mimlocatepeak1d.vb
mmeas.cpp
mmeas.cs
mmeas.vb
mmet.cpp
mmet.cs
mmet.vb
mmod.cpp
mmod.cs
mmod.vb
mmodeltracking.cpp
mmodeltracking.cs
mmodeltracking.vb
mocr.cpp
mocr.cs
mocr.vb
monitoringapplication.cpp
morphology.cpp
mpat.cpp
mpat.cs
mpat.vb
mpmenu.cpp
mpprocessing.cpp
mreg.cpp
mreg.cs
mreg.vb
mstr.cpp
mstr.cs
mstr.vb
muart.cpp
multicamera.cpp
multipledatamatrixcoderead.cpp
multiviewannotations.cpp
objectlocalization3d.cpp
objectseparation.cpp
pcbmodelmatching.cpp
pfocus.cpp
productidentificationoasis.cpp
profiledisplay.cpp
publishingapplication.cpp
registeredgoldentemplate.cpp
scriptpreprocessing.cpp
segmentationandanalysisofcells.cpp
semiocr.cpp
sickrangerc.cpp
sickrangere.cpp
stereocalibration.cpp
superresolution.cpp
utilmatchcolormap.cpp
variouscodereadings.cpp
variousdenoising.cpp
viofeaturesdemo.cpp
vioplayback.cpp
wavelettransformation.cpp
MdispAlloc
MdispFree
Synopsis
Control a MIL display setting.
Syntax
void MdispControl(
MIL_ID DisplayId, //in
MIL_INT64 ControlType, //in
MIL_DOUBLE ControlValue //in
)
Description

This function allows you to control the specified MIL display setting.

When compiling C code in 64-bit mode, MdispControl() internally calls the MIL_INT64 version of this function (MdispControlInt64()). If you need to pass floating-point values, call the MIL_DOUBLE version of this function (MdispControlDouble()).
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
DisplayId

Specifies the identifier of the target display.

ControlType

Specifies the type of display setting to control. The control types for windowed displays can control the default MIL or user-specified window of the display (MdispSelect() or MdispSelectWindow()).

See the Parameter associations section for possible values that can be specified.

ControlValue

Specifies the new value to assign to the display setting specified by the ControlType parameter.

See the Parameter associations section for possible values that can be specified.

Parameter associations

The tables below list possible values for the ControlType and ControlValue parameters.

Unless otherwise specified, the following ControlType and corresponding ControlValue parameter settings are available for all types of displays.

function map For all types of displays
CollapseControlType Description
MIL system-specific
tooltip (†)
ControlValue
Collapse M_BACKGROUND_COLOR

Sets the background color for the display. If the selected image buffer is smaller than the display or does not fill the display completely, the surrounding area will be displayed with this color. INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DEFAULT

Same as M_COLOR_WHITE.

 † a b c d e f g h i j k l m n o p q r s
Collapse
M_RGB888(
MIL_INT Red,
MIL_INT Green,
MIL_INT Blue
)

Specifies the RGB value to which the background color will be set to.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Parameters

Specifies the red component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s

Specifies the green component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s

Specifies the blue component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BLACK

Specifies the color black.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BLUE

Specifies the color blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_CYAN

Specifies the color cyan.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_RED

Specifies the color dark red.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_GRAY

Specifies the color gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_GREEN

Specifies the color green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_MAGENTA

Specifies the color magenta.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_RED

Specifies the color red.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_WHITE

Specifies the color white.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_YELLOW

Specifies the color yellow.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_OVERLAY

Sets whether MIL's overlay mechanism is enabled. This mechanism allows you to annotate displayed image buffers non-destructively. For more information on MIL's overlay buffers, see the Annotating the displayed image non-destructively section of Chapter 21: Displaying an image.

Once enabled, use MdispInquire() with the M_OVERLAY_ID inquire type to determine the MIL identifier of the overlay buffer. Note that once created, the overlay buffer is like any other image buffer. That is, you can perform operations on it as you would on a normal buffer (except for grabbing). INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DISABLE

Specifies to disable MIL's overlay mechanism.

This is the default value.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_ENABLE

Specifies to enable MIL's overlay mechanism.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_OVERLAY_CLEAR

Sets the value to which the overlay buffer associated with the display should be cleared. The buffer is cleared to the specified value immediately after this control type setting is changed.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DEFAULT

Same as M_TRANSPARENT_COLOR.

 † a b c d e f g h i j k l m n o p q r s
Collapse
M_RGB888(
MIL_INT Red,
MIL_INT Green,
MIL_INT Blue
)

Specifies the RGB value to which the display's overlay buffer will be cleared for a non 8-bit display mode.

Specifies the RGB value. The buffer must be a non 8-bit 3-band buffer.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Parameters

Specifies the red component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s

Specifies the green component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s

Specifies the blue component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BLACK

Specifies the color black.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BLUE

Specifies the color blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_CYAN

Specifies the color cyan.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_RED

Specifies the color dark red.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_GRAY

Specifies the color gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_GREEN

Specifies the color green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_MAGENTA

Specifies the color magenta.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_RED

Specifies the color red.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_WHITE

Specifies the color white.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_YELLOW

Specifies the color yellow.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_TRANSPARENT_COLOR

Specifies that the display's overlay buffer will be cleared to the transparency color. Set the transparency color with the M_TRANSPARENT_COLOR control type.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_OVERLAY_SHOW

Sets whether the display's overlay buffer is visible. INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DISABLE

Specifies that the overlay buffer is not visible. Display the image buffer selected on the display only.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_ENABLE

Specifies that the overlay buffer is visible. Annotations or other changes made to the overlay buffer in a color other than the transparency color will annotate the image selected to the display. Set the transparency color with the M_TRANSPARENT_COLOR control type.

This is the default value.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_OPAQUE

Specifies that only the overlay buffer is visible. The image buffer selected will be hidden.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_TITLE

Sets the display's title to the specified string. For windowed displays, set whether the window's title bar is visible using the M_WINDOW_TITLE_BAR control type. For auxiliary displays, the title bar is not visible but the display's title can still be inquired. If no string is specified, the window is given a default title ("MIL Display #x"). INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse
M_PTR_TO_DOUBLE(
MIL_CONST_TEXT_PTR * String
)

Casts the address of the string identifying the specified window title (or display's title), from a MIL_CONST_TEXT_PTR to a MIL_DOUBLE.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Parameters

This parameter specifies the string whose address to cast.

 † a b c d e f g h i j k l m n o p q r s
MIL_TEXT("WindowTitle") 1

Specifies the name of the window title (or display's title).
† a b c d e f g h i j k l m n o p q r s
Collapse M_TRANSPARENT_COLOR

Sets the transparency (keying) color. Pixels of the image buffer selected to the display are displayed only where the corresponding pixels of the overlay buffer are set to the transparency color. INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DEFAULT

Specifies the optimal transparency color.

 † a b c d e f g h i j k l m n o p q r s
Collapse
M_RGB888(
MIL_INT Red,
MIL_INT Green,
MIL_INT Blue
)

Specifies the RGB value to which to set the transparency color for a non 8-bit display mode.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Parameters

Specifies the red component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s

Specifies the green component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s

Specifies the blue component, as a value between 0 and 255.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BLACK

Specifies the color black.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BLUE

Specifies the color blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_CYAN

Specifies the color cyan.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_RED

Specifies the color dark red.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_GRAY

Specifies the color gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_GREEN

Specifies the color green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_MAGENTA

Specifies the color magenta.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_RED

Specifies the color red.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_WHITE

Specifies the color white.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_COLOR_YELLOW

Specifies the color yellow.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_UPDATE

Sets whether MIL should update the display. This control type can be used to temporarily disable display updates when the image buffer is being modified by more than one operation; the display can then be updated at the end of all operations. INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DISABLE

Specifies not to update the display.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_ENABLE

Specifies to update the display. Also, the display is forced to update immediately.

This is the default value.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_NOW

Specifies to force an immediate update of the display. In this case, the display is updated even if M_UPDATE is set to M_DISABLE.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_UPDATE_RATE_MAX

Sets the maximum rate at which to update the display.

To update the display only after a specific number of buffer modifications, regardless of the time lapsed, use M_UPDATE_RATE_DIVIDER instead. INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_DEFAULT

Same as M_INFINITE.

 † a b c d e f g h i j k l m n o p q r s
Collapse M_INFINITE

Specifies to perform updates as fast as possible (limited by the available bandwidth and transmission delay).

 † a b c d e f g h i j k l m n o p q r s
Collapse Value > 0

Specifies the maximum number of updates per second. Only integer values are accepted. A minimum delay of 1/ Value seconds will be respected between two consecutive updates.

(summarize)
† a b c d e f g h i j k l m n o p q r s
Collapse M_UPDATE_SYNCHRONIZATION
[This is only applicable to Windows]

Sets the update mode currently used to update the display. INQ

(summarize)
† a b c d e f g h i j k l m n o p q r s
MIL system specific

This control type allows you to serialize paint messages sent to update the display. When the display uses a user-defined window, one paint message can interrupt another. This can cause deadlock if, for example, you set up an event handler for the paint message which tries to update the image buffer selected on the display. This will cause another paint message to be called to update the display. This results in the paint message recursively calling itself, causing a deadlock. To solve this problem M_UPDATE_SYNCHRONIZATION can be set to enforce the serialization of paint messages.

Note that this value is not available for auxiliary displays.

 † a b c d e g h i j k l m n o p q r s

This control type allows you to serialize the published image data stream with your remote display.

 † f
Collapse M_DEFAULT

Specifies the default update mode.

(summarize)
† a b c d e f g h i j k l m n o p q r s
MIL system specific

The default mode corresponds to M_ASYNCHRONOUS, if the user-defined window thread is the same as the current one. Otherwise, it is M_SYNCHRONOUS.

 † a b c d e g h i j k l m n o p q r s

Same as M_ASYNCHRONOUS.

 † f
Collapse M_ASYNCHRONOUS

Specifies that the display is updated when possible.

(summarize)
† a b c d e f g h i j k l m n o p q r s
MIL system specific

The paint messages are queued and that the application's window procedure (WndProc) will update the display whenever possible. Basically, when a paint message is issued, MIL calls the Windows InvalidateRect() function. For more information on InvalidateRect(), refer to the MSDN library.

 † a b c d e g h i j k l m n o p q r s

The published image data stream to be asynchronous. The function will return immediately while internal threads are sending data to all clients that are listening for the data stream. MdispControl() using M_UPDATE_SYNCHRONIZATION with a valid display identifier will result in a call to the Remote module's RemoteSetAttribute function, with the proper parameters set.

 † f
Collapse M_SYNCHRONOUS

Specifies that the display is updated immediately.

The display is updated immediately upon reception of a paint message. Basically, when a paint message is issued, MIL calls the Windows InvalidateRect() function followed by the Windows UpdateWindow() function. For more information on InvalidateRect() and UpdateWindow(), refer to the MSDN library.

(summarize)
† a b c d e f g h i j k l m n o p q r s
MIL system specific

The published image data stream will be synchronous. The function will return only when the information is sent to all clients that are listening for the data stream. The call to MdispControl() using M_UPDATE_SYNCHRONIZATION with a valid display ID will result in a call to the Remote module's RemoteSetAttribute function, with the proper parameters set.

 † f

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

The following ControlType and corresponding ControlValue parameter settings are available for windowed, exclusive, and auxiliary displays.

function map For windowed, exclusive, and auxiliary displays
CollapseControlType Description
ControlValue
Collapse M_ASSOCIATED_GRAPHIC_LIST_ID

Sets the graphics list to associate with the display. Only one graphics list can be associated with the display at a time. If you associate a graphics list with a display that already has been associated with one, the previous graphics list is disassociated from the display and the new one is associated. INQ

(summarize)
Collapse M_NULL

Specifies that no graphics list is associated with the display.

This is the default value.

(summarize)
Collapse MIL graphics list identifier

Specifies the identifier of the graphics list to associate with the display. The graphics list must have been previously allocated using MgraAllocList(). In this case, the vector-based graphics, contained within the graphics list, will be used to annotate the display non-destructively.

By default, modifications to the graphics within the list (added, deleted, or altered graphics) will be immediately reflected in the non-destructive annotation of the display. To change this behavior, use M_UPDATE_GRAPHIC_LIST.

To release the graphics list from memory, use MgraFree(). If the associated graphics list is freed, it is automatically disassociated from the display.

(summarize)
Collapse M_CENTER_DISPLAY

Sets whether a selected image buffer will be centered in the display, both in X and Y. INQ

(summarize)
Collapse M_DEFAULT

Specifies the default value. The default value is M_ENABLE for a MIL default window and an exclusive display. The default value is M_DISABLE for a user-defined window display and an auxiliary display.

(summarize)
Collapse M_DISABLE

Specifies that the image buffer will not be centered in the display. This will overwrite the current panning offsets (MdispPan()) to (0,0).

(summarize)
Collapse M_ENABLE

Specifies that the image buffer will always be centered in the display, both in X and Y. This will offset the image buffer by ( (WindowSizeX - BufferSizeX)/2, (WindowSizeY - BufferSizeY)/2) in the window, and current panning offsets (MdispPan()) are overwritten with these values.

(summarize)
Collapse M_ONCE

Specifies to compute the panning offsets corresponding to M_ENABLE and call MdispPan() with these offsets.

Unlike M_ENABLE, this setting changes the panning offsets only once and these panning offsets will not change if an image buffer with a different size is selected to the display.

(summarize)
Collapse M_NO_TEARING

Allows you to enable the no-tearing mechanism for the selected display, if the MIL DirectX-based display service is installed. With Windows Aero (available with Windows 7 and 8), screen tearing is no longer common. In this case, display composition is completely managed by the operating system and display updates are performed without tearing. Screen tearing might still occur if you are using Windows XP or if you have disabled Windows Aero in Windows 7.

To determine if the MIL no-tearing mechanism is currently active on the specified display, use MdispInquire() with M_NO_TEARING_ACTIVE.

For more information on screen tearing, see the Screen tearing section of Chapter 21: Displaying an image. INQ

(summarize)
Operating system specific
[This is only applicable to Linux]

Under Linux, M_NO_TEARING is only supported for auxiliary displays.
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies not to use a no-tearing mechanism to update the display.
Collapse M_ENABLE

Specifies to use a no-tearing mechanism to update the display.
Collapse M_REGION_INSIDE_COLOR

Sets the color that will be used to clear the pixels that are part of a region of interest associated with the selected buffer. The pixels are cleared to the specified color immediately after this control type setting is changed. INQ

(summarize)
Collapse M_DEFAULT

Same as M_COLOR_GREEN.
Collapse
M_RGB888(
MIL_INT Red,
MIL_INT Green,
MIL_INT Blue
)

Specifies the RGB value to which the pixels that are part of a region will be cleared for a non 8-bit display mode.

Specifies the RGB value. The buffer must be a non 8-bit 3-band buffer.

(summarize)
Parameters

Specifies the red component, as a value between 0 and 255.

Specifies the green component, as a value between 0 and 255.

Specifies the blue component, as a value between 0 and 255.
Collapse M_COLOR_BLACK

Specifies the color black.
Collapse M_COLOR_BLUE

Specifies the color blue.
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.
Collapse M_COLOR_CYAN

Specifies the color cyan.
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.
Collapse M_COLOR_DARK_RED

Specifies the color dark red.
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.
Collapse M_COLOR_GRAY

Specifies the color gray.
Collapse M_COLOR_GREEN

Specifies the color green.
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.
Collapse M_COLOR_MAGENTA

Specifies the color magenta.
Collapse M_COLOR_RED

Specifies the color red.
Collapse M_COLOR_WHITE

Specifies the color white.
Collapse M_COLOR_YELLOW

Specifies the color yellow.
Collapse M_REGION_INSIDE_SHOW

Sets how to display the pixels that are part of a region of interest associated with the selected buffer, if such a region exist. INQ

(summarize)
Collapse M_DEFAULT

Same as M_TRANSPARENT.
Collapse M_OPAQUE

Specifies that pixels in the region are cleared to the color specified using M_REGION_INSIDE_COLOR.
Collapse M_TRANSPARENT

Specifies that pixels in the region are displayed as is.
Collapse M_REGION_OUTSIDE_COLOR

Sets the color that will be used to clear the pixels that are not part of a region of interest associated with the selected buffer. The pixels are cleared to the specified color immediately after this control type setting is changed. INQ

(summarize)
Collapse M_DEFAULT

Same as M_COLOR_RED.
Collapse
M_RGB888(
MIL_INT Red,
MIL_INT Green,
MIL_INT Blue
)

Specifies the RGB value to which the pixels that are part of a region will be cleared for a non 8-bit display mode.

Specifies the RGB value. The buffer must be a non 8-bit 3-band buffer.

(summarize)
Parameters

Specifies the red component, as a value between 0 and 255.

Specifies the green component, as a value between 0 and 255.

Specifies the blue component, as a value between 0 and 255.
Collapse M_COLOR_BLACK

Specifies the color black.
Collapse M_COLOR_BLUE

Specifies the color blue.
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.
Collapse M_COLOR_CYAN

Specifies the color cyan.
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.
Collapse M_COLOR_DARK_RED

Specifies the color dark red.
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.
Collapse M_COLOR_GRAY

Specifies the color gray.
Collapse M_COLOR_GREEN

Specifies the color green.
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.
Collapse M_COLOR_MAGENTA

Specifies the color magenta.
Collapse M_COLOR_RED

Specifies the color red.
Collapse M_COLOR_WHITE

Specifies the color white.
Collapse M_COLOR_YELLOW

Specifies the color yellow.
Collapse M_REGION_OUTSIDE_SHOW

Sets how to display the pixels that are not part of a region of interest associated with the selected buffer, if such a region exist. INQ

(summarize)
Collapse M_DEFAULT

Same as M_TRANSPARENT.
Collapse M_OPAQUE

Specifies that pixels outside of the region are cleared to the color specified using M_REGION_OUTSIDE_COLOR.
Collapse M_TRANSPARENT

Specifies that pixels outside of the region are displayed as is.
Collapse M_SCALE_DISPLAY

Sets whether to fill the display with the selected image buffer, while keeping the same aspect ratio. You can inquire the automatically calculated zoom factor used to scale the image, using MdispInquire() with M_ZOOM_FACTOR_X and M_ZOOM_FACTOR_Y. INQ

(summarize)
Collapse M_DISABLE

Specifies that the image will not be scaled to fit the display. Unless a zoom factor has been applied, using MdispZoom(), the image will retain its original size and aspect ratio, leaving unused portions of the display to the default background color.

This is the default value.

(summarize)
Collapse M_ENABLE

Specifies to always scale the selected image buffer to fit the display, while keeping the same aspect ratio. In this case, the image is not distorted.

This setting overrides current pannning offsets (MdispPan()), as well as the previous zoom factors (MdispZoom()).

(summarize)
Collapse M_ONCE

Specifies to compute the scale factors corresponding to M_ENABLE and call MdispZoom() with these factors.

Unlike M_ENABLE, this setting changes the scale factors only once and these scale factors will not change if an image buffer with a different size is selected to the display.

(summarize)
Collapse M_UPDATE_GRAPHIC_LIST

Sets whether MIL should update the display when modifications are made to the display's associated graphics list. To associate a graphics list to the display, use M_ASSOCIATED_GRAPHIC_LIST_ID.

With M_UPDATE_GRAPHIC_LIST, you can temporarily disable display updates (M_DISABLE) when the graphics list is being modified by multiple operations; you can then enable display updates (M_ENABLE) at the end of all operations. INQ

(summarize)
Collapse M_DISABLE

Specifies that the display is not updated when the associated graphics list is modified.
Collapse M_ENABLE

Specifies that the display is immediately updated when the associated graphics list is modified (refresh not required).

This is the default value.

(summarize)
Collapse M_UPDATE_RATE_DIVIDER

Sets after how many buffer modifications to update the display, regardless of the time lapsed. For example, if you set M_UPDATE_RATE_DIVIDER to 10, one out of every 10 buffer modifications will cause a display update. If fewer than the specified number of buffer modifications occur, the display is not updated. The display is only updated with the last buffer modification. This control type is useful when performing a continuous grab.

If the display is allocated on a DMIL remote system but displayed on the master computer, another mechanism is also available to limit the number of display updates. You can set an upper limit to the number of display updates to perform per second, using M_UPDATE_RATE_MAX. In this case, updates of modified areas of the buffer are accumulated into one update between transmissions. INQ

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.
Collapse Value

Specifies the frequency of the update.
Collapse M_VIEW_BIT_SHIFT

Sets the number of bits by which to bit-shift the pixel values of the image buffer selected to the display, when the M_VIEW_MODE control type is set to M_BIT_SHIFT. INQ

(summarize)
Collapse Value

Specifies the number of bits. This value should be set to the number of significant bits in the image buffer minus 8. For example, if a 16-bit image buffer contains data grabbed from a 10-bit digitizer, a shift of 2 should be used.

The default value is 0.

(summarize)
Collapse M_VIEW_MODE

Sets the view mode of the display. The view mode establishes how an image buffer gets remapped to the display; this is especially useful when displaying a non 8-bit image buffer. INQ

(summarize)
Collapse M_DEFAULT

Specifies the default value. The default value is M_TRANSPARENT unless the buffer selected on the display is a 1-bit buffer; when a 1-bit buffer is used, the default value is M_AUTO_SCALE.

(summarize)
Collapse M_AUTO_SCALE
[For essential MIL-Lite information, see remarks ]

Specifies to remap the pixel values to the display so that the minimum and maximum values in the image (not the full range of the image buffer) are set to 0 and 255, respectively. If the image buffer contains a single value, the displayed value is determined by linearly re-mapping the full range of the image buffer to that of the display (for example, (0 to 64K) to (0 to 255)).

(summarize)
Collapse M_BIT_SHIFT

Specifies to bit-shift the pixel values of the image buffer by the specified number of bits upon updating the display. Specify the number of bits with the M_VIEW_BIT_SHIFT control type.

(summarize)
Collapse M_MULTI_BYTES

Specifies to display each byte of the image buffer in separate display pixels. In other words, each pixel of a 16-bit image buffer will occupy two consecutive display pixels. Each pixel of a 32-bit image buffer will occupy four consecutive display pixels. This mode is only supported for 16-bit and 32-bit 1-band buffer. This mode is primarily useful when grabbing from a multi-tap camera.

(summarize)
Collapse M_TRANSPARENT

Specifies that no pixel remapping will be performed. Note that only the 8 least-significant bits of the image buffer will be displayed.

(summarize)

The following ControlType and corresponding ControlValue parameter settings are available for all windowed displays.

function map For windowed displays
CollapseControlType Description
ControlValue
Collapse M_WINDOW_ANNOTATIONS

Advises MIL whether annotations will be drawn directly to the window's device context (DC) using GDI functions.

You must disable no-tearing (MdispControl() with M_NO_TEARING) before you can enable support for direct window annotations; otherwise, an error is generated. INQ

(summarize)
Collapse M_NULL

Specifies to advise MIL that the X display connection has not been set.
Collapse Value

Specifies the pointer to the X display connection.
Collapse M_WINDOW_UPDATE_ON_PAINT
[This is only applicable to Windows]

Sets when the display will be updated. INQ

(summarize)
Collapse M_DEFAULT

Allows MIL to decide which message to receive before updating the display.
Collapse M_DISABLE

Updates the display on reception of a WM_ERASEBKGND message in Windows.
Collapse M_ENABLE

Updates the display on reception of a WM_PAINT message in Windows.

The following ControlType and corresponding ControlValue parameter settings are available for displays allocated on a DMIL remote system but displayed on the master computer.

function map For displays allocated on a DMIL remote system but displayed on the master computer
CollapseControlType Description
ControlValue
Collapse M_ASYNC_UPDATE

Sets whether to send display updates from the remote computer to the master computer in asynchronous or synchronous mode. INQ

(summarize)
Collapse M_DEFAULT

Specifies to use the default mode, which can be selected using the MILConfig utility. In MILConfig, if you select the High quality display option, the default mode is M_DISABLE; if you select the Optimized for bandwidth usage display option, the default mode is M_ENABLE.

(summarize)
Collapse M_DISABLE

Specifies to send display updates in synchronous mode. In synchronous mode, the display is updated after each modification to the displayed image buffer (or the overlay buffer), and the application waits for the data to be transferred to the display before continuing. When an image, located on a remote computer, is displayed on the master computer, the update time can significantly slow your application.

(summarize)
Collapse M_ENABLE

Specifies that data will be sent asynchronously. In asynchronous mode, the required display updates are queued using multiple internal image bufferss and the application continues once the update has been queued. This mode maximizes your bandwidth usage while minimizing processing delays. There will be a delay of 1/ M_UPDATE_RATE_MAX between two consecutive updates.

(summarize)
Collapse M_COMPRESSION_TYPE
[For essential MIL-Lite information, see remarks ]

Sets how to compress data being transmitted from the remote computer to the master computer. INQ

(summarize)
Collapse M_DEFAULT

Specifies to use the default compression type, which can be selected using the MILConfig utility. In MILConfig, if you select the High quality display option, compression is disabled (M_NULL); if you select the Optimized for bandwidth usage display option, compression is enabled and the compression type is set to M_JPEG_LOSSY.

(summarize)
Collapse M_NULL

Specifies that compression is disabled.
Collapse M_JPEG2000_LOSSLESS

Specifies that JPEG2000 lossless compression will be used. The supported data formats are: 1-band, 8- or 16-bit data. JPEG2000 compression supports much higher ratios of compression.

You might need to use this compression type, for example, when there are fine details in your image or overlay buffer. Note, however, you should avoid this compression type unless absolutely necessary since compression/decompression time is high; you should only use it when the benefits of compression outweigh the overhead associated with the compression/decompression.

(summarize)
Collapse M_JPEG2000_LOSSY

Specifies JPEG2000 lossy compression will be used. JPEG2000 compression supports much higher ratios of compression without compromising image quality.

You might need to use this compression type, for example, when there are fine details in your image or overlay buffer. Note, however, you should avoid this compression type unless absolutely necessary since compression/decompression time is high; you should only use it when the benefits of compression outweigh the overhead associated with the compression/decompression.

You can manually set the compression factor using M_Q_FACTOR.

(summarize)
Collapse M_JPEG_LOSSLESS

Specifies JPEG lossless compression will be used. The supported data formats are: 1-band, 8- or 16-bit data.

(summarize)
Collapse M_JPEG_LOSSLESS_INTERLACED

Specifies that JPEG lossless compression will be used in separate fields. The supported data formats are 1-band, 8- or 16-bit data.

(summarize)
Collapse M_JPEG_LOSSY

Specifies that JPEG lossy compression willl be used.

You can manually set the compression factor using M_Q_FACTOR.

(summarize)
Collapse M_JPEG_LOSSY_INTERLACED

Specifies that JPEG lossy compression will be used in separate fields.

You can manually set the compression factor using M_Q_FACTOR.

(summarize)
Collapse M_Q_FACTOR
[For essential MIL-Lite information, see remarks ]

Sets the quantization factor. This control type is only applied when lossy compression is used.

The Q factor is applied to all bands. INQ

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 80.
Collapse 1 <= Value <= 99

Specifies the quantization factor. Only integer values are accepted. The higher the factor, the more the compression, but the lower the image quality.

(summarize)

Unless otherwise specified, the following ControlType and corresponding ControlValue parameter settings are only available for windowed displays (selected using MdispSelect() for MIL windows or MdispSelectWindow() for user-defined windows) and exclusive displays.

function map For windowed and exclusive displays
CollapseControlType Description
ControlValue
Collapse M_GRAPHIC_LIST_INTERACTIVE

Sets whether a user can interactively modify the graphics in the graphics list associated with the display. Modifications to the graphics in the list include moving, resizing, and rotating.

The user interacts with the graphics using the mouse. Clicking on a graphic selects it, which causes the graphic to be surrounded with a selection box. The selection box has handles around it that can be dragged to resize, rotate, or move the graphic. The user can select multiple graphics by holding down the Ctrl key and clicking on each graphic. New graphics can be added to the graphics list interactively using MgraInteractive().

You can restrict the type of interactions the user can have using MgraControl() or MgraControlList(). INQ

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that the graphics list associated with the display cannot be affected by user interaction.
Collapse M_ENABLE

Specifies that the graphics list associated with the display can be affected by user interaction.
Collapse M_KEYBOARD_USE

Sets whether the user can interactively pan and zoom the display using the keyboard.

The default key usage is: INQ

+

Increases the X- and Y-zoom factors.

-

Decreases the X- and Y-zoom factors.

Page-up

Scrolls the image buffer up to the previous display section.

Page-down

Scrolls the image buffer down to the next display section.

Up arrow

Scrolls the image buffer up to the previous line.

Down arrow

Scrolls the image buffer down to the next line.

Left arrow

Scrolls the image buffer left by one pixel.

Right arrow

Scrolls the image buffer right by one pixel.

Ctrl-Up arrow

Scrolls the image buffer up to the previous display section.

Ctrl-Down arrow

Scrolls the image buffer down to the next display section.

Ctrl-Left arrow

Scrolls the image buffer left to the previous display section.

Ctrl-Right arrow

Scrolls the image buffer right to the next display section.
(summarize)
Collapse M_DEFAULT

For user-defined windowed displays, this value is the same as M_DISABLE; for MIL windowed and exclusive displays, this value is the same as M_ENABLE.
Collapse M_DISABLE

Specifies that using the keyboard to perform panning and zooming is disabled.

This is the default value for user-defined windowed displays.

(summarize)
Collapse M_ENABLE

Specifies that using the keyboard to perform panning and zooming is enabled.

This is the default value for MIL windowed and exclusive displays.

(summarize)
Collapse M_MOUSE_CURSOR_CHANGE

Sets whether the mouse cursor changes shape in a display with mouse-interaction enabled (M_MOUSE_USE). For example, if interactive panning is possible in the display, the cursor will change to a hand.

If you have enabled M_GRAPHIC_LIST_INTERACTIVE, it is not necessary to enable this setting. INQ

(summarize)
Collapse M_DEFAULT

For user-defined windowed displays, this value is the same as M_DISABLE; for MIL windowed and exclusive displays, this value is the same as M_ENABLE.
Collapse M_DISABLE

Specifies that mouse cursor change is disabled.

This is the default value for user-defined windowed displays.

(summarize)
Collapse M_ENABLE

Specifies that mouse cursor change is enabled.

This is the default value for MIL windowed and exclusive displays.

(summarize)
Collapse M_MOUSE_USE

Sets whether the user can interactively pan and zoom the display using the mouse. INQ

(summarize)
Collapse M_DEFAULT

For user-defined windowed displays, this value is the same as M_DISABLE; for MIL windowed and exclusive displays, this value is the same as M_ENABLE.
Collapse M_DISABLE

Specifies that mouse-interaction will not work inside a display.

This is the default value for user-defined windowed displays.

(summarize)
Collapse M_ENABLE

Specifies that mouse-interaction will work inside a display.

This is the default value for MIL windowed and exclusive displays.

(summarize)
Collapse M_RESTRICT_CURSOR

Sets whether to restrict the mouse cursor so that it cannot move over the exclusive display. This control type is only applicable to exclusive displays. INQ

(summarize)
Collapse M_DISABLE

Specifies to permit the mouse cursor to move over the display.
Collapse M_ENABLE

Specifies to restrict the mouse cursor so that it cannot move over the display.

This is the default value.

(summarize)

The following ControlType and corresponding ControlValue parameter settings are only available for MIL windowed displays (selected using MdispSelect()), and are not available for user windowed displays (selected using MdispSelectWindow()):

function map For MIL windowed displays
CollapseControlType Description
ControlValue
Collapse M_FULL_SCREEN

Sets whether the window should be maximized and shown without the title bar or menu (full screen mode). INQ

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that the window will not be maximized and shown with the title bar and menu.
Collapse M_ENABLE

Specifies that the window will be maximized and shown without the title bar or menu.
Collapse M_WINDOW_INITIAL_POSITION_X

Sets the initial, left-most, X-coordinate of the window. INQ

(summarize)
Collapse Value

Specifies the X-coordinate, in pixels.
Collapse M_WINDOW_INITIAL_POSITION_Y

Sets the initial, top-most, Y-coordinate of the window. INQ

(summarize)
Collapse Value

Specifies the Y-coordinate, in pixels.
Collapse M_WINDOW_MAXBUTTON
[This is only applicable to Windows]

Sets whether the window's maximize button is visible. INQ

(summarize)
Collapse M_DEFAULT

Same as M_ENABLE.
Collapse M_DISABLE

Specifies that the button is not visible.
Collapse M_ENABLE

Specifies that the button is visible.
Collapse M_WINDOW_MINBUTTON
[This is only applicable to Windows]

Sets whether the window's minimize button is visible. INQ

(summarize)
Collapse M_DEFAULT

Same as M_ENABLE.
Collapse M_DISABLE

Specifies that the button is not visible.
Collapse M_ENABLE

Specifies that the button is visible.
Collapse M_WINDOW_MOVE
[This is only applicable to Windows]

Sets whether window movement is allowed. INQ

(summarize)
Collapse M_DISABLE

Specifies not to allow window movement.
Collapse M_ENABLE

Specifies to allow window movement.

This is the default value.

(summarize)
Collapse M_WINDOW_OVERLAP
[This is only applicable to Windows]

Sets whether the window can be overlapped by another. INQ

(summarize)
Collapse M_DISABLE

Specifies not to allow the window to be overlapped by another (keep window on top).
Collapse M_ENABLE

Specifies to allow the window to be overlapped by another.

This is the default value.

(summarize)
Collapse M_WINDOW_RESIZE
[This is only applicable to Windows]

Sets whether window resizing is allowed. INQ

(summarize)
Collapse M_DISABLE

Specifies not to allow window resizing.
Collapse M_ENABLE

Specifies to allow window resizing.

This is the default value.

(summarize)
Collapse M_FULL_SIZE

Specifies to force a full-size display. Resizing is disallowed.

(summarize)
Collapse M_NORMAL_SIZE

Same as M_ENABLE.
Collapse M_WINDOW_SHOW

Sets whether the window should be shown or hidden.

(summarize)
Collapse M_DISABLE

Specifies that the window should be hidden.
Collapse M_ENABLE

Specifies that the window should be shown.

This is the default value.

(summarize)
Collapse M_WINDOW_SYSBUTTON
[This is only applicable to Windows]

Sets whether the window's system buttons are visible. The system buttons refer to the collection of the window's minimize, maximize, and close buttons.

To individually set whether the minimize and maximize buttons are visible, change the M_WINDOW_MAXBUTTON or M_WINDOW_MINBUTTON control type settings. INQ

(summarize)
Collapse M_DEFAULT

Same as M_ENABLE.
Collapse M_DISABLE

Specifies that the button is not visible.
Collapse M_ENABLE

Specifies that the button is visible.
Collapse M_WINDOW_TITLE_BAR

Sets whether the window's title bar is visible. INQ

(summarize)
Collapse M_DISABLE

Specifies that the title bar is not visible.
Collapse M_ENABLE

Specifies that the title bar is visible.

This is the default value.

(summarize)
Collapse M_WINDOW_TITLE_BAR_CHANGE

Sets whether the presence of the window's title bar can be toggled. INQ

(summarize)
Collapse M_DISABLE

Specifies not to allow toggling.
Collapse M_ENABLE

Specifies to allow toggling. Double-clicking on the image will toggle the visibility of the application window's title bar. If the title bar is present, you can also right-click on the title bar to select Title Off.

This is the default value.

(summarize)

The following ControlType and corresponding ControlValue parameter settings can be specified only when using an auxilliary display. Otherwise, an error will occur.

function map For specifying settings when using auxilliary displays
CollapseControlType Description
MIL system-specific
tooltip (†)
ControlValue
Collapse M_AUXILIARY_KEEP_DISPLAY_ALIVE

Specifies whether the auxiliary display, controlled by the board's video controller, remains active after the video controller is freed. To free the board's video controller use MdispFree(). INQ

(summarize)
† n
Collapse M_DEFAULT

Same as M_DISABLE.

 † n
Collapse M_DISABLE

Specifies that the auxiliary display should become inactive.

 † n
Collapse M_ENABLE

Specifies that the auxiliary display should remain active.

 † n
Collapse M_ENCODER_FILTER

Sets a filter for luminance. INQ

(summarize)
† n
Collapse M_DEFAULT

Same as M_LOW_PASS_0.

 † n
Collapse M_LOW_PASS_0

Specifies a low-pass filter type A.

 † n
Collapse M_LOW_PASS_1

Specifies a low-pass filter type B.

 † n
Collapse M_LOW_PASS_2

Specifies a 5.5 MHz low-pass filter.

 † n
Collapse M_ENCODER_PEDESTAL

Sets whether a pedestal is to be generated in the composite video signal. INQ

(summarize)
† n
Collapse M_DEFAULT

Same as M_ENABLE.

 † n
Collapse M_DISABLE

Specifies not to generate a pedestal in the output.

 † n
Collapse M_ENABLE

Specifies to generate a pedestal in the composite video signal.

 † n
Collapse M_SELECT_VIDEO_SOURCE

Allows you to enable low-latency pass-through mode between the acquisition section and the on-board display section for the selected digitizer. When the board is in low-latency pass-through mode, the display will ignore the selected image buffer. Furthermore, when using low-latency pass-through mode, you can use the board to simultaneously display an overlay buffer and real-time video. INQ

(summarize)
† n
Collapse M_NULL

Specifies not to use low-latency pass-through mode.

 † n
Collapse MIL digitizer identifier

Specifies the MIL identifier of the digitizer that should use low-latency pass-through mode.

 † n
Collapse M_SYNC_TYPE

Sets the type of output synchronization signal. This control type is only supported when the display format is RGB. INQ

(summarize)
† n
Collapse M_DEFAULT

Specifies the default output synchronization signal.

Same as M_GREEN.

(summarize)
† n
Collapse M_DISABLE

Specifies that the encoder output does not contain a synchronization signal.

 † n
Collapse M_GREEN

Specifies that the output synchronization signal is on green.

 † n
Collapse M_SEPARATE

Specifies that the synchronization and data signals are output on separate signals: the output synchronization signal is on pin 12, and the composite data signal is on pin 10 of the HD-44 connector.

 † n
Remarks
  • [MIL-Lite]
    MIL-Lite does not support displaying a 32-bit image buffer in a display that has its M_VIEW_MODE control type set to M_AUTO_SCALE, unless you have purchased the MIL Image Analysis license.
  • [MIL-Lite]
    Note that during development and at runtime, compression support requires the presence of a MIL license that grants access to the compression/decompression package. This access is only granted by default with the development license dongle for the full version of MIL. In other cases, you must purchase access to this package separately.
Type-specific versions of the function
void MdispControlDouble (MIL_ID DisplayId, MIL_INT64 ControlType, MIL_DOUBLE ControlValue)
Details
Parameters

DisplayId

See DisplayId of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.
void MdispControlInt64 (MIL_ID DisplayId, MIL_INT64 ControlType, MIL_INT64 ControlValue)
Details
Parameters

DisplayId

See DisplayId of the main function for a description.

ControlType

See ControlType of the main function for a description.

ControlValue

See ControlValue of the main function for a description.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll; mildisplay.dll.
BACKGROUND COLOR DEFAULT COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW OVERLAY DISABLE ENABLE OVERLAY CLEAR DEFAULT COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW TRANSPARENT COLOR OVERLAY SHOW DISABLE ENABLE OPAQUE TITLE TRANSPARENT COLOR DEFAULT COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW UPDATE DISABLE ENABLE NOW UPDATE RATE MAX DEFAULT INFINITE UPDATE SYNCHRONIZATION DEFAULT ASYNCHRONOUS SYNCHRONOUS ASSOCIATED GRAPHIC LIST ID NULL CENTER DISPLAY DEFAULT DISABLE ENABLE ONCE NO TEARING DEFAULT DISABLE ENABLE REGION INSIDE COLOR DEFAULT COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW REGION INSIDE SHOW DEFAULT OPAQUE TRANSPARENT REGION OUTSIDE COLOR DEFAULT COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW REGION OUTSIDE SHOW DEFAULT OPAQUE TRANSPARENT SCALE DISPLAY DISABLE ENABLE ONCE UPDATE GRAPHIC LIST DISABLE ENABLE UPDATE RATE DIVIDER DEFAULT VIEW BIT SHIFT VIEW MODE DEFAULT AUTO SCALE BIT SHIFT MULTI BYTES TRANSPARENT WINDOW ANNOTATIONS NULL WINDOW UPDATE ON PAINT DEFAULT DISABLE ENABLE ASYNC UPDATE DEFAULT DISABLE ENABLE COMPRESSION TYPE DEFAULT NULL JPEG2000 LOSSLESS JPEG2000 LOSSY JPEG LOSSLESS JPEG LOSSLESS INTERLACED JPEG LOSSY JPEG LOSSY INTERLACED Q FACTOR DEFAULT GRAPHIC LIST INTERACTIVE DEFAULT DISABLE ENABLE KEYBOARD USE DEFAULT DISABLE ENABLE MOUSE CURSOR CHANGE DEFAULT DISABLE ENABLE MOUSE USE DEFAULT DISABLE ENABLE RESTRICT CURSOR DISABLE ENABLE FULL SCREEN DEFAULT DISABLE ENABLE WINDOW INITIAL POSITION X WINDOW INITIAL POSITION Y WINDOW MAXBUTTON DEFAULT DISABLE ENABLE WINDOW MINBUTTON DEFAULT DISABLE ENABLE WINDOW MOVE DISABLE ENABLE WINDOW OVERLAP DISABLE ENABLE WINDOW RESIZE DISABLE ENABLE FULL SIZE NORMAL SIZE WINDOW SHOW DISABLE ENABLE WINDOW SYSBUTTON DEFAULT DISABLE ENABLE WINDOW TITLE BAR DISABLE ENABLE WINDOW TITLE BAR CHANGE DISABLE ENABLE AUXILIARY KEEP DISPLAY ALIVE DEFAULT DISABLE ENABLE ENCODER FILTER DEFAULT LOW PASS 0 LOW PASS 1 LOW PASS 2 ENCODER PEDESTAL DEFAULT DISABLE ENABLE SELECT VIDEO SOURCE NULL SYNC TYPE DEFAULT DISABLE GREEN SEPARATE WINDOWED EXCLUSIVE AUXILIARY NETWORK