Scripting: RenderRegionClose

RenderRegionClose

Introduced

v6.0

Description

Closes a render region, if one exists, in the specified viewport(s). The region releases all current render data, such that if it were to be opened again in the same viewport with no changes to the scene, it would need to re-render.

Scripting Syntax

RenderRegionClose( [Viewport] );

Parameters

Parameter	Type	Description
Viewport	siViewport	The viewport(s) containing the render region to close. Default Value: siViewportCurrent (the viewport the cursor is currently hovering over)

Examples

JScript Example

// Closes a render region in the viewport that has the current focus.
RenderRegionClose( siViewportFocussed );