nodes.shader.output

output

Classes

Name Description
AOVOutput Arbitrary Output Variables.
LightOutput Output light information to a light object
LineStyleOutput Control the mixing of texture information into the base color of line styles
MaterialOutput Output surface material information for use in rendering
WorldOutput Output light color information to the scene’s World

AOVOutput

AOVOutput(color=(0.0, 0.0, 0.0, 1.0), value=0.0, *, aov_name='')
Arbitrary Output Variables.

Provide custom render passes for arbitrary shader node outputs

Parameters

color : InputColor
    Color
value : InputFloat
    Value

Inputs

i.color : ColorSocket
    Color
i.value : FloatSocket
    Value

Attributes

Name Description
aov_name
i
name The name of the node being wrapped by this instance.
node
o
tree The TreeBuilder instance this node belongs to and is being built within.

Methods

Name Description
props Set the properties every node has and return the node, so it can
props
props(
    label=None,
    color=None,
    width=None,
    height=None,
    hide=None,
    show_options=None,
    hide_inputs=(),
    hide_outputs=(),
    mute=None,
    warning_propagation=None,
    pin_gizmo=None,
    pin_gizmo_inputs=(),
)

Set the properties every node has and return the node, so it can go at the end of a chain::

g.SetPosition(geometry=geo, offset=offset).props(
    label="Lift", color="#FFAA00", width=200
)

Properties left as None are unchanged.

Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.

LightOutput

LightOutput(surface=None, *, is_active_output=None, target='ALL')

Output light information to a light object

Parameters

Name Type Description Default
surface InputShader Surface None

Attributes

Name Description
i
is_active_output
name The name of the node being wrapped by this instance.
node
o
target
tree The TreeBuilder instance this node belongs to and is being built within.

Methods

Name Description
all Create Light Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output
cycles Create Light Output with operation ‘Cycles’. Use shaders for Cycles renderer
eevee Create Light Output with operation ‘EEVEE’. Use shaders for EEVEE renderer
props Set the properties every node has and return the node, so it can
all
all(surface=None, *, is_active_output=None)

Create Light Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output

cycles
cycles(surface=None, *, is_active_output=None)

Create Light Output with operation ‘Cycles’. Use shaders for Cycles renderer

eevee
eevee(surface=None, *, is_active_output=None)

Create Light Output with operation ‘EEVEE’. Use shaders for EEVEE renderer

props
props(
    label=None,
    color=None,
    width=None,
    height=None,
    hide=None,
    show_options=None,
    hide_inputs=(),
    hide_outputs=(),
    mute=None,
    warning_propagation=None,
    pin_gizmo=None,
    pin_gizmo_inputs=(),
)

Set the properties every node has and return the node, so it can go at the end of a chain::

g.SetPosition(geometry=geo, offset=offset).props(
    label="Lift", color="#FFAA00", width=200
)

Properties left as None are unchanged.

Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.

Inputs

Attribute Type Description
i.surface ShaderSocket Surface

LineStyleOutput

LineStyleOutput(
    color=(1.0, 0.0, 1.0, 1.0),
    color_fac=1.0,
    alpha=1.0,
    alpha_fac=1.0,
    *,
    is_active_output=None,
    target='ALL',
    blend_type='MIX',
    use_alpha=False,
    use_clamp=False,
)

Control the mixing of texture information into the base color of line styles

Parameters

Name Type Description Default
color InputColor Color (1.0, 0.0, 1.0, 1.0)
color_fac InputFloat Color Fac 1.0
alpha InputFloat Alpha 1.0
alpha_fac InputFloat Alpha Fac 1.0

Attributes

Name Description
blend_type
i
is_active_output
name The name of the node being wrapped by this instance.
node
o
target
tree The TreeBuilder instance this node belongs to and is being built within.
use_alpha
use_clamp

Methods

Name Description
all Create Line Style Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output
cycles Create Line Style Output with operation ‘Cycles’. Use shaders for Cycles renderer
eevee Create Line Style Output with operation ‘EEVEE’. Use shaders for EEVEE renderer
props Set the properties every node has and return the node, so it can
all
all(
    color=(1.0, 0.0, 1.0, 1.0),
    color_fac=1.0,
    alpha=1.0,
    alpha_fac=1.0,
    *,
    is_active_output=None,
    blend_type='MIX',
    use_alpha=False,
    use_clamp=False,
)

Create Line Style Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output

cycles
cycles(
    color=(1.0, 0.0, 1.0, 1.0),
    color_fac=1.0,
    alpha=1.0,
    alpha_fac=1.0,
    *,
    is_active_output=None,
    blend_type='MIX',
    use_alpha=False,
    use_clamp=False,
)

Create Line Style Output with operation ‘Cycles’. Use shaders for Cycles renderer

eevee
eevee(
    color=(1.0, 0.0, 1.0, 1.0),
    color_fac=1.0,
    alpha=1.0,
    alpha_fac=1.0,
    *,
    is_active_output=None,
    blend_type='MIX',
    use_alpha=False,
    use_clamp=False,
)

Create Line Style Output with operation ‘EEVEE’. Use shaders for EEVEE renderer

props
props(
    label=None,
    color=None,
    width=None,
    height=None,
    hide=None,
    show_options=None,
    hide_inputs=(),
    hide_outputs=(),
    mute=None,
    warning_propagation=None,
    pin_gizmo=None,
    pin_gizmo_inputs=(),
)

Set the properties every node has and return the node, so it can go at the end of a chain::

g.SetPosition(geometry=geo, offset=offset).props(
    label="Lift", color="#FFAA00", width=200
)

Properties left as None are unchanged.

Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.

Inputs

Attribute Type Description
i.color ColorSocket Color
i.color_fac FloatSocket Color Fac
i.alpha FloatSocket Alpha
i.alpha_fac FloatSocket Alpha Fac

MaterialOutput

MaterialOutput(
    surface=None,
    volume=None,
    displacement=None,
    thickness=None,
    *,
    is_active_output=None,
    target='ALL',
)

Output surface material information for use in rendering

Parameters

Name Type Description Default
surface InputShader Surface None
volume InputShader Volume None
displacement InputVector Displacement None
thickness InputFloat Thickness None

Attributes

Name Description
i
is_active_output
name The name of the node being wrapped by this instance.
node
o
target
tree The TreeBuilder instance this node belongs to and is being built within.

Methods

Name Description
all Create Material Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output
cycles Create Material Output with operation ‘Cycles’. Use shaders for Cycles renderer
eevee Create Material Output with operation ‘EEVEE’. Use shaders for EEVEE renderer
props Set the properties every node has and return the node, so it can
all
all(
    surface=None,
    volume=None,
    displacement=None,
    thickness=None,
    *,
    is_active_output=None,
)

Create Material Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output

cycles
cycles(
    surface=None,
    volume=None,
    displacement=None,
    thickness=None,
    *,
    is_active_output=None,
)

Create Material Output with operation ‘Cycles’. Use shaders for Cycles renderer

eevee
eevee(
    surface=None,
    volume=None,
    displacement=None,
    thickness=None,
    *,
    is_active_output=None,
)

Create Material Output with operation ‘EEVEE’. Use shaders for EEVEE renderer

props
props(
    label=None,
    color=None,
    width=None,
    height=None,
    hide=None,
    show_options=None,
    hide_inputs=(),
    hide_outputs=(),
    mute=None,
    warning_propagation=None,
    pin_gizmo=None,
    pin_gizmo_inputs=(),
)

Set the properties every node has and return the node, so it can go at the end of a chain::

g.SetPosition(geometry=geo, offset=offset).props(
    label="Lift", color="#FFAA00", width=200
)

Properties left as None are unchanged.

Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.

Inputs

Attribute Type Description
i.surface ShaderSocket Surface
i.volume ShaderSocket Volume
i.displacement VectorSocket Displacement
i.thickness FloatSocket Thickness

WorldOutput

WorldOutput(surface=None, volume=None, *, is_active_output=None, target='ALL')

Output light color information to the scene’s World

Parameters

Name Type Description Default
surface InputShader Surface None
volume InputShader Volume None

Attributes

Name Description
i
is_active_output
name The name of the node being wrapped by this instance.
node
o
target
tree The TreeBuilder instance this node belongs to and is being built within.

Methods

Name Description
all Create World Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output
cycles Create World Output with operation ‘Cycles’. Use shaders for Cycles renderer
eevee Create World Output with operation ‘EEVEE’. Use shaders for EEVEE renderer
props Set the properties every node has and return the node, so it can
all
all(surface=None, volume=None, *, is_active_output=None)

Create World Output with operation ‘All’. Use shaders for all renderers and viewports, unless there exists a more specific output

cycles
cycles(surface=None, volume=None, *, is_active_output=None)

Create World Output with operation ‘Cycles’. Use shaders for Cycles renderer

eevee
eevee(surface=None, volume=None, *, is_active_output=None)

Create World Output with operation ‘EEVEE’. Use shaders for EEVEE renderer

props
props(
    label=None,
    color=None,
    width=None,
    height=None,
    hide=None,
    show_options=None,
    hide_inputs=(),
    hide_outputs=(),
    mute=None,
    warning_propagation=None,
    pin_gizmo=None,
    pin_gizmo_inputs=(),
)

Set the properties every node has and return the node, so it can go at the end of a chain::

g.SetPosition(geometry=geo, offset=offset).props(
    label="Lift", color="#FFAA00", width=200
)

Properties left as None are unchanged.

Args: label: The node’s header label. color: A custom header colour, as a hex string ("#FFAA00") or an (r, g, b) tuple; turns on use_custom_color. width: The node’s width. height: The node’s height; only frames use it. hide: Collapse the node. show_options: Show the node’s options (dropdowns and toggles). hide_inputs: Input sockets to hide, by name; "Value#1" names the second visible Value. hide_outputs: Output sockets to hide, by name. mute: Mute (bypass) the node. warning_propagation: Which of the node’s warnings show on the group node it sits in. pin_gizmo: Keep the node’s gizmo visible when it isn’t selected: a gizmo node’s, or a value node’s (Value, Vector, …). pin_gizmo_inputs: Inputs whose gizmos stay visible when the node isn’t selected, by name; for group nodes passing a gizmo through.

Inputs

Attribute Type Description
i.surface ShaderSocket Surface
i.volume ShaderSocket Volume