Back to Aurora Vision Library website
You are here: Start » Function Reference » Debug Preview » ClearViewPrimitive
ClearViewPrimitive
Header: | AVL.h |
---|---|
Namespace: | avl::DebugPreview |
Module: | FoundationLite |
Clears a primitive slot in the floating window preview.
Syntax
void avl::DebugPreview::ClearViewPrimitive ( avl::DebugPreview::ViewHandle view, int primitiveIndex )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
view | DebugPreview::ViewHandle | Handle of a preview to alter. | ||
primitiveIndex | int | Slot index to clear. |
Description
This function removes a primitive from the debug preview, previously set by the SetViewPrimitive or SetView3DPrimitive functions.
This function will not fail if the primitive with the specified index was not set or was already removed, or when the user already manually closed the preview window.
See Also
- SetViewPrimitive – Sets a 2D primitive into an image debug preview window.
- SetView3DPrimitive – Sets a 3D primitive into a debug preview window.