CreateFramebuffer

Introduced

6.0

Description

Creates a new Framebuffer on the given Pass(es). A framebuffer controls where, and with which file format, the contents of a RenderChannel are output.

Each render channel can be represented by multiple framebuffers.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference. However, the object output in the Value argument is also returned by the command, so for JScript, PerlScript and Python, please use the return value only. For C#, you can use the XSIApplication.ExecuteCommand to run the command, passing null for the third argument.

Scripting Syntax

CreateFramebuffer( [Passes], Name, Value )

Parameters

Parameter

Type

Description

Passes

String

List of passes to create the framebuffer on

Default Value: Current pass

Name [in/out]

String

Name of the render channel to base the framebuffer upon.

Value [out]

Framebuffer

New Framebuffer object

Return Value

Returns the newly created Framebuffer object.

See Also

Framebuffer

CreateRenderChannel

RemoveRenderChannel



SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index