MdispSelectWindow

Board	Supported
Host System	Yes
V4L2	Yes
Clarity UHD	Yes
Concord PoE	No
GenTL	Yes
GevIQ	Yes
GigE Vision	Yes
Indio	No
Iris GTX	Yes
Radient eV-CL	Yes
Rapixo CL	Yes
Rapixo CoF	Yes
Rapixo CXP	Yes
USB3 Vision	Yes

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

Syntax

void MdispSelectWindow(
    AIL_ID            DisplayId,          //out
    AIL_ID            ImageBufId,         //in
    AIL_WINDOW_HANDLE ClientWindowHandle  //in
)

Description

This function outputs the content of the specified image buffer to the specified user-defined window, using the specified Aurora Imaging Library 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 MdispControlwith 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.

Note that, to use a display with a window created using the third-party GTK, Tkinter, or Qt frameworks, you should enable a special mode. You can enable the mode using MdispControl with M_GTK_MODE, M_TK_MODE, or M_QT_MODE, respectively. These modes prevent the display from appearing incorrectly when the window is moved or resized, while introducing a small amount of latency.

Note: This function only supports local windowed displays (MdispAlloc with M_WINDOWED and without M_REMOTE_DISPLAY). To select an image buffer to all other display types, use MdispSelect.

Parameters

DisplayId (out, AIL_ID)

Specifies the identifier of the display. The display must have been previously allocated using MdispAlloc with M_WINDOWED (and without M_REMOTE_DISPLAY).

ImageBufId (in, AIL_ID)

Specifies the image buffer to display. The image buffer must be a 1- or 3-band buffer. To be displayable, this buffer must be an image buffer that has an M_IMAGE + M_DISP attribute.

ClientWindowHandle (in, AIL_WINDOW_HANDLE)

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.