MdispSelectWindow

See also

User Guide:

Displaying an image in a user-defined window JavaScript MILweb function reference Removing a buffer from the display

Reference:

MbufAlloc2d MbufInquire MdispAlloc MdispControl MdispInquire MdispPan MdispSelect MdispZoom

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

mdispgtkview.cpp
mdispmfcview.cpp
mdispqtview.cpp
mdispwindowgtk.cpp
mdispwindowleveling.cpp
mdispwindowleveling.cs
mdispwindowleveling.vb
mdispwindowqt.cpp

Function Map

- DisplayId

- ImageBufId

- ClientWindowHandle

Type-specific versions of the function

Compilation information

Synopsis

Select an image buffer to display in a user-defined window.

Syntax

void MdispSelectWindow(

MIL_ID DisplayId,	//in
MIL_ID ImageBufId,	//in
MIL_WINDOW_HANDLE ClientWindowHandle	//in

)

Description

This function outputs the content of the specified image buffer to the specified user-defined window, using the specified MIL display.

If the specified image buffer is smaller in size than the target window size, the border outside the image is not modified. If the specified buffer is larger in size than the target window, the right and bottom portion of the buffer, the part that exceeds the window, is not displayed.

You can control the displayed area using MdispControl(), MdispPan(), or MdispZoom(). For example, you can center the selected image in the display using MdispControl() with M_CENTER_DISPLAY.

To remove an image buffer selected to the display using MdispSelectWindow(), you can use MdispSelectWindow() with M_NULL. This leaves the associated window open but leaves it blank.

This function does not support remote displays (MdispAlloc() with M_REMOTE_DISPLAY) or MILweb displays (MdispAlloc() with M_WEB).

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 display.

ImageBufId

Specifies the image buffer to display. To be displayable, this buffer must be an image buffer that has an M_IMAGE + M_DISP attribute.

Set this parameter to M_NULL to stop displaying the currently selected image buffer on the specified display.

ClientWindowHandle

Specifies the window handle of the user-defined window or child window. This window must have a window handle of type HWND or X11. For example, the Windows API functions can create a window with an HWND handle, and third-party functions (like Qt) can create an X11 window handle. If this parameter is set to zero, this function behaves like MdispSelect().

Set this parameter to M_NULL if the ImageBufId parameter is set to M_NULL.

Type-specific versions of the function

void MdispSelectWPF (MIL_ID DisplayId, MIL_ID ImageBufId, WindowsFormsHost DisplayHostingObject)

Details

Parameters

DisplayId

See DisplayId of the main function for a description.

ImageBufId

See ImageBufId of the main function for a description.

DisplayHostingObject

Specifies a System.Windows.Forms.Integration.WindowsFormsHost object that should host the MIL display. This object must have been created in a Windows Presentation Foundation (WPF) application before calling this function. If this parameter is set to null in C# or Nothing in VB .NET, this function behaves like MdispSelect().

Compilation information

Header	Include windows.h; mil.h (windows.h must be included first).
Library	Use mil.lib.
DLL	Requires mil.dll; mildisplay.dll.