CreateRenderChannel

Introduced

v6.0

Description

Creates a new RenderChannel. A render channel is a container for renderable image data. Render channels can be viewed in the render region and output with pass rendering by creating a Framebuffer object from it on a pass.

New render channels are added to the SceneRenderProperty property which can be found under the pass container.

Scripting Syntax

oString = CreateRenderChannel( Name, [Type] );

Return Value

Returns a String containing the name of the newly created render channel.

Parameters

Parameter Type Description
Name String Name of the new channel. It should begin with a letter and contain only letters, numbers and the underscore character. Any characters not conforming to this rule are converted to underscores ("_").

The converted name is returned by the command, if successful.
Type siRenderChannelType The image channel type to use for the new render channel.

Default Value: siRenderChannelColorType

See Also

RenderChannel SceneRenderProperty CreateFramebuffer RemoveRenderChannel