RenderRegionSetDisplayType

Introduced

v6.0

Description

Changes the display type of the render region contents in the specified viewport(s). The region contents are full-colour RGBA with an alpha channel. This command can be used to show only specific channels, only the RGB data or the RGB data composited on top of the viewport using the alpha channel as a mask.

Note: If all viewports are specified, this command changes also the global settings and preferences for the display type. Any future render regions will display their contents using the new setting.

This command replaces the obsolete commands SetRGB, ToggleAlphaCompose, and ToggleAlphaOnly.

Scripting Syntax

RenderRegionSetDisplayType( [Viewport], [Type] );

Parameters

Parameter Type Description
Viewport siViewport The viewport(s) containing the render region with the display type to change.

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

Type siRenderRegionDisplayType The display type to use for the render region.

Default Value: siRenderRegionDisplayRGBA

Examples

JScript Example

// Creates a render region in viewport B (perspective view) and and sets it 

// to display only the red channel.

RenderRegionCreate( siViewportB );

RenderRegionSetDisplayType( siViewportB, siRenderRegionDisplayRed );

See Also

RenderRegionCreate RenderRegionClose RenderRegionToggleVisibility RenderRegionRefresh RenderRegionToggleSelectionTracking RenderRegionSave RenderRegionSetRefreshMode RenderRegionSetRenderChannel