LayerOutΒΆ

class LayerOut

A LayerOut is a ShaderNodeIn that is found in a ShaderNodeOutputLayer

This node has connections to primitives to let the user override primitive assignation on a per pass basis.

Hierarchy

class LayerOut < class ShaderNodeIn < class Node

Members

Plugs:

types.string AcceptPath RW The regular expression of accepted light paths
types.string Color RW Override of the shader output to use instead of the output's name
types.string Compression RW Override of the pass compression
types.string DWACompressionLevel RW Override of the pass DWA compression
types.float DeepCompression RW Override of the pass deep compression ratio
types.bool DeepImage RW Override of the pass deep image
types.bool DeepMerge RW Override of the pass deep merge flag
types.bool Denoise RW Denoise this AOV if the Denoiser render setting is set.
types.string Depth RW Override of the pass display driver's bit depth
types.bool Disabled RW Disables the rendering of this output when true
types.string DisplayDriver RW Override of the pass display driver
types.string EXRIdPattern RW Override of the pass EXRId Pattern
nil ExMattes RW The connection to the excluded (to matte) SceneGraphNodes
nil ExVisibles RW The connection to the excluded (to visible) SceneGraphNodes
types.string FileAlphaMode RW The color written in file is alpha premultiplied ("multiply") or not ("normal"), or inherited from the RenderPass ("inherited")
types.string FileName RW Override of the pass filename
types.string Gamma RW Override of the pass display gamma
types.string IgnorePath RW The regular expression of ignored light paths
types.string LightCategories RW The categories of light that illuminate the output
nil Lit RW The connection to the linked lights for light linking overide
nil Mattes RW The connection to the matted SceneGraphNodes
types.string MetaData RW The meta data to insert in the EXR file header. You can add a metadata per line.
types.bool MultiPart RW If checked, writes the AOVs as OpenEXR 2.0 multi-part files. If not checks, write the AOVs as channels (compatible with OpenEXR 1.0).
types.bool OverrideSettings RW Enable override of the default parent RenderPass settings
types.string PixelFormat RW Override of the pass pixel format
types.vector2 PostClamp RW Override of the post filter clamping
types.vector2 PreClamp RW Override of the pre filter clamping
types.string RenderState R The actual state of this output, depending on its Disabled state and the solor mode
types.bool Solo RW Is the AOV in the solo mode ?
types.bool StochasticOpacity RW Sample this AOV stochastically with respect to opacity.
types.bool UseLPEs RW Override of the pass use lpes
nil Visibles RW The connection to the visible SceneGraphNodes

Methods:

nil setaov ( {string|table} settings ) Setup the aov with a preset, from either a predefined name or a table

Inherited from class ShaderNodeIn

Plugs:

nil Plug RW The connection to the parent ShaderNodeOut.
string PlugName RW The display name of the ShaderNodeIn
[float|table] Value RW The value of the shader node Plug when not connected to a ShadeNodeOut
type Desc RW The type descriptor of the input Value
boolean HideInput RW The visibility of the ShaderNodeIn

Methods:

nil connect ( ShaderNodeOut output ) Connect a shader node output into this input
ShaderNodeOut|ShaderNodeIn connection getconnected ( ) get the connected shader node input or output
nil disconnect ( ) Disconnect this input from its output
nil setexposed ( boolean expose ) Expose this plug
boolean exposed isexposed ( ) Tell if the plug is exposed

Inherited from class Node

Plugs:

string Name RW The node name

Methods:

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

Documentation

types.string AcceptPath RW

The regular expression of accepted light paths

types.string Color RW

Override of the shader output to use instead of the output's name

types.string Compression RW

Override of the pass compression

types.string DWACompressionLevel RW

Override of the pass DWA compression

types.float DeepCompression RW

Override of the pass deep compression ratio

types.bool DeepImage RW

Override of the pass deep image

types.bool DeepMerge RW

Override of the pass deep merge flag

types.bool Denoise RW

Denoise this AOV if the Denoiser render setting is set.

types.string Depth RW

Override of the pass display driver's bit depth

types.bool Disabled RW

Disables the rendering of this output when true

types.string DisplayDriver RW

Override of the pass display driver

types.string EXRIdPattern RW

Override of the pass EXRId Pattern

nil ExMattes RW

The connection to the excluded (to matte) SceneGraphNodes

nil ExVisibles RW

The connection to the excluded (to visible) SceneGraphNodes

types.string FileAlphaMode RW

The color written in file is alpha premultiplied ("multiply") or not ("normal"), or inherited from the RenderPass ("inherited")

types.string FileName RW

Override of the pass filename

types.string Gamma RW

Override of the pass display gamma

types.string IgnorePath RW

The regular expression of ignored light paths

types.string LightCategories RW

The categories of light that illuminate the output

nil Lit RW

The connection to the linked lights for light linking overide

nil Mattes RW

The connection to the matted SceneGraphNodes

types.string MetaData RW

The meta data to insert in the EXR file header. You can add a metadata per line.

types.bool MultiPart RW

If checked, writes the AOVs as OpenEXR 2.0 multi-part files. If not checks, write the AOVs as channels (compatible with OpenEXR 1.0).

types.bool OverrideSettings RW

Enable override of the default parent RenderPass settings

types.string PixelFormat RW

Override of the pass pixel format

types.vector2 PostClamp RW

Override of the post filter clamping

types.vector2 PreClamp RW

Override of the pre filter clamping

types.string RenderState R

The actual state of this output, depending on its Disabled state and the solor mode

types.bool Solo RW

Is the AOV in the solo mode ?

If at least one render pass is in the solo mode, only those passes will be computed. If no render pass are in the solo mode, all the render passes are computed.

types.bool StochasticOpacity RW

Sample this AOV stochastically with respect to opacity.

types.bool UseLPEs RW

Override of the pass use lpes

nil Visibles RW

The connection to the visible SceneGraphNodes

nil setaov ( {string|table} settings )

Setup the aov with a preset, from either a predefined name or a table

As a table/dict, the settings can contain any of the following attributes:
  • Node: The path to a node to load and connect
  • Color: The default color to use (or {0,0,0})
  • Accept: The accept regular expression (or an alias for it)
  • Ignore: The ignore regular expression (or an alias for it)
  • ShaderColor: The shader output or attribute to shader
  • LightCategories: The ligth categories to integrate in the AOV
  • OverrideSettings: Enable the aov settings to be overriden
Arguments:

  • settings The settings to use