RenderPass¶

class RenderPass

The basic render pass to render an image

Hierarchy

class RenderPass < class Shader < class Pass < class HostNode < class Settings < class RenderFileOut < class Node < class RenderOutput < class SelectableNode

Members

types.string	BackupProjectFileName	RW	The backup Guerilla project to be saved when generating RIB files
nil	ExMattes	RW	The connection to the excluded (to matte) SceneGraphNodes
nil	ExVisibles	RW	The connection to the excluded (to visible) SceneGraphNodes
types.enum	LayerMode	RW	The mode of the RenderPass, "Normal", "BakeST"
nil	Mattes	RW	The connection to the matted SceneGraphNodes
types.enum	MovieCodec	RW	The codec type for the movie
types.bool	MovieCreate	RW	Should the RenderPass render a movie after a sequence
types.int	MovieFrameRate	RW	The movie frame rate, in frames per seconds
types.int	MovieQuality	RW	The movie quality, 100 for maximum quality
nil	RenderPassCamera	RW	The connection to the rendering camera
nil	Visibles	RW	The connection to the visible SceneGraphNodes

---

Inherited from class Shader

ShaderNode result	addnode	( string filename )	add a node into a shader by its filename
table definition	getinputsdef	( )	Get the definition of the shader inputs
ShaderNode result	getoutput	( string outputclass )	Get the first shader output node of the given type in the shader. If no outputclass is given, looks for "ShaderNodeOutputLight" in a light shader, "ShaderNodeOutputCompo" in a compositing, or "ShaderNodeSurface" otherwise.

---

Inherited from class Pass

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 ?

string result	evalfilename	( string output , number eye , number frame , number side , string ext )	Evaluate the output file name of the Pass
nil	fillrenderpasstemplate	( table template )	Fill a property sheet template
bool result	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 HostNode

types.string

HostPath

RW

The data archive to read HostPlugs value when baked

nil	deleteinheritedattr	( string plugname )	Delete an inherited attribute plug from the node
nil	overrideinheritedattr	( string plugname , any value )	Override the attribute
nil	setinheritedattr	( string plugname , [bool|nil] inherited , [ any value ] )	Set the inheritance status of the attribute

---

Inherited from class RenderFileOut

nil

RenderPassFileIn

R

Connection to ShaderNodeFileIns

---

Inherited from class Node

string

Name

RW

The node name

bool result	belongstoreference	( Reference ref )	Tells if the node belongs to the reference, or a sub reference
nil	delete	( )	Delete a node
any value	eval	( Plug plug )	Called by the framework when plug (a node's plug) must be evaluated
Node|Plug child	findchild	( string path )	Find a child node or plug using a path
Node parent	findparent	( string name )	Find the first parent Node of this Node of a specific class
Node result	getchild	( string name )	Get a child node by its name
[string|number] name	getname	( )	Get the Node name in its parent
Node parent	getparent	( )	Get the parent Node of this Node
string path	getpath	( )	Returns the node path as a string that can be reused with findchild
Reference reference	getreference	( )	Returns the reference node it is connected to
of table	getreferences	( [ topref Reference ] )	Returns the references in the document sorted depth first.
string result	getstringcopy	( )	Return a copy of the node and its content as a string to be pasted
Reference reference	gettopreference	( )	Returns the top reference node it is connected to
boolean editable	iseditable	( )	Indicates if the node can be edited by the user in the UI
bool result	ismoveable	( )	Tells if the node can be moved
boolean result	isparent	( Node child )	Tells if this node is parent of the potential child
boolean result	isreference	( )	Tells if a node comes from a reference project
boolean state	isselected	( )	Tell if the node is selected
{Node} result	loadfile	( string filename )	load a file content in this node.
Node result	loadtemplate	( string template , string name )	load a template file
nil	move	( Node parent )	Move a node to a new parent
nil	onpathchanged	( )	Called by the framework when the name of this node or of one of its parent is modified
{Node},string result,error	pastestringcopy	( string copy )	Paste a string copy into this node
nil	rename	( string name )	Rename a node
bool,string success,error	savefile	( string filename )	load a node to a file
nil	seteditable	( boolean editable )	Change the editable state of the node
nil	setflags	( )	Set the node flags

---

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 SelectableNode

boolean

Selected

R

True if the node is selected. Don't use this plug directly to select a node, use the Document's modifier select method.

Documentation

types.string BackupProjectFileName RW

The backup Guerilla project to be saved when generating RIB files

---

nil ExMattes RW

The connection to the excluded (to matte) SceneGraphNodes

---

nil ExVisibles RW

The connection to the excluded (to visible) SceneGraphNodes

---

types.enum LayerMode RW

The mode of the RenderPass, "Normal", "BakeST"

---

nil Mattes RW

The connection to the matted SceneGraphNodes

---

types.enum MovieCodec RW

The codec type for the movie

---

types.bool MovieCreate RW

Should the RenderPass render a movie after a sequence

---

types.int MovieFrameRate RW

The movie frame rate, in frames per seconds

---

types.int MovieQuality RW

The movie quality, 100 for maximum quality

---

nil RenderPassCamera RW

The connection to the rendering camera

---

nil Visibles RW

The connection to the visible SceneGraphNodes

---