Scripting: RenderRegionSetRefreshMode

RenderRegionSetRefreshMode

Introduced

vSupernova-QFE

Description

Sets which refresh mode should be used in the render region for the specified viewport(s). When the refresh mode is set to the interactive mode, the render region will re-render its contents upon any render-relevant change in the scene. When the refresh mode is set to camera, time and region state mode, it only obeys explicit refresh requests or changes to the camera, to the time or to the region state. Finally, when the refresh mode is set to the manual mode, it only obeys explicit refresh requests.

Note: Changing the refresh mode of all regions will also change the global default and preferences.

This command replaces the obsolete command RenderRegionToggleAutoRefresh.

Scripting Syntax

RenderRegionSetRefreshMode( [Viewport], [RefreshMode] );

Parameters

Parameter	Type	Description
Viewport	siViewport	The viewport(s) containing the render region with the refresh mode to toggle. Default Value: siViewportAll
RefreshMode	siRenderRegionRefreshMode	The render region refresh mode to be used. Default Value: siRenderRegionRefreshModeInteractive (re-render upon any render-relevant change in the scene)

Examples

JScript Example

// Sets the refresh mode of the render region in the viewport A (the top view) to the manual mode.
RenderRegionSetRefreshMode( siViewportA, siRenderRegionRefreshModeManual );