PassΒΆ
class Pass
A render pass reacts to renders by pushing jobs into a job queue.
Hierarchy
class Pass < class RenderOutput < class Node
Children classes : class Compositing , class RenderPass
Members
types.bool | Disabled | RW | Disables the rendering of this layer when true |
types.bool | NextTime | RW | Render the render pass next time, whatever its solo and Disable states |
types.int{} | PassOrder | RW | The order in which this pass is rendered |
types.enum | PassValidity | RW | How should the Pass be scheduled (per frame, per sequence, manually) |
types.string | RenderRange | RW | The frames to render for this pass |
types.bool | Solo | RW | Is the Pass in the solo mode ? |
| evalfilename | (
|
Evaluate the output file name of the Pass |
| fillrenderpasstemplate | (
|
Fill a property sheet template |
| isrenderable | ( ) | Returns true if the render pass will be rendered by the next render command according to the PassValidity, the Disabled and the Solo plugs. |
Inherited from class RenderOutput
string | FileName | RW | The user file name for this pass |
string | PassFileName | RW | The final pass file name, depending on FileName |
Inherited from class Node
string | Name | RW | The node name |
| belongstoreference | (
|
Tells if the node belongs to the reference, or a sub reference |
| delete | ( ) | Delete a node |
| eval | (
|
Called by the framework when plug (a node's plug) must be evaluated |
| findchild | (
|
Find a child node or plug using a path |
| findparent | (
|
Find the first parent Node of this Node of a specific class |
| getchild | (
|
Get a child node by its name |
| getname | ( ) | Get the Node name in its parent |
| getparent | ( ) | Get the parent Node of this Node |
| getpath | ( ) | Returns the node path as a string that can be reused with findchild |
| getreference | ( ) | Returns the reference node it is connected to |
| getreferences | (
[
|
Returns the references in the document sorted depth first. |
| getstringcopy | ( ) | Return a copy of the node and its content as a string to be pasted |
| gettopreference | ( ) | Returns the top reference node it is connected to |
| iseditable | ( ) | Indicates if the node can be edited by the user in the UI |
| isindocument | ( ) | Tells if the node is inside a document, or is pending in the void |
| ismoveable | ( ) | Tells if the node can be moved |
| isparent | (
|
Tells if this node is parent of the potential child |
| isreference | ( ) | Tells if a node comes from a reference project |
| isselected | ( ) | Tell if the node is selected |
| loadfile | (
|
load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node. |
| loadtemplate | (
|
load a template file |
| move | (
|
Move a node to a new parent |
| onpathchanged | ( ) | Called by the framework when the name of this node or of one of its parent is modified |
| pastestringcopy | (
|
Paste a string copy into this node |
| referencefile | (
|
reference a file content in this node. |
| rename | (
|
Rename a node |
| savefile | (
|
load a node to a file |
| seteditable | (
|
Change the editable state of the node |
| setflags | ( ) | Set the node flags |
Documentation
Disables the rendering of this layer when true
Render the render pass next time, whatever its solo and Disable states
The order in which this pass is rendered
How should the Pass be scheduled (per frame, per sequence, manually)
The frames to render for this pass
Is the Pass in the solo mode ?
Evaluate the output file name of the Pass
The final final of the Pass is evaluated using the given arguments, such as the name of the output (for Layers), the eye number, the frame number and the file extension.
If the Pass FileName plug is left blank, then the Pass will pick a default name. This default name is a combination of $l, $o, $e, $f, $s and $x. For instance, a normal Layer, rendered on each frame will have a default file name of $l_$o_$e_$05f.$x
Depending on the passed arguments, these $* items will be replaced. If an argument is missing, then matching the value is left as is, and it is the duty of the renderer to correctly replace this value. For instance, leaving the frame as nil will leave any $f as is. Note that $l is always replaced by the Pass path, stripped of any illegal character.
Ex:
Let's assume that:
- the pass raw filename is $l_$o_$05f.$x
- the pass path is "MyPass"
- the pass default extension is 'tiff'
output The selected sub output, only for image Layerseye The eye number, starting from 1frame The frame number. Use Pass.CurrentFrame to evaluate as the current frameside The cube side number.ext The file extension to use.
result The final renderpass filename
Fill a property sheet template
template The template to fill with the Pass attributes
Returns true if the render pass will be rendered by the next render command according to the PassValidity, the Disabled and the Solo plugs.
result rendered next time