ref_iface_IVDXFilterPreview_Toggle

VirtualDub Plugin SDK 1.2

IVDXFilterPreview interface

IVDXFilterPreview:: Toggle

Toggles the display of the preview window.

void Toggle(VDXHWND hwnd);

Parameters

hwnd	Owner window to use for placement of the preview window.

Thread safety

This method is not thread-safe.

Errors

Errors may not be returned from this function (see SetError()).

Remarks

If the preview window is displayed it is closed. If it is closed and preview is enabled, the preview window is opened and positioned next to the owning window.

Toggle() may be called even if preview is not enabled. In that case, the call is ignored.

The window handle for the filter's configuration dialog should be passed as the owning window. This allows the filter preview window to stay on top and to position itself appropriately.