Blender V5.3
ShaderNode Class Referenceabstract

#include <shader_graph.h>

Inherits Node.

Inherited by AddClosureNode, AmbientOcclusionNode, AttributeNode, BackgroundNode, BevelNode, BlackbodyNode, BooleanMathNode, BrightContrastNode, BsdfBaseNode, BumpNode, CameraNode, ClampNode, ColorNode, CombineColorNode, CombineXYZNode, ConvertNode, CurvesNode, DisplacementNode, EmissionNode, FloatCurveNode, FresnelNode, GammaNode, GeometryNode, GetVectorComponentNode, HSVNode, HairInfoNode, HoldoutNode, IntegerMathNode, InvertNode, LayerWeightNode, LightFalloffNode, LightPathNode, MapRangeNode, MappingNode, MathNode, MixClosureNode, MixClosureWeightNode, MixColorNode, MixFloatNode, MixNode, MixVectorNode, MixVectorNonUniformNode, NormalMapNode, NormalNode, OSLNode, ObjectInfoNode, OutputAOVNode, OutputNode, ParticleInfoNode, PointInfoNode, RGBRampNode, RGBToBWNode, RadialTilingNode, RaycastNode, SceneTimeNode, SeparateColorNode, 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 global_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_dispersion ()
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 bool is_linear_operation ()
virtual ShaderNodeType shader_node_type () const
virtual bool is_texture_node_and_needs_derivatives (const SVMCompiler &)
bool need_derivatives () const
void set_need_derivatives (const bool need_derivatives=true)
virtual uint64_t 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< packed_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< packed_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
bool added_to_svm = false
Public Attributes inherited from Node
ustring name
const NodeType * type
InternalNode internal
LeafNode leaf

Protected Member Functions

void disconnect_unused_input (const char *name)
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 ()

Protected Attributes

bool need_derivatives_ = false
Protected Attributes inherited from Node
const NodeOwner * owner
int ref_count {0}
SocketModifiedFlags socket_modified

Additional Inherited Members

Static Protected Member Functions inherited from Node
template<typename T>
static T & get_socket_value (const Node *node, const SocketType &socket)

Detailed Description

Definition at line 145 of file shader_graph.h.

Constructor & Destructor Documentation

◆ ShaderNode() [1/2]

◆ ShaderNode() [2/2]

ShaderNode::ShaderNode ( const ShaderNode & other)

Member Function Documentation

◆ attributes()

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

◆ clone()

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

◆ compile() [1/2]

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

◆ compile() [2/2]

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

◆ constant_fold()

◆ create_inputs_outputs()

void ShaderNode::create_inputs_outputs ( const NodeType * type)

◆ disconnect_unused_input()

void ShaderNode::disconnect_unused_input ( const char * name)
protected

◆ equals()

◆ expand()

virtual void ShaderNode::expand ( ShaderGraph * )
inlinevirtual

Reimplemented in MapRangeNode, MathNode, VectorMapRangeNode, VertexColorNode, and VolumeInfoNode.

Definition at line 165 of file shader_graph.h.

◆ get_closure_type()

virtual ClosureType ShaderNode::get_closure_type ( )
inlinevirtual

◆ get_feature()

◆ global_attributes()

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

Reimplemented in RaycastNode.

Definition at line 172 of file shader_graph.cpp.

Referenced by clone(), and RaycastNode::global_attributes().

◆ has_attribute_dependency()

◆ has_bssrdf_bump()

virtual bool ShaderNode::has_bssrdf_bump ( )
inlinevirtual

Reimplemented in PrincipledBsdfNode, and SubsurfaceScatteringNode.

Definition at line 196 of file shader_graph.h.

◆ has_bump()

virtual bool ShaderNode::has_bump ( )
inlinevirtual

Reimplemented in BsdfBaseNode.

Definition at line 192 of file shader_graph.h.

◆ has_dispersion()

virtual bool ShaderNode::has_dispersion ( )
inlinevirtual

Reimplemented in PrincipledBsdfNode.

Definition at line 188 of file shader_graph.h.

◆ has_spatial_varying()

◆ 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

◆ has_volume_support()

virtual bool ShaderNode::has_volume_support ( )
inlinevirtual

Reimplemented in EmissionNode, OSLNode, and VolumeNode.

Definition at line 208 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(), ShaderManager::add_default(), AddInstanceIdAOV(), GlassBsdfNode::attributes(), GlossyBsdfNode::attributes(), MetallicBsdfNode::attributes(), PrincipledBsdfNode::attributes(), PrincipledHairBsdfNode::attributes(), PrincipledVolumeNode::attributes(), attributes(), ShaderGraph::bump_from_displacement(), VolumeNode::compile(), ShaderGraph::compute_displacement_hash(), AddClosureNode::constant_fold(), BackgroundNode::constant_fold(), BumpNode::constant_fold(), CurvesNode::constant_fold(), EmissionNode::constant_fold(), FloatCurveNode::constant_fold(), GammaNode::constant_fold(), InvertNode::constant_fold(), MixClosureNode::constant_fold(), RGBCurvesNode::constant_fold(), ShaderGraph::constant_fold(), VectorCurvesNode::constant_fold(), ShaderGraph::copy_nodes(), ImageTextureNode::cull_tiles(), ShaderGraph::default_inputs(), LightManager::device_update_background(), disconnect_unused_input(), 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(), SubsurfaceScatteringNode::has_bssrdf_bump(), BsdfBaseNode::has_bump(), PrincipledBsdfNode::has_nonzero_weight(), PrincipledBsdfNode::has_surface_emission(), PrincipledBsdfNode::has_surface_transparent(), PrincipledHairBsdfNode::has_surface_transparent(), SVMCompiler::input_float(), SVMCompiler::input_float3(), SVMCompiler::input_int(), SVMCompiler::input_link(), GlassBsdfNode::is_isotropic(), GlossyBsdfNode::is_isotropic(), MetallicBsdfNode::is_isotropic(), MapRangeNode::is_linear_operation(), MathNode::is_linear_operation(), MixColorNode::is_linear_operation(), MixFloatNode::is_linear_operation(), MixNode::is_linear_operation(), MixVectorNode::is_linear_operation(), MixVectorNonUniformNode::is_linear_operation(), VectorMapRangeNode::is_linear_operation(), VectorMathNode::is_linear_operation(), PrincipledBsdfNode::is_thin_wall(), ShaderGraph::optimize_volume_output(), remove_input(), OutputAOVNode::simplify_settings(), PrincipledBsdfNode::subsurface_has_positive_weight(), and ShaderGraph::transform_multi_closure().

◆ input() [2/2]

ShaderInput * ShaderNode::input ( ustring name)

Definition at line 115 of file shader_graph.cpp.

References inputs, and Node::name.

◆ is_linear_operation()

◆ is_texture_node_and_needs_derivatives()

virtual bool ShaderNode::is_texture_node_and_needs_derivatives ( const SVMCompiler & )
inlinevirtual

Reimplemented in ImageSlotTextureNode.

Definition at line 221 of file shader_graph.h.

◆ need_derivatives()

bool ShaderNode::need_derivatives ( ) const
inline

◆ output() [1/2]

◆ 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)

◆ set_need_derivatives()

void ShaderNode::set_need_derivatives ( const bool need_derivatives = true)
inline

◆ shader_node_type()

◆ simplify_settings()

virtual void ShaderNode::simplify_settings ( Scene * )
inlinevirtual

Member Data Documentation

◆ added_to_svm

bool ShaderNode::added_to_svm = false

Definition at line 278 of file shader_graph.h.

Referenced by SVMCompiler::input_link().

◆ bump

ShaderBump ShaderNode::bump = SHADER_BUMP_NONE

Definition at line 240 of file shader_graph.h.

Referenced by equals(), get_feature(), and ShaderNode().

◆ bump_filter_width

float ShaderNode::bump_filter_width = 0.0f

Definition at line 241 of file shader_graph.h.

◆ id

◆ inputs

◆ need_derivatives_

bool ShaderNode::need_derivatives_ = false
protected

Definition at line 281 of file shader_graph.h.

Referenced by need_derivatives(), and set_need_derivatives().

◆ outputs

◆ special_type


The documentation for this class was generated from the following files: