RenderRegionToggleVisibility

Introduced

v6.0

Categories

render

Description

Toggles the visibility of the region in the specified viewport(s). If a region is hidden, it saves all render data to disk (to save memory) and restores it when it gets unhidden. If the scene gets modified while the region is hidden, it will re-render once it is made visible again. While a render region is hidden, its state can still be changed such as auto-refresh, selection tracking, display mode and framebuffer to view.

Note: If all regions are toggled then, if any region is visible, they will all be hidden. Otherwise they will all be turned visible.

This command replaces the obsolete command ToggleRegionVisibility.

Scripting Syntax

RenderRegionToggleVisibility( [Viewport] );

Parameters

Parameter Type Description
Viewport siViewport The viewport(s) containing the render region to hide/show.

Default Value: siViewportCurrent (the viewport the cursor is currently hovering over)

See Also

RenderRegionCreate RenderRegionClose RenderRegionRefresh RenderRegionToggleAutoRefresh RenderRegionToggleSelectionTracking RenderRegionSave RenderRegionSetDisplayType RenderRegionSetRenderChannel