Blender V4.5
Public Member Functions | Public Attributes | List of all members
ShaderNode Class Referenceabstract

#include <shader_graph.h>

Inherits Node.

Inherited by AddClosureNode, AmbientOcclusionNode, AttributeNode, BackgroundNode, BevelNode, BlackbodyNode, BrightContrastNode, BsdfBaseNode, BumpNode, CameraNode, ClampNode, ColorNode, CombineColorNode, CombineHSVNode, CombineRGBNode, CombineXYZNode, ConvertNode, CurvesNode, DisplacementNode, EmissionNode, FloatCurveNode, FresnelNode, GammaNode, GeometryNode, HSVNode, HairInfoNode, HoldoutNode, InvertNode, LayerWeightNode, LightFalloffNode, LightPathNode, MapRangeNode, MappingNode, MathNode, MixClosureNode, MixClosureWeightNode, MixColorNode, MixFloatNode, MixNode, MixVectorNode, MixVectorNonUniformNode, NormalMapNode, NormalNode, OSLNode, ObjectInfoNode, OutputAOVNode, OutputNode, ParticleInfoNode, PointDensityTextureNode, PointInfoNode, RGBRampNode, RGBToBWNode, SeparateColorNode, SeparateHSVNode, SeparateRGBNode, SeparateXYZNode, SetNormalNode, TangentNode, TextureCoordinateNode, TextureNode, UVMapNode, ValueNode, VectorDisplacementNode, VectorMapRangeNode, VectorMathNode, VectorRotateNode, VectorTransformNode, VertexColorNode, VolumeInfoNode, VolumeNode, WavelengthNode, WhiteNoiseTextureNode, and WireframeNode.

Public Member Functions

 ShaderNode (const NodeType *type)
 
 ShaderNode (const ShaderNode &other)
 
void create_inputs_outputs (const NodeType *type)
 
void remove_input (ShaderInput *input)
 
ShaderInput * input (const char *name)
 
ShaderOutput * output (const char *name)
 
ShaderInput * input (ustring name)
 
ShaderOutput * output (ustring name)
 
virtual ShaderNode * clone (ShaderGraph *graph) const =0
 
virtual void attributes (Shader *shader, AttributeRequestSet *attributes)
 
virtual void compile (SVMCompiler &compiler)=0
 
virtual void compile (OSLCompiler &compiler)=0
 
virtual void expand (ShaderGraph *)
 
virtual void constant_fold (const ConstantFolder &)
 
virtual void simplify_settings (Scene *)
 
virtual bool has_surface_emission ()
 
virtual bool has_surface_transparent ()
 
virtual bool has_surface_bssrdf ()
 
virtual bool has_bump ()
 
virtual bool has_bssrdf_bump ()
 
virtual bool has_spatial_varying ()
 
virtual bool has_attribute_dependency ()
 
virtual bool has_volume_support ()
 
virtual int get_feature ()
 
virtual ClosureType get_closure_type ()
 
virtual bool equals (const ShaderNode &other)
 
- Public Member Functions inherited from Node
 Node (const NodeType *type, ustring name=ustring())
 
virtual ~Node ()=0
 
void set (const SocketType &input, bool value)
 
void set (const SocketType &input, const int value)
 
void set (const SocketType &input, const uint value)
 
void set (const SocketType &input, const uint64_t value)
 
void set (const SocketType &input, const float value)
 
void set (const SocketType &input, const float2 value)
 
void set (const SocketType &input, const float3 value)
 
void set (const SocketType &input, const char *value)
 
void set (const SocketType &input, ustring value)
 
void set (const SocketType &input, const Transform &value)
 
void set (const SocketType &input, Node *value)
 
template<class ValueType , std::enable_if_t< std::is_enum_v< ValueType >, bool > = true>
void set (const SocketType &input, const ValueType &value)
 
void set (const SocketType &input, array< bool > &value)
 
void set (const SocketType &input, array< int > &value)
 
void set (const SocketType &input, array< float > &value)
 
void set (const SocketType &input, array< float2 > &value)
 
void set (const SocketType &input, array< float3 > &value)
 
void set (const SocketType &input, array< ustring > &value)
 
void set (const SocketType &input, array< Transform > &value)
 
void set (const SocketType &input, array< Node * > &value)
 
bool get_bool (const SocketType &input) const
 
int get_int (const SocketType &input) const
 
uint get_uint (const SocketType &input) const
 
uint64_t get_uint64 (const SocketType &input) const
 
float get_float (const SocketType &input) const
 
float2 get_float2 (const SocketType &input) const
 
float3 get_float3 (const SocketType &input) const
 
ustring get_string (const SocketType &input) const
 
Transform get_transform (const SocketType &input) const
 
Node * get_node (const SocketType &input) const
 
const array< bool > & get_bool_array (const SocketType &input) const
 
const array< int > & get_int_array (const SocketType &input) const
 
const array< float > & get_float_array (const SocketType &input) const
 
const array< float2 > & get_float2_array (const SocketType &input) const
 
const array< float3 > & get_float3_array (const SocketType &input) const
 
const array< ustring > & get_string_array (const SocketType &input) const
 
const array< Transform > & get_transform_array (const SocketType &input) const
 
const array< Node * > & get_node_array (const SocketType &input) const
 
bool has_default_value (const SocketType &input) const
 
void set_default_value (const SocketType &input)
 
bool equals_value (const Node &other, const SocketType &socket) const
 
void copy_value (const SocketType &socket, const Node &other, const SocketType &other_socket)
 
void set_value (const SocketType &socket, const Node &other, const SocketType &other_socket)
 
bool equals (const Node &other) const
 
void hash (MD5Hash &md5)
 
size_t get_total_size_in_bytes () const
 
bool is_a (const NodeType *type)
 
bool socket_is_modified (const SocketType &input) const
 
bool is_modified () const
 
void tag_modified ()
 
void clear_modified ()
 
void print_modified_sockets () const
 
const NodeOwner * get_owner () const
 
void set_owner (const NodeOwner *owner_)
 
int reference_count () const
 
void reference ()
 
void dereference ()
 
void clear_reference_count ()
 

Public Attributes

unique_ptr_vector< ShaderInput > inputs
 
unique_ptr_vector< ShaderOutput > outputs
 
int id = -1
 
ShaderBump bump = SHADER_BUMP_NONE
 
float bump_filter_width = 0.0f
 
ShaderNodeSpecialType special_type = SHADER_SPECIAL_TYPE_NONE
 
- Public Attributes inherited from Node
ustring name
 
const NodeType * type
 
InternalNode internal
 
LeafNode leaf
 

Additional Inherited Members

- Protected Member Functions inherited from Node
template<typename T >
void set_if_different (const SocketType &input, T value)
 
void set_if_different (const SocketType &input, Node *value)
 
template<typename T >
void set_if_different (const SocketType &input, array< T > &value)
 
void set_if_different (const SocketType &input, array< Node * > &value)
 
void dereference_all_used_nodes ()
 
- Static Protected Member Functions inherited from Node
template<typename T >
static T & get_socket_value (const Node *node, const SocketType &socket)
 
- Protected Attributes inherited from Node
const NodeOwner * owner
 
int ref_count {0}
 
SocketModifiedFlags socket_modified
 

Detailed Description

Definition at line 146 of file shader_graph.h.

Constructor & Destructor Documentation

◆ ShaderNode() [1/2]

ShaderNode::ShaderNode ( const NodeType * type)
explicit

Definition at line 67 of file shader_graph.cpp.

References create_inputs_outputs(), and Node::type.

◆ ShaderNode() [2/2]

ShaderNode::ShaderNode ( const ShaderNode & other)

Definition at line 72 of file shader_graph.cpp.

References create_inputs_outputs(), Node::name, and Node::type.

Member Function Documentation

◆ attributes()

void ShaderNode::attributes ( Shader * shader,
AttributeRequestSet * attributes )
virtual

Reimplemented in AttributeNode, EnvironmentTextureNode, GeometryNode, GlossyBsdfNode, HairInfoNode, ImageTextureNode, MetallicBsdfNode, NormalMapNode, OSLNode, ParticleInfoNode, PointDensityTextureNode, PointInfoNode, PrincipledBsdfNode, PrincipledHairBsdfNode, PrincipledVolumeNode, TangentNode, TextureCoordinateNode, UVMapNode, VectorDisplacementNode, VertexColorNode, and VolumeInfoNode.

Definition at line 143 of file shader_graph.cpp.

References ATTR_STD_GENERATED, ATTR_STD_GENERATED_TRANSFORM, ATTR_STD_UV, attributes(), Shader::has_surface_link(), Shader::has_volume, input, inputs, SocketType::LINK_TEXTURE_GENERATED, and SocketType::LINK_TEXTURE_UV.

Referenced by AttributeNode::attributes(), EnvironmentTextureNode::attributes(), GeometryNode::attributes(), GlossyBsdfNode::attributes(), HairInfoNode::attributes(), ImageTextureNode::attributes(), MetallicBsdfNode::attributes(), NormalMapNode::attributes(), OSLNode::attributes(), ParticleInfoNode::attributes(), PointDensityTextureNode::attributes(), PointInfoNode::attributes(), PrincipledBsdfNode::attributes(), PrincipledHairBsdfNode::attributes(), PrincipledVolumeNode::attributes(), attributes(), TangentNode::attributes(), TextureCoordinateNode::attributes(), UVMapNode::attributes(), VectorDisplacementNode::attributes(), VertexColorNode::attributes(), and VolumeInfoNode::attributes().

◆ clone()

virtual ShaderNode * ShaderNode::clone ( ShaderGraph * graph) const
pure virtual

Implemented in EnvironmentTextureNode, IESLightNode, ImageTextureNode, OSLNode, and PointDensityTextureNode.

Referenced by ShaderGraph::copy_nodes().

◆ compile() [1/2]

virtual void ShaderNode::compile ( OSLCompiler & compiler)
pure virtual

◆ compile() [2/2]

virtual void ShaderNode::compile ( SVMCompiler & compiler)
pure virtual

◆ constant_fold()

virtual void ShaderNode::constant_fold ( const ConstantFolder & )
inlinevirtual

Reimplemented in AddClosureNode, BackgroundNode, BlackbodyNode, BrightContrastNode, BumpNode, ClampNode, ColorNode, CombineColorNode, CombineHSVNode, CombineRGBNode, CombineXYZNode, ConvertNode, CurvesNode, DisplacementNode, EmissionNode, FloatCurveNode, GammaNode, InvertNode, MappingNode, MathNode, MixClosureNode, MixColorNode, MixFloatNode, MixNode, MixVectorNode, MixVectorNonUniformNode, RGBCurvesNode, RGBRampNode, RGBToBWNode, SeparateColorNode, SeparateHSVNode, SeparateRGBNode, SeparateXYZNode, ValueNode, VectorCurvesNode, VectorDisplacementNode, and VectorMathNode.

Definition at line 169 of file shader_graph.h.

◆ create_inputs_outputs()

void ShaderNode::create_inputs_outputs ( const NodeType * type)

Definition at line 80 of file shader_graph.cpp.

References NodeType::inputs, inputs, SocketType::LINKABLE, NodeType::outputs, outputs, unique_ptr_vector< T >::push_back(), and Node::type.

Referenced by ShaderNode(), and ShaderNode().

◆ equals()

bool ShaderNode::equals ( const ShaderNode & other)
virtual

Reimplemented in BsdfBaseNode, EnvironmentTextureNode, ImageSlotTextureNode, ImageTextureNode, OSLNode, OutputAOVNode, OutputNode, PointDensityTextureNode, and VolumeNode.

Definition at line 164 of file shader_graph.cpp.

References assert, bump, Node::equals_value(), NodeType::inputs, inputs, ShaderInput::link, SocketType::LINKABLE, unique_ptr_vector< T >::size(), ShaderInput::socket_type, and Node::type.

Referenced by PointDensityTextureNode::equals().

◆ expand()

virtual void ShaderNode::expand ( ShaderGraph * )
inlinevirtual

Reimplemented in MapRangeNode, MathNode, VectorMapRangeNode, and VolumeInfoNode.

Definition at line 165 of file shader_graph.h.

◆ get_closure_type()

virtual ClosureType ShaderNode::get_closure_type ( )
inlinevirtual

Reimplemented in BsdfBaseNode, GlassBsdfNode, GlossyBsdfNode, HairBsdfNode, HoldoutNode, MetallicBsdfNode, RefractionBsdfNode, SheenBsdfNode, SubsurfaceScatteringNode, and VolumeNode.

Definition at line 235 of file shader_graph.h.

References CLOSURE_NONE_ID.

◆ get_feature()

virtual int ShaderNode::get_feature ( )
inlinevirtual

Reimplemented in AmbientOcclusionNode, BackgroundNode, BevelNode, BsdfBaseNode, BumpNode, DisplacementNode, EmissionNode, OSLNode, PrincipledHairBsdfNode, VectorDisplacementNode, VolumeNode, and VoronoiTextureNode.

Definition at line 229 of file shader_graph.h.

References bump, KERNEL_FEATURE_NODE_BUMP, and SHADER_BUMP_NONE.

Referenced by BackgroundNode::get_feature(), BsdfBaseNode::get_feature(), EmissionNode::get_feature(), OSLNode::get_feature(), VolumeNode::get_feature(), and VoronoiTextureNode::get_feature().

◆ has_attribute_dependency()

virtual bool ShaderNode::has_attribute_dependency ( )
inlinevirtual

Reimplemented in AttributeNode, EnvironmentTextureNode, GeometryNode, GlossyBsdfNode, HairInfoNode, ImageTextureNode, MetallicBsdfNode, NormalMapNode, ParticleInfoNode, PointDensityTextureNode, PointInfoNode, PrincipledBsdfNode, PrincipledVolumeNode, TangentNode, TextureCoordinateNode, UVMapNode, VectorDisplacementNode, VertexColorNode, and VolumeInfoNode.

Definition at line 200 of file shader_graph.h.

◆ has_bssrdf_bump()

virtual bool ShaderNode::has_bssrdf_bump ( )
inlinevirtual

Reimplemented in PrincipledBsdfNode, and SubsurfaceScatteringNode.

Definition at line 192 of file shader_graph.h.

◆ has_bump()

virtual bool ShaderNode::has_bump ( )
inlinevirtual

Reimplemented in BsdfBaseNode.

Definition at line 188 of file shader_graph.h.

◆ has_spatial_varying()

virtual bool ShaderNode::has_spatial_varying ( )
inlinevirtual

Reimplemented in AmbientOcclusionNode, AttributeNode, BevelNode, BsdfBaseNode, BumpNode, CameraNode, FresnelNode, GeometryNode, HairInfoNode, LayerWeightNode, LightFalloffNode, NormalMapNode, OSLNode, PointDensityTextureNode, PointInfoNode, TangentNode, TextureCoordinateNode, UVMapNode, VertexColorNode, VolumeInfoNode, and WireframeNode.

Definition at line 196 of file shader_graph.h.

◆ has_surface_bssrdf()

virtual bool ShaderNode::has_surface_bssrdf ( )
inlinevirtual

Reimplemented in PrincipledBsdfNode, and SubsurfaceScatteringNode.

Definition at line 184 of file shader_graph.h.

◆ has_surface_emission()

virtual bool ShaderNode::has_surface_emission ( )
inlinevirtual

Reimplemented in EmissionNode, OSLNode, and PrincipledBsdfNode.

Definition at line 176 of file shader_graph.h.

◆ has_surface_transparent()

virtual bool ShaderNode::has_surface_transparent ( )
inlinevirtual

Reimplemented in PrincipledBsdfNode, PrincipledHairBsdfNode, RayPortalBsdfNode, and TransparentBsdfNode.

Definition at line 180 of file shader_graph.h.

◆ has_volume_support()

virtual bool ShaderNode::has_volume_support ( )
inlinevirtual

Reimplemented in EmissionNode, OSLNode, and VolumeNode.

Definition at line 204 of file shader_graph.h.

◆ input() [1/2]

ShaderInput * ShaderNode::input ( const char * name)

Definition at line 93 of file shader_graph.cpp.

References inputs, and Node::name.

Referenced by CCL_NAMESPACE_BEGIN::ShaderGraphBuilder::add_connection(), ShaderGraph::bump_from_displacement(), ShaderGraph::compute_displacement_hash(), ShaderGraph::constant_fold(), ShaderGraph::copy_nodes(), ShaderGraph::default_inputs(), LightManager::device_update_background(), MapRangeNode::expand(), MathNode::expand(), ShaderGraph::finalize(), ConstantFolder::fold_mapping(), ConstantFolder::fold_math(), ConstantFolder::fold_mix(), ConstantFolder::fold_mix_color(), ConstantFolder::fold_mix_float(), ConstantFolder::fold_vector_math(), ShaderManager::get_kernel_features(), ShaderGraph::transform_multi_closure(), and ShaderGraph::verify_volume_output().

◆ input() [2/2]

ShaderInput * ShaderNode::input ( ustring name)

Definition at line 115 of file shader_graph.cpp.

References inputs, and Node::name.

◆ output() [1/2]

ShaderOutput * ShaderNode::output ( const char * name)

Definition at line 104 of file shader_graph.cpp.

References Node::name, and outputs.

Referenced by CCL_NAMESPACE_BEGIN::ShaderGraphBuilder::add_connection(), ShaderManager::add_default(), add_nodes(), ShaderGraph::bump_from_displacement(), SVMCompiler::compile_type(), BumpNode::constant_fold(), ShaderGraph::copy_nodes(), ShaderGraph::default_inputs(), LightManager::device_update_background(), ShaderManager::device_update_pre(), MapRangeNode::expand(), MathNode::expand(), VolumeInfoNode::expand(), Shader::tag_update(), and ShaderGraph::transform_multi_closure().

◆ output() [2/2]

ShaderOutput * ShaderNode::output ( ustring name)

Definition at line 126 of file shader_graph.cpp.

References Node::name, and outputs.

◆ remove_input()

void ShaderNode::remove_input ( ShaderInput * input)

Definition at line 137 of file shader_graph.cpp.

References assert, unique_ptr_vector< T >::erase(), input, and inputs.

◆ simplify_settings()

virtual void ShaderNode::simplify_settings ( Scene * )
inlinevirtual

Reimplemented in GlossyBsdfNode, MetallicBsdfNode, OutputAOVNode, PrincipledBsdfNode, and SkyTextureNode.

Definition at line 174 of file shader_graph.h.

Member Data Documentation

◆ bump

ShaderBump ShaderNode::bump = SHADER_BUMP_NONE

Definition at line 214 of file shader_graph.h.

Referenced by ShaderGraph::bump_from_displacement(), equals(), get_feature(), and ShaderGraph::refine_bump_nodes().

◆ bump_filter_width

float ShaderNode::bump_filter_width = 0.0f

Definition at line 215 of file shader_graph.h.

◆ id

int ShaderNode::id = -1

Definition at line 212 of file shader_graph.h.

Referenced by ShaderGraph::break_cycles(), ShaderNodeIDComparator::operator()(), and ShaderGraph::remove_proxy_nodes().

◆ inputs

unique_ptr_vector<ShaderInput> ShaderNode::inputs

Definition at line 208 of file shader_graph.h.

Referenced by add_nodes(), ConstantFolder::all_inputs_constant(), OSLNode::attributes(), attributes(), OSLNode::clone(), ConvertNode::constant_fold(), create_inputs_outputs(), equals(), SVMCompiler::generate_multi_closure(), input(), input(), remove_input(), ShaderGraph::remove_proxy_nodes(), ConstantFolder::try_bypass_or_make_constant(), and xml_read_shader_graph().

◆ outputs

unique_ptr_vector<ShaderOutput> ShaderNode::outputs

Definition at line 209 of file shader_graph.h.

Referenced by add_node(), add_nodes(), SeparateColorNode::constant_fold(), SeparateHSVNode::constant_fold(), SeparateRGBNode::constant_fold(), SeparateXYZNode::constant_fold(), create_inputs_outputs(), ShaderGraph::deduplicate_nodes(), output(), output(), ShaderGraph::remove_proxy_nodes(), and xml_read_shader_graph().

◆ special_type

ShaderNodeSpecialType ShaderNode::special_type = SHADER_SPECIAL_TYPE_NONE

Definition at line 217 of file shader_graph.h.

Referenced by BsdfBaseNode::BsdfBaseNode(), ConvertNode::constant_fold(), ConvertNode::ConvertNode(), SubsurfaceScatteringNode::has_bssrdf_bump(), BsdfBaseNode::has_bump(), ImageSlotTextureNode::ImageSlotTextureNode(), and ShaderGraph::remove_proxy_nodes().

The documentation for this class was generated from the following files:
Generated on Fri Apr 3 2026 06:33:18 for Blender by  doxygen 1.11.0