Back to Aurora Vision Library website

You are here: Start » Function Reference » Debug Preview » SetViewImage

SetViewImage


Header: AVL.h
Namespace: avl::DebugPreview
Module: FoundationLite

Sets an image to be previewed in the debug preview window.

Syntax

bool avl::DebugPreview::SetViewImage
(
	avl::DebugPreview::ViewHandle view,
	const avl::Image& image
)

Parameters

Name Type Default Description
view DebugPreview::ViewHandle Handle of a preview to set the image to.
image const Image& Image data to be previewed.

Description

This function sets the image data to the image preview window. Only one image can be set to a single preview window, calling this function multiple times for a single preview (e.g. over multiple program iterations) will override the previously set image data. When a new image with the same dimensions is set the zoom state of the preview is not changed, when the image size is changed the preview zoom state might be adjusted to accommodate the change.

The view argument must provide a handle to the preview created with the CreateView function.

Return value

The function returns true when the specified preview window is still active and the new image is displayed in the preview. The function will return false when the preview window associated with the handle has been manually closed by the user and the window is not active anymore.

See Also

  • CreateView – Creates a new floating window for a 2D image based data preview.