Blender V4.5
Public Member Functions | Public Attributes | List of all members
Shader Class Reference

#include <shader.h>

Inherits Node.

Public Member Functions

 Shader ()
 
void estimate_emission ()
 
void set_graph (unique_ptr< ShaderGraph > &&graph)
 
void tag_update (Scene *scene)
 
void tag_used (Scene *scene)
 
bool has_surface_link () const
 
bool need_update_geometry () const
 
- 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

NODE_DECLARE unique_ptr< ShaderGraph > graph
 
float prev_volume_step_rate
 
bool need_update_uvs
 
bool need_update_attribute
 
bool need_update_displacement
 
bool has_volume_connected
 
bool has_surface
 
bool has_surface_transparent
 
bool has_surface_raytrace
 
bool has_volume
 
bool has_displacement
 
bool has_surface_bssrdf
 
bool has_bump_from_surface
 
bool has_bump_from_displacement
 
bool has_bssrdf_bump
 
bool has_surface_spatial_varying
 
bool has_volume_spatial_varying
 
bool has_volume_attribute_dependency
 
float3 emission_estimate
 
EmissionSampling emission_sampling
 
bool emission_is_constant
 
AttributeRequestSet attributes
 
uint id
 
- 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 71 of file scene/shader.h.

Constructor & Destructor Documentation

◆ Shader()

Shader::Shader ( )

Definition at line 88 of file scene/shader.cpp.

References DISPLACE_BUMP, emission_estimate, emission_is_constant, emission_sampling, EMISSION_SAMPLING_NONE, graph, has_bssrdf_bump, has_bump_from_displacement, has_bump_from_surface, has_displacement, has_surface, has_surface_bssrdf, has_surface_raytrace, has_surface_spatial_varying, has_surface_transparent, has_volume, has_volume_attribute_dependency, has_volume_connected, has_volume_spatial_varying, need_update_attribute, need_update_displacement, need_update_uvs, prev_volume_step_rate, and zero_float3().

Member Function Documentation

◆ estimate_emission()

void Shader::estimate_emission ( )

Definition at line 237 of file scene/shader.cpp.

References emission_estimate, emission_is_constant, emission_sampling, EMISSION_SAMPLING_AUTO, EMISSION_SAMPLING_FRONT_BACK, EMISSION_SAMPLING_NONE, fabs(), EmissionNode::from_auto_conversion, graph, is_zero(), ShaderInput::link, node, output, output_estimate_emission(), reduce_max(), and SHADER_SPECIAL_TYPE_OUTPUT_AOV.

Referenced by SVMCompiler::compile().

◆ has_surface_link()

bool Shader::has_surface_link ( ) const
inline

Definition at line 156 of file scene/shader.h.

References has_displacement, and has_surface.

Referenced by EnvironmentTextureNode::attributes(), GeometryNode::attributes(), GlossyBsdfNode::attributes(), HairInfoNode::attributes(), ImageTextureNode::attributes(), MetallicBsdfNode::attributes(), NormalMapNode::attributes(), OSLNode::attributes(), PointInfoNode::attributes(), PrincipledBsdfNode::attributes(), ShaderNode::attributes(), TangentNode::attributes(), TextureCoordinateNode::attributes(), and VectorDisplacementNode::attributes().

◆ need_update_geometry()

bool Shader::need_update_geometry ( ) const

Definition at line 414 of file scene/shader.cpp.

References need_update_attribute, need_update_displacement, and need_update_uvs.

◆ set_graph()

void Shader::set_graph ( unique_ptr< ShaderGraph > && graph)

Definition at line 280 of file scene/shader.cpp.

References DISPLACE_BUMP, graph, has_volume_connected, and need_update_displacement.

Referenced by ShaderManager::add_default(), and xml_read_shader_graph().

◆ tag_update()

void Shader::tag_update ( Scene * scene)

Definition at line 311 of file scene/shader.cpp.

References AttributeRequestSet::add(), ATTR_STD_POSITION_UNDISPLACED, attributes, Scene::background, AttributeRequestSet::clear(), DISPLACE_BOTH, emission_sampling, EMISSION_SAMPLING_NONE, Scene::geometry_manager, Background::get_shader(), graph, has_displacement, has_surface, has_volume, in, Scene::light_manager, AttributeRequestSet::modified(), need_update_attribute, need_update_displacement, node, Scene::object_manager, output, ShaderNode::output(), prev_volume_step_rate, Scene::procedural_manager, scene, GeometryManager::SHADER_ATTRIBUTE_MODIFIED, GeometryManager::SHADER_DISPLACEMENT_MODIFIED, Scene::shader_manager, LightManager::SHADER_MODIFIED, ShaderManager::SHADER_MODIFIED, SHADER_SPECIAL_TYPE_OUTPUT_AOV, and Node::tag_modified().

Referenced by ShaderManager::add_default(), and xml_read_shader_graph().

◆ tag_used()

void Shader::tag_used ( Scene * scene)

Definition at line 403 of file scene/shader.cpp.

References Node::reference_count(), scene, Scene::shader_manager, ShaderManager::SHADER_MODIFIED, and Node::tag_modified().

Member Data Documentation

◆ attributes

AttributeRequestSet Shader::attributes

Definition at line 127 of file scene/shader.h.

Referenced by GeometryManager::device_update_attributes(), Geometry::need_attribute(), Geometry::need_attribute(), Geometry::needed_attributes(), and tag_update().

◆ emission_estimate

float3 Shader::emission_estimate

Definition at line 122 of file scene/shader.h.

Referenced by estimate_emission(), Light::has_contribution(), LightTreeEmitter::LightTreeEmitter(), and Shader().

◆ emission_is_constant

bool Shader::emission_is_constant

Definition at line 124 of file scene/shader.h.

Referenced by estimate_emission(), and Shader().

◆ emission_sampling

EmissionSampling Shader::emission_sampling

Definition at line 123 of file scene/shader.h.

Referenced by LightManager::device_update_distribution(), estimate_emission(), light_tree_leaf_emitters_copy_and_flatten(), LightTreeEmitter::LightTreeEmitter(), Shader(), Geometry::tag_update(), Object::tag_update(), tag_update(), and Object::usable_as_light().

◆ graph

NODE_DECLARE unique_ptr<ShaderGraph> Shader::graph

Definition at line 76 of file scene/shader.h.

Referenced by SVMCompiler::compile(), ImageTextureNode::cull_tiles(), LightManager::device_update_background(), GeometryManager::device_update_displacement_images(), SVMShaderManager::device_update_shader(), estimate_emission(), ShaderManager::get_kernel_features(), Scene::get_max_closure_count(), set_graph(), Shader(), tag_update(), and HdCyclesSession::UpdateScene().

◆ has_bssrdf_bump

bool Shader::has_bssrdf_bump

Definition at line 117 of file scene/shader.h.

Referenced by SVMCompiler::generate_closure_node(), and Shader().

◆ has_bump_from_displacement

bool Shader::has_bump_from_displacement

Definition at line 116 of file scene/shader.h.

Referenced by SVMCompiler::compile(), and Shader().

◆ has_bump_from_surface

bool Shader::has_bump_from_surface

Definition at line 115 of file scene/shader.h.

Referenced by SVMCompiler::compile(), SVMCompiler::generate_closure_node(), and Shader().

◆ has_displacement

bool Shader::has_displacement

Definition at line 113 of file scene/shader.h.

Referenced by SVMCompiler::compile(), SVMCompiler::compile_type(), GeometryManager::device_update_displacement_images(), GeometryManager::displace(), fill_shader_input(), has_surface_link(), Geometry::has_true_displacement(), read_shader_output(), Shader(), and tag_update().

◆ has_surface

bool Shader::has_surface

Definition at line 109 of file scene/shader.h.

Referenced by UVMapNode::attributes(), SVMCompiler::compile(), SVMCompiler::compile_type(), has_surface_link(), Shader(), and tag_update().

◆ has_surface_bssrdf

bool Shader::has_surface_bssrdf

Definition at line 114 of file scene/shader.h.

Referenced by SVMCompiler::compile(), SVMCompiler::generate_closure_node(), and Shader().

◆ has_surface_raytrace

bool Shader::has_surface_raytrace

Definition at line 111 of file scene/shader.h.

Referenced by SVMCompiler::compile(), SVMCompiler::generate_node(), and Shader().

◆ has_surface_spatial_varying

bool Shader::has_surface_spatial_varying

Definition at line 118 of file scene/shader.h.

Referenced by SVMCompiler::compile(), SVMCompiler::generate_node(), Shader(), and LightManager::test_enabled_lights().

◆ has_surface_transparent

bool Shader::has_surface_transparent

Definition at line 110 of file scene/shader.h.

Referenced by SVMCompiler::compile(), SVMCompiler::generate_closure_node(), Hair::need_shadow_transparency(), and Shader().

◆ has_volume

bool Shader::has_volume

Definition at line 112 of file scene/shader.h.

Referenced by AttributeNode::attributes(), PointDensityTextureNode::attributes(), PrincipledVolumeNode::attributes(), ShaderNode::attributes(), TextureCoordinateNode::attributes(), VolumeInfoNode::attributes(), SVMCompiler::compile(), SVMCompiler::compile_type(), Object::compute_volume_step_size(), GeometryManager::create_volume_mesh(), Shader(), and tag_update().

◆ has_volume_attribute_dependency

bool Shader::has_volume_attribute_dependency

Definition at line 120 of file scene/shader.h.

Referenced by SVMCompiler::compile(), Object::compute_volume_step_size(), SVMCompiler::generate_node(), and Shader().

◆ has_volume_connected

bool Shader::has_volume_connected

Definition at line 106 of file scene/shader.h.

Referenced by ShaderManager::get_kernel_features(), set_graph(), and Shader().

◆ has_volume_spatial_varying

bool Shader::has_volume_spatial_varying

Definition at line 119 of file scene/shader.h.

Referenced by SVMCompiler::compile(), Object::compute_volume_step_size(), SVMCompiler::generate_node(), and Shader().

◆ id

uint Shader::id

Definition at line 130 of file scene/shader.h.

Referenced by ShaderManager::get_shader_id().

◆ need_update_attribute

bool Shader::need_update_attribute

Definition at line 96 of file scene/shader.h.

Referenced by need_update_geometry(), Shader(), and tag_update().

◆ need_update_displacement

bool Shader::need_update_displacement

Definition at line 97 of file scene/shader.h.

Referenced by need_update_geometry(), set_graph(), Shader(), and tag_update().

◆ need_update_uvs

bool Shader::need_update_uvs

Definition at line 95 of file scene/shader.h.

Referenced by need_update_geometry(), and Shader().

◆ prev_volume_step_rate

float Shader::prev_volume_step_rate

Definition at line 92 of file scene/shader.h.

Referenced by Shader(), and tag_update().

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