Back to Aurora Vision Library Lite website

You are here: Start » Debug Preview » DebugPreviewShowNewRegion

DebugPreviewShowNewRegion


Header: AVL.h
Namespace: avl

Creates a new separated window and shows a region in it.

Applications: This function is for development purpose only and requires Library Professional license.

Syntax

void avl::DebugPreviewShowNewRegion
(
	const Region& inRegion,
	const wchar_t* inWindowName,
	int inPosX,
	int inPosY
)

Parameters

Name Type Default Description
Input value
 inRegion const Region& Region to preview.
Input value
 inWindowName const wchar_t* "Region Preview" Name of newly opened window.
Input value
 inPosX int Windows default X coordinate of initial windows position.
Input value
 inPosY int Windows default Y coordinate of initial windows position.

Description

This function helps in debugging of Aurora Vision Library based applications by providing a quick but primitive way to preview internal application image-oriented data in floating windows.

Calling this function will create a new preview window with size fitted to the specified region. Such window is shown with the specified region but without returning any reference or handle. The new windows will remain active until it is closed by the user or by DebugPreviewCloseAllWindows function call. An application can call this function multiple times to open multiple windows as long as the limit of 32 simultaneously active windows is not exceeded.

This function creates a background thread with message pump (single thread shared by all windows in the debug preview subsystem) that will stay active till application close (even when no more windows are active). To explicitly close the debug preview subsystem and free its resources call DebugPreviewCloseAllWindows function.

Leaving the start position set to its default value (-1x-1) will automatically arrange windows, starting from top left corner of the screen.

See Also