nodes.shader.shader
shader
Classes
| Name | Description |
|---|---|
| AddShader | Add two Shaders together |
| Background | Add background light emission. |
| DiffuseBSDF | Lambertian and Oren-Nayar diffuse reflection |
| Emission | Lambertian emission shader |
| GlassBSDF | Glass-like shader mixing refraction and reflection at grazing angles |
| GlossyBSDF | Reflection with microfacet distribution, used for materials such as metal or mirrors |
| HairBSDF | Reflection and transmission shaders optimized for hair rendering |
| Holdout | Create a “hole” in the image with zero alpha transparency, which is useful for compositing. |
| LightAccumulation | Adds the result of all the evaluated lights and stores each input into its respective Compositing Pass. |
| MetallicBSDF | Metallic reflection with microfacet distribution, and metallic fresnel |
| MixShader | Mix two shaders together. Typically used for material layering |
| PrincipledBSDF | Physically-based, easy-to-use shader for rendering surface materials, based on the OpenPBR model |
| PrincipledHairBSDF | Physically-based, easy-to-use shader for rendering hair and fur |
| RayPortalBSDF | Continue tracing from an arbitrary new position and in a new direction |
| RefractionBSDF | Glossy refraction with sharp or microfacet distribution, typically used for materials that transmit light |
| SheenBSDF | Reflection for materials such as cloth. |
| SpecularBSDF | Similar to the Principled BSDF node but uses the specular workflow instead of metallic, which functions by specifying the facing (along normal) reflection color. Energy is not conserved, so the result may not be physically accurate |
| SubsurfaceScattering | Subsurface multiple scattering shader to simulate light entering the surface and bouncing internally. |
| ToonBSDF | Diffuse and Glossy shaders with cartoon light effects |
| TranslucentBSDF | Lambertian diffuse transmission |
| TransparentBSDF | Transparency without refraction, passing straight through the surface as if there were no geometry |
AddShader
AddShader(shader=None, shader_001=None)Add two Shaders together
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| shader | InputShader | Shader | None |
| shader_001 | InputShader | Shader | None |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.shader |
ShaderSocket |
Shader |
i.shader_001 |
ShaderSocket |
Shader |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.shader |
ShaderSocket |
Shader |
Background
Background(color=(0.8, 0.8, 0.8, 1.0), strength=1.0)Add background light emission.
Note: This node should only be used for the world surface output
Parameters
color : InputColor
Color
strength : InputFloat
Strength
Inputs
i.color : ColorSocket
Color
i.strength : FloatSocket
Strength
Outputs
o.background : ShaderSocket
Background
Attributes
| Name | Description |
|---|---|
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.
DiffuseBSDF
DiffuseBSDF(color=(0.8, 0.8, 0.8, 1.0), roughness=0.0, normal=None)Lambertian and Oren-Nayar diffuse reflection
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (0.8, 0.8, 0.8, 1.0) |
| roughness | InputFloat | Roughness | 0.0 |
| normal | InputVector | Normal | None |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.roughness |
FloatSocket |
Roughness |
i.normal |
VectorSocket |
Normal |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
Emission
Emission(color=(1.0, 1.0, 1.0, 1.0), strength=1.0)Lambertian emission shader
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (1.0, 1.0, 1.0, 1.0) |
| strength | InputFloat | Strength | 1.0 |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.strength |
FloatSocket |
Strength |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.emission |
ShaderSocket |
Emission |
GlassBSDF
GlassBSDF(
color=(1.0, 1.0, 1.0, 1.0),
roughness=0.0,
anisotropy=0.0,
rotation=0.0,
ior=1.5,
normal=None,
tangent=None,
thin_film_thickness=0.0,
thin_film_ior=1.33,
*,
distribution='MULTI_GGX',
)Glass-like shader mixing refraction and reflection at grazing angles
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (1.0, 1.0, 1.0, 1.0) |
| roughness | InputFloat | Roughness | 0.0 |
| anisotropy | InputFloat | Anisotropy | 0.0 |
| rotation | InputFloat | Rotation | 0.0 |
| ior | InputFloat | IOR | 1.5 |
| normal | InputVector | Normal | None |
| tangent | InputVector | Tangent | None |
| thin_film_thickness | InputFloat | Thin Film Thickness | 0.0 |
| thin_film_ior | InputFloat | Thin Film IOR | 1.33 |
Attributes
| Name | Description |
|---|---|
distribution |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.roughness |
FloatSocket |
Roughness |
i.anisotropy |
FloatSocket |
Anisotropy |
i.rotation |
FloatSocket |
Rotation |
i.ior |
FloatSocket |
IOR |
i.normal |
VectorSocket |
Normal |
i.tangent |
VectorSocket |
Tangent |
i.thin_film_thickness |
FloatSocket |
Thin Film Thickness |
i.thin_film_ior |
FloatSocket |
Thin Film IOR |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
GlossyBSDF
GlossyBSDF(
color=(0.8, 0.8, 0.8, 1.0),
roughness=0.5,
anisotropy=0.0,
rotation=0.0,
normal=None,
tangent=None,
*,
distribution='MULTI_GGX',
)Reflection with microfacet distribution, used for materials such as metal or mirrors
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (0.8, 0.8, 0.8, 1.0) |
| roughness | InputFloat | Roughness | 0.5 |
| anisotropy | InputFloat | Anisotropy | 0.0 |
| rotation | InputFloat | Rotation | 0.0 |
| normal | InputVector | Normal | None |
| tangent | InputVector | Tangent | None |
Attributes
| Name | Description |
|---|---|
distribution |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.roughness |
FloatSocket |
Roughness |
i.anisotropy |
FloatSocket |
Anisotropy |
i.rotation |
FloatSocket |
Rotation |
i.normal |
VectorSocket |
Normal |
i.tangent |
VectorSocket |
Tangent |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
HairBSDF
HairBSDF(
color=(0.8, 0.8, 0.8, 1.0),
offset=0.0,
roughnessu=0.1,
roughnessv=1.0,
tangent=None,
*,
component='Reflection',
)Reflection and transmission shaders optimized for hair rendering
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (0.8, 0.8, 0.8, 1.0) |
| offset | InputFloat | Offset | 0.0 |
| roughnessu | InputFloat | RoughnessU | 0.1 |
| roughnessv | InputFloat | RoughnessV | 1.0 |
| tangent | InputVector | Tangent | None |
Attributes
| Name | Description |
|---|---|
component |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.offset |
FloatSocket |
Offset |
i.roughnessu |
FloatSocket |
RoughnessU |
i.roughnessv |
FloatSocket |
RoughnessV |
i.tangent |
VectorSocket |
Tangent |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
Holdout
Holdout()Create a "hole" in the image with zero alpha transparency, which is useful for compositing.
Note: the holdout shader can only create alpha when transparency is enabled in the film settings
Outputs
o.holdout : ShaderSocket
Holdout
Attributes
| Name | Description |
|---|---|
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.
LightAccumulation
LightAccumulation(
diffuse_light=None,
diffuse_color=None,
glossy_light=None,
glossy_color=None,
transmission_light=None,
transmission_color=None,
)Adds the result of all the evaluated lights and stores each input into its respective Compositing Pass.
The combined result is computed as (Diffuse Light * Diffuse Color) + (Glossy Light * Glossy Color)
Parameters
diffuse_light : InputColor
Diffuse Light
diffuse_color : InputColor
Diffuse Color
glossy_light : InputColor
Glossy Light
glossy_color : InputColor
Glossy Color
transmission_light : InputColor
Transmission Light
transmission_color : InputColor
Transmission Color
Inputs
i.diffuse_light : ColorSocket
Diffuse Light
i.diffuse_color : ColorSocket
Diffuse Color
i.glossy_light : ColorSocket
Glossy Light
i.glossy_color : ColorSocket
Glossy Color
i.transmission_light : ColorSocket
Transmission Light
i.transmission_color : ColorSocket
Transmission Color
Outputs
o.shader : ShaderSocket
Shader
Attributes
| Name | Description |
|---|---|
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.
MetallicBSDF
MetallicBSDF(
base_color=(0.617, 0.577, 0.54, 1.0),
edge_tint=(0.695, 0.726, 0.77, 1.0),
ior=(2.757, 2.513, 2.231),
extinction=(3.867, 3.404, 3.009),
roughness=0.5,
anisotropy=0.0,
rotation=0.0,
normal=None,
tangent=None,
thin_film_thickness=0.0,
thin_film_ior=1.33,
*,
distribution='MULTI_GGX',
fresnel_type='F82',
)Metallic reflection with microfacet distribution, and metallic fresnel
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| base_color | InputColor | Base Color | (0.617, 0.577, 0.54, 1.0) |
| edge_tint | InputColor | Edge Tint | (0.695, 0.726, 0.77, 1.0) |
| ior | InputVector | IOR | (2.757, 2.513, 2.231) |
| extinction | InputVector | Extinction | (3.867, 3.404, 3.009) |
| roughness | InputFloat | Roughness | 0.5 |
| anisotropy | InputFloat | Anisotropy | 0.0 |
| rotation | InputFloat | Rotation | 0.0 |
| normal | InputVector | Normal | None |
| tangent | InputVector | Tangent | None |
| thin_film_thickness | InputFloat | Thin Film Thickness | 0.0 |
| thin_film_ior | InputFloat | Thin Film IOR | 1.33 |
Attributes
| Name | Description |
|---|---|
distribution |
|
fresnel_type |
|
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 |
|---|---|
| f82_tint | Create Metallic BSDF with operation ‘F82 Tint’. An approximation of the Fresnel conductor curve based on the colors at perpendicular and near-grazing (roughly 82°) angles |
| physical_conductor | Create Metallic BSDF with operation ‘Physical Conductor’. Fresnel conductor based on the complex refractive index per color channel |
| props | Set the properties every node has and return the node, so it can |
f82_tint
f82_tint(
base_color=(0.617, 0.577, 0.54, 1.0),
edge_tint=(0.695, 0.726, 0.77, 1.0),
roughness=0.5,
anisotropy=0.0,
rotation=0.0,
normal=None,
tangent=None,
thin_film_thickness=0.0,
thin_film_ior=1.33,
*,
distribution='MULTI_GGX',
)Create Metallic BSDF with operation ‘F82 Tint’. An approximation of the Fresnel conductor curve based on the colors at perpendicular and near-grazing (roughly 82°) angles
physical_conductor
physical_conductor(
ior=(2.757, 2.513, 2.231),
extinction=(3.867, 3.404, 3.009),
roughness=0.5,
anisotropy=0.0,
rotation=0.0,
normal=None,
tangent=None,
thin_film_thickness=0.0,
thin_film_ior=1.33,
*,
distribution='MULTI_GGX',
)Create Metallic BSDF with operation ‘Physical Conductor’. Fresnel conductor based on the complex refractive index per color channel
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.base_color |
ColorSocket |
Base Color |
i.edge_tint |
ColorSocket |
Edge Tint |
i.ior |
VectorSocket |
IOR |
i.extinction |
VectorSocket |
Extinction |
i.roughness |
FloatSocket |
Roughness |
i.anisotropy |
FloatSocket |
Anisotropy |
i.rotation |
FloatSocket |
Rotation |
i.normal |
VectorSocket |
Normal |
i.tangent |
VectorSocket |
Tangent |
i.thin_film_thickness |
FloatSocket |
Thin Film Thickness |
i.thin_film_ior |
FloatSocket |
Thin Film IOR |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
MixShader
MixShader(factor=0.5, shader=None, shader_001=None)Mix two shaders together. Typically used for material layering
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| factor | InputFloat | Factor. Renamed from Fac; i.fac still resolves to it. |
0.5 |
| shader | InputShader | Shader | None |
| shader_001 | InputShader | Shader | None |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.factor |
FloatSocket |
Factor. Renamed from Fac; i.fac still resolves to it. |
i.shader |
ShaderSocket |
Shader |
i.shader_001 |
ShaderSocket |
Shader |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.shader |
ShaderSocket |
Shader |
PrincipledBSDF
PrincipledBSDF(
base_color=(0.8, 0.8, 0.8, 1.0),
metallic=0.0,
roughness=0.5,
ior=1.5,
alpha=1.0,
thin_wall=False,
normal=None,
diffuse_roughness=0.0,
subsurface_weight=0.0,
subsurface_radius=(1.0, 0.2, 0.1),
subsurface_scale=0.005,
subsurface_ior=1.4,
subsurface_anisotropy=0.0,
specular_ior_level=0.5,
specular_tint=(1.0, 1.0, 1.0, 1.0),
anisotropic=0.0,
anisotropic_rotation=0.0,
tangent=None,
transmission_weight=0.0,
transmission_dispersion_scale=0.0,
transmission_dispersion_abbe_number=20.0,
coat_weight=0.0,
coat_roughness=0.03,
coat_ior=1.5,
coat_tint=(1.0, 1.0, 1.0, 1.0),
coat_normal=None,
sheen_weight=0.0,
sheen_roughness=0.5,
sheen_tint=(1.0, 1.0, 1.0, 1.0),
emission_color=(1.0, 1.0, 1.0, 1.0),
emission_strength=0.0,
thin_film_thickness=0.0,
thin_film_ior=1.33,
*,
distribution='MULTI_GGX',
subsurface_method='RANDOM_WALK',
)Physically-based, easy-to-use shader for rendering surface materials, based on the OpenPBR model
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| base_color | InputColor | Base Color | (0.8, 0.8, 0.8, 1.0) |
| metallic | InputFloat | Metallic | 0.0 |
| roughness | InputFloat | Roughness | 0.5 |
| ior | InputFloat | IOR | 1.5 |
| alpha | InputFloat | Alpha | 1.0 |
| thin_wall | InputBoolean | Thin Wall | False |
| normal | InputVector | Normal | None |
| diffuse_roughness | InputFloat | Diffuse Roughness | 0.0 |
| subsurface_weight | InputFloat | Subsurface Weight | 0.0 |
| subsurface_radius | InputVector | Subsurface Radius | (1.0, 0.2, 0.1) |
| subsurface_scale | InputFloat | Subsurface Scale | 0.005 |
| subsurface_ior | InputFloat | Subsurface IOR | 1.4 |
| subsurface_anisotropy | InputFloat | Subsurface Anisotropy | 0.0 |
| specular_ior_level | InputFloat | Specular IOR Level | 0.5 |
| specular_tint | InputColor | Specular Tint | (1.0, 1.0, 1.0, 1.0) |
| anisotropic | InputFloat | Anisotropic | 0.0 |
| anisotropic_rotation | InputFloat | Anisotropic Rotation | 0.0 |
| tangent | InputVector | Tangent | None |
| transmission_weight | InputFloat | Transmission Weight | 0.0 |
| transmission_dispersion_scale | InputFloat | Transmission Dispersion Scale | 0.0 |
| transmission_dispersion_abbe_number | InputFloat | Transmission Dispersion Abbe Number | 20.0 |
| coat_weight | InputFloat | Coat Weight | 0.0 |
| coat_roughness | InputFloat | Coat Roughness | 0.03 |
| coat_ior | InputFloat | Coat IOR | 1.5 |
| coat_tint | InputColor | Coat Tint | (1.0, 1.0, 1.0, 1.0) |
| coat_normal | InputVector | Coat Normal | None |
| sheen_weight | InputFloat | Sheen Weight | 0.0 |
| sheen_roughness | InputFloat | Sheen Roughness | 0.5 |
| sheen_tint | InputColor | Sheen Tint | (1.0, 1.0, 1.0, 1.0) |
| emission_color | InputColor | Emission Color | (1.0, 1.0, 1.0, 1.0) |
| emission_strength | InputFloat | Emission Strength | 0.0 |
| thin_film_thickness | InputFloat | Thin Film Thickness | 0.0 |
| thin_film_ior | InputFloat | Thin Film IOR | 1.33 |
Attributes
| Name | Description |
|---|---|
distribution |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
subsurface_method |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.base_color |
ColorSocket |
Base Color |
i.metallic |
FloatSocket |
Metallic |
i.roughness |
FloatSocket |
Roughness |
i.ior |
FloatSocket |
IOR |
i.alpha |
FloatSocket |
Alpha |
i.thin_wall |
BooleanSocket |
Thin Wall |
i.normal |
VectorSocket |
Normal |
i.diffuse_roughness |
FloatSocket |
Diffuse Roughness |
i.subsurface_weight |
FloatSocket |
Subsurface Weight |
i.subsurface_radius |
VectorSocket |
Subsurface Radius |
i.subsurface_scale |
FloatSocket |
Subsurface Scale |
i.subsurface_ior |
FloatSocket |
Subsurface IOR |
i.subsurface_anisotropy |
FloatSocket |
Subsurface Anisotropy |
i.specular_ior_level |
FloatSocket |
Specular IOR Level |
i.specular_tint |
ColorSocket |
Specular Tint |
i.anisotropic |
FloatSocket |
Anisotropic |
i.anisotropic_rotation |
FloatSocket |
Anisotropic Rotation |
i.tangent |
VectorSocket |
Tangent |
i.transmission_weight |
FloatSocket |
Transmission Weight |
i.transmission_dispersion_scale |
FloatSocket |
Transmission Dispersion Scale |
i.transmission_dispersion_abbe_number |
FloatSocket |
Transmission Dispersion Abbe Number |
i.coat_weight |
FloatSocket |
Coat Weight |
i.coat_roughness |
FloatSocket |
Coat Roughness |
i.coat_ior |
FloatSocket |
Coat IOR |
i.coat_tint |
ColorSocket |
Coat Tint |
i.coat_normal |
VectorSocket |
Coat Normal |
i.sheen_weight |
FloatSocket |
Sheen Weight |
i.sheen_roughness |
FloatSocket |
Sheen Roughness |
i.sheen_tint |
ColorSocket |
Sheen Tint |
i.emission_color |
ColorSocket |
Emission Color |
i.emission_strength |
FloatSocket |
Emission Strength |
i.thin_film_thickness |
FloatSocket |
Thin Film Thickness |
i.thin_film_ior |
FloatSocket |
Thin Film IOR |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
PrincipledHairBSDF
PrincipledHairBSDF(
color=(0.017513, 0.005763, 0.002059, 1.0),
melanin=0.8,
melanin_redness=1.0,
tint=(1.0, 1.0, 1.0, 1.0),
absorption_coefficient=(0.245531, 0.52, 1.365),
aspect_ratio=0.85,
roughness=0.3,
radial_roughness=0.3,
coat=0.0,
ior=1.55,
offset=0.034906585,
random_color=0.0,
random_roughness=0.0,
random=None,
reflection=1.0,
transmission=1.0,
secondary_reflection=1.0,
*,
model='CHIANG',
parametrization='COLOR',
)Physically-based, easy-to-use shader for rendering hair and fur
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (0.017513, 0.005763, 0.002059, 1.0) |
| melanin | InputFloat | Melanin | 0.8 |
| melanin_redness | InputFloat | Melanin Redness | 1.0 |
| tint | InputColor | Tint | (1.0, 1.0, 1.0, 1.0) |
| absorption_coefficient | InputVector | Absorption Coefficient | (0.245531, 0.52, 1.365) |
| aspect_ratio | InputFloat | Aspect Ratio | 0.85 |
| roughness | InputFloat | Roughness | 0.3 |
| radial_roughness | InputFloat | Radial Roughness | 0.3 |
| coat | InputFloat | Coat | 0.0 |
| ior | InputFloat | IOR | 1.55 |
| offset | InputFloat | Offset | 0.034906585 |
| random_color | InputFloat | Random Color | 0.0 |
| random_roughness | InputFloat | Random Roughness | 0.0 |
| random | InputFloat | Random | None |
| reflection | InputFloat | Reflection. Renamed from R lobe; i.r_lobe still resolves to it. |
1.0 |
| transmission | InputFloat | Transmission. Renamed from TT lobe; i.tt_lobe still resolves to it. |
1.0 |
| secondary_reflection | InputFloat | Secondary Reflection. Renamed from TRT lobe; i.trt_lobe still resolves to it. |
1.0 |
Attributes
| Name | Description |
|---|---|
i |
|
model |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
parametrization |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.melanin |
FloatSocket |
Melanin |
i.melanin_redness |
FloatSocket |
Melanin Redness |
i.tint |
ColorSocket |
Tint |
i.absorption_coefficient |
VectorSocket |
Absorption Coefficient |
i.aspect_ratio |
FloatSocket |
Aspect Ratio |
i.roughness |
FloatSocket |
Roughness |
i.radial_roughness |
FloatSocket |
Radial Roughness |
i.coat |
FloatSocket |
Coat |
i.ior |
FloatSocket |
IOR |
i.offset |
FloatSocket |
Offset |
i.random_color |
FloatSocket |
Random Color |
i.random_roughness |
FloatSocket |
Random Roughness |
i.random |
FloatSocket |
Random |
i.reflection |
FloatSocket |
Reflection. Renamed from R lobe; i.r_lobe still resolves to it. |
i.transmission |
FloatSocket |
Transmission. Renamed from TT lobe; i.tt_lobe still resolves to it. |
i.secondary_reflection |
FloatSocket |
Secondary Reflection. Renamed from TRT lobe; i.trt_lobe still resolves to it. |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
RayPortalBSDF
RayPortalBSDF(color=(1.0, 1.0, 1.0, 1.0), position=None, direction=None)Continue tracing from an arbitrary new position and in a new direction
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (1.0, 1.0, 1.0, 1.0) |
| position | InputVector | Position | None |
| direction | InputVector | Direction | None |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.position |
VectorSocket |
Position |
i.direction |
VectorSocket |
Direction |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
RefractionBSDF
RefractionBSDF(
color=(1.0, 1.0, 1.0, 1.0),
roughness=0.0,
ior=1.45,
normal=None,
*,
distribution='BECKMANN',
)Glossy refraction with sharp or microfacet distribution, typically used for materials that transmit light
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (1.0, 1.0, 1.0, 1.0) |
| roughness | InputFloat | Roughness | 0.0 |
| ior | InputFloat | IOR | 1.45 |
| normal | InputVector | Normal | None |
Attributes
| Name | Description |
|---|---|
distribution |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.roughness |
FloatSocket |
Roughness |
i.ior |
FloatSocket |
IOR |
i.normal |
VectorSocket |
Normal |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
SheenBSDF
SheenBSDF(
color=(0.8, 0.8, 0.8, 1.0),
roughness=0.5,
normal=None,
*,
distribution='MICROFIBER',
)Reflection for materials such as cloth.
Typically mixed with other shaders (such as a Diffuse Shader) and is not particularly useful on its own
Parameters
color : InputColor
Color
roughness : InputFloat
Roughness
normal : InputVector
Normal
Inputs
i.color : ColorSocket
Color
i.roughness : FloatSocket
Roughness
i.normal : VectorSocket
Normal
Outputs
o.bsdf : ShaderSocket
BSDF
Attributes
| Name | Description |
|---|---|
distribution |
|
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.
SpecularBSDF
SpecularBSDF(
base_color=(0.8, 0.8, 0.8, 1.0),
specular=(0.03, 0.03, 0.03, 1.0),
roughness=0.2,
emissive_color=(0.0, 0.0, 0.0, 1.0),
transparency=0.0,
normal=None,
clear_coat=0.0,
clear_coat_roughness=0.0,
clear_coat_normal=None,
)Similar to the Principled BSDF node but uses the specular workflow instead of metallic, which functions by specifying the facing (along normal) reflection color. Energy is not conserved, so the result may not be physically accurate
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| base_color | InputColor | Base Color | (0.8, 0.8, 0.8, 1.0) |
| specular | InputColor | Specular | (0.03, 0.03, 0.03, 1.0) |
| roughness | InputFloat | Roughness | 0.2 |
| emissive_color | InputColor | Emissive Color | (0.0, 0.0, 0.0, 1.0) |
| transparency | InputFloat | Transparency | 0.0 |
| normal | InputVector | Normal | None |
| clear_coat | InputFloat | Clear Coat | 0.0 |
| clear_coat_roughness | InputFloat | Clear Coat Roughness | 0.0 |
| clear_coat_normal | InputVector | Clear Coat Normal | None |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.base_color |
ColorSocket |
Base Color |
i.specular |
ColorSocket |
Specular |
i.roughness |
FloatSocket |
Roughness |
i.emissive_color |
ColorSocket |
Emissive Color |
i.transparency |
FloatSocket |
Transparency |
i.normal |
VectorSocket |
Normal |
i.clear_coat |
FloatSocket |
Clear Coat |
i.clear_coat_roughness |
FloatSocket |
Clear Coat Roughness |
i.clear_coat_normal |
VectorSocket |
Clear Coat Normal |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
SubsurfaceScattering
SubsurfaceScattering(
color=(0.8, 0.8, 0.8, 1.0),
scale=0.005,
radius=(1.0, 0.2, 0.1),
ior=1.4,
roughness=1.0,
anisotropy=0.0,
normal=None,
*,
falloff='RANDOM_WALK',
)Subsurface multiple scattering shader to simulate light entering the surface and bouncing internally.
Typically used for materials such as skin, wax, marble or milk
Parameters
color : InputColor
Color
scale : InputFloat
Scale
radius : InputVector
Radius
ior : InputFloat
IOR
roughness : InputFloat
Roughness
anisotropy : InputFloat
Anisotropy
normal : InputVector
Normal
Inputs
i.color : ColorSocket
Color
i.scale : FloatSocket
Scale
i.radius : VectorSocket
Radius
i.ior : FloatSocket
IOR
i.roughness : FloatSocket
Roughness
i.anisotropy : FloatSocket
Anisotropy
i.normal : VectorSocket
Normal
Outputs
o.bssrdf : ShaderSocket
BSSRDF
Attributes
| Name | Description |
|---|---|
falloff |
|
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.
ToonBSDF
ToonBSDF(
color=(0.8, 0.8, 0.8, 1.0),
size=0.5,
smooth=0.0,
normal=None,
*,
component='DIFFUSE',
)Diffuse and Glossy shaders with cartoon light effects
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (0.8, 0.8, 0.8, 1.0) |
| size | InputFloat | Size | 0.5 |
| smooth | InputFloat | Smooth | 0.0 |
| normal | InputVector | Normal | None |
Attributes
| Name | Description |
|---|---|
component |
|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.size |
FloatSocket |
Size |
i.smooth |
FloatSocket |
Smooth |
i.normal |
VectorSocket |
Normal |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
TranslucentBSDF
TranslucentBSDF(color=(0.8, 0.8, 0.8, 1.0), normal=None)Lambertian diffuse transmission
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (0.8, 0.8, 0.8, 1.0) |
| normal | InputVector | Normal | None |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
i.normal |
VectorSocket |
Normal |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |
TransparentBSDF
TransparentBSDF(color=(1.0, 1.0, 1.0, 1.0))Transparency without refraction, passing straight through the surface as if there were no geometry
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| color | InputColor | Color | (1.0, 1.0, 1.0, 1.0) |
Attributes
| Name | Description |
|---|---|
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.
Inputs
| Attribute | Type | Description |
|---|---|---|
i.color |
ColorSocket |
Color |
Outputs
| Attribute | Type | Description |
|---|---|---|
o.bsdf |
ShaderSocket |
BSDF |