Blender: SocketType Struct Reference

Blender V4.3

#include <node_type.h>

Public Types
enum	Type { UNDEFINED = 0 , BOOLEAN , FLOAT , INT , UINT , UINT64 , COLOR , VECTOR , POINT , NORMAL , POINT2 , CLOSURE , STRING , ENUM , TRANSFORM , NODE , BOOLEAN_ARRAY , FLOAT_ARRAY , INT_ARRAY , COLOR_ARRAY , VECTOR_ARRAY , POINT_ARRAY , NORMAL_ARRAY , POINT2_ARRAY , STRING_ARRAY , TRANSFORM_ARRAY , NODE_ARRAY , NUM_TYPES }

enum	Flags { LINKABLE = (1 << 0) , ANIMATABLE = (1 << 1) , SVM_INTERNAL = (1 << 2) , OSL_INTERNAL = (1 << 3) , INTERNAL = (1 << 2) \| (1 << 3) , LINK_TEXTURE_GENERATED = (1 << 4) , LINK_TEXTURE_NORMAL = (1 << 5) , LINK_TEXTURE_UV = (1 << 6) , LINK_TEXTURE_INCOMING = (1 << 7) , LINK_INCOMING = (1 << 8) , LINK_NORMAL = (1 << 9) , LINK_POSITION = (1 << 10) , LINK_TANGENT = (1 << 11) , LINK_OSL_INITIALIZER = (1 << 12) , DEFAULT_LINK_MASK }

Public Member Functions
size_t	size () const

bool	is_array () const

Static Public Member Functions
static size_t	size (Type type)

static size_t	max_size ()

static ustring	type_name (Type type)

static void *	zero_default_value ()

static bool	is_float3 (Type type)

Public Attributes
ustring	name

Type	type

int	struct_offset

const void *	default_value

const NodeEnum *	enum_values

const NodeType *	node_type

int	flags

ustring	ui_name

SocketModifiedFlags	modified_flag_bit

Detailed Description

Definition at line 23 of file node_type.h.

Member Enumeration Documentation

◆ Flags

enum SocketType::Flags

Enumerator
LINKABLE
ANIMATABLE
SVM_INTERNAL
OSL_INTERNAL
INTERNAL
LINK_TEXTURE_GENERATED
LINK_TEXTURE_NORMAL
LINK_TEXTURE_UV
LINK_TEXTURE_INCOMING
LINK_INCOMING
LINK_NORMAL
LINK_POSITION
LINK_TANGENT
LINK_OSL_INITIALIZER
DEFAULT_LINK_MASK

Definition at line 58 of file node_type.h.

◆ Type

enum SocketType::Type

Enumerator
UNDEFINED
BOOLEAN
FLOAT
INT
UINT
UINT64
COLOR
VECTOR
POINT
NORMAL
POINT2
CLOSURE
STRING
ENUM
TRANSFORM
NODE
BOOLEAN_ARRAY
FLOAT_ARRAY
INT_ARRAY
COLOR_ARRAY
VECTOR_ARRAY
POINT_ARRAY
NORMAL_ARRAY
POINT2_ARRAY
STRING_ARRAY
TRANSFORM_ARRAY
NODE_ARRAY
NUM_TYPES

Definition at line 24 of file node_type.h.

Member Function Documentation

◆ is_array()

bool SocketType::is_array ( ) const

Definition at line 18 of file node_type.cpp.

References BOOLEAN_ARRAY.

Referenced by Node::copy_value(), and Node::set_value().

◆ is_float3()

bool SocketType::is_float3 ( Type type )

static

Definition at line 126 of file node_type.cpp.

References COLOR, POINT, and VECTOR.

Referenced by ConvertNode::constant_fold(), ConstantFolder::is_one(), ConstantFolder::is_zero(), ConstantFolder::make_one(), ConstantFolder::make_zero(), and ConstantFolder::try_bypass_or_make_constant().

◆ max_size()

size_t SocketType::max_size ( )

static

Definition at line 89 of file node_type.cpp.

Referenced by OSLNode::create(), and OSLNode::input_default_value().

◆ size() [1/2]

CCL_NAMESPACE_BEGIN size_t SocketType::size ( ) const

Definition at line 13 of file node_type.cpp.

References size().

Referenced by Node::copy_value(), Node::get_total_size_in_bytes(), Node::set_default_value(), and size().

◆ size() [2/2]

size_t SocketType::size ( Type type )

static

Definition at line 23 of file node_type.cpp.

References BOOLEAN, BOOLEAN_ARRAY, CLOSURE, COLOR, COLOR_ARRAY, ENUM, FLOAT, float, FLOAT_ARRAY, INT, int, INT_ARRAY, NODE, NODE_ARRAY, NORMAL, NORMAL_ARRAY, NUM_TYPES, POINT, POINT2, POINT2_ARRAY, POINT_ARRAY, STRING, STRING_ARRAY, TRANSFORM, TRANSFORM_ARRAY, UINT, UINT64, UNDEFINED, VECTOR, and VECTOR_ARRAY.

◆ type_name()

ustring SocketType::type_name ( Type type )

static

Definition at line 100 of file node_type.cpp.

References int, and NUM_TYPES.

◆ zero_default_value()

void * SocketType::zero_default_value ( )

static

Definition at line 94 of file node_type.cpp.

References transform_zero().

Member Data Documentation

◆ default_value

const void* SocketType::default_value

Definition at line 82 of file node_type.h.

Referenced by NodeType::register_input(), NodeType::register_output(), and Node::set_default_value().

◆ enum_values

const NodeEnum* SocketType::enum_values

Definition at line 83 of file node_type.h.

Referenced by node_socket_from_image_spec_atttributes(), node_socket_to_image_spec_atttributes(), NodeType::register_input(), NodeType::register_output(), and xml_read_node().

◆ flags

int SocketType::flags

Definition at line 85 of file node_type.h.

Referenced by ShaderNode::create_inputs_outputs(), ShaderNode::equals(), ShaderInput::flags(), NodeType::register_input(), NodeType::register_output(), xml_read_node(), and xml_write_node().

◆ modified_flag_bit

SocketModifiedFlags SocketType::modified_flag_bit

Definition at line 87 of file node_type.h.

Referenced by NodeType::register_input().

◆ name

ustring SocketType::name

Definition at line 79 of file node_type.h.

Referenced by NodeType::find_input(), NodeType::find_output(), Node::hash(), node_socket_attribute_name(), Node::print_modified_sockets(), NodeType::register_input(), NodeType::register_output(), xml_read_node(), and xml_write_node().

◆ node_type

const NodeType* SocketType::node_type

Definition at line 84 of file node_type.h.

Referenced by NodeType::register_input(), NodeType::register_output(), and xml_read_node().

◆ struct_offset

int SocketType::struct_offset

Definition at line 81 of file node_type.h.

Referenced by copy_array(), Node::copy_value(), Node::get_socket_value(), is_array_equal(), is_value_equal(), NodeType::register_input(), NodeType::register_output(), and Node::set_default_value().

◆ type

◆ ui_name

ustring SocketType::ui_name

Definition at line 86 of file node_type.h.

Referenced by ShaderInput::name(), ShaderOutput::name(), NodeType::register_input(), and NodeType::register_output().

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