RenderPass

Deprecated

6.0 (replaced by RenderPasses)

Description

Renders the specified pass (current pass if no pass is specified).

A render pass creates a picture layer of a scene that can be composited with any other passes to create a complete image.

Scripting Syntax

RenderPass( [Passes], [PresetObj], [StartFrame], [EndFrame], [StepFrame], [DisposeRendering] )

Parameters

Parameter

Type

Description

Passes

String

Pass to render

Default Value: Current pass

PresetObj

String

Do not pass anything in this argument: the command always uses the render options of the current pass.

Default Value: Render Options of the current pass

StartFrame

Double

First frame to render

Default Value: Use value from Render options

EndFrame

Double

Last frame to export

Default Value: Use value from Render options

StepFrame

Double

Interval between rendered frames

Default Value: Use value from Render options

DisposeRendering

Boolean

True to empty the rendering cache (if allowed by user preferences)

Default Value: True if allowed

Examples

VBScript Example

'
'  This example creates a cone with some animation on it, creates a diffuse 
'  pass and a depth pass and then shows the difference between the two 
'  passes by rendering both out. It also demonstrates how to get and work 
'  with the output argument value (an ISIVTCollection).
'

' Create a new scene with only 5 frames 
NewScene , false
SetValue "PlayControl.Out", 5

' Add a cone with some animation
Set oCone = CreatePrim( "Cone", "MeshSurface" )
SaveKey oCone & ".kine.local.posx," _
   & oCone & ".kine.local.posy," _
   & oCone & ".kine.local.posz", _
   1
SetValue "PlayControl.Key", 5
SetValue "PlayControl.Current", 5
Translate oCone, _
   6.94824213992454, _
   2.46082959410157, _
   -0.246082959410157, _
   siRelative, _
   siView, _
   siObj, _
   siXYZ
SaveKey oCone & ".kine.local.posx," _
   & oCone & ".kine.local.posy," _
   & oCone & ".kine.local.posz", _
   5

' Create a diffuse pass
Set oDiffusePass = CreatePass( InstallationPath( siFactoryPath ) _
   & "\Data\DSPresets\Groups\Diffuse_Pass.Preset", "Diffuse_Pass" )

' Create a depth pass
Set oDepthPass = CreatePass( InstallationPath( siFactoryPath ) _
   & "\Data\DSPresets\Groups\Depth_Pass.Preset", "Depth_Pass" )

' Render the diffuse pass frame by frame. Note that since CreatePass returns 
' an ISIVTCollection, we need to access the new pass as the first member 
' of the ISIVTCollection
RenderPass oDiffusePass(0)

' See the difference with the depth pass
RenderPass oDepthPass(0)

See Also

SIRenderPass

RenderAllPasses

CreatePass

SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index