:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShader.xml. .. _class_VisualShader: VisualShader ============ **Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A custom shader program with a visual editor. .. rst-class:: classref-introduction-group Description ----------- This class provides a graph-like visual editor for creating a :ref:`Shader`. Although **VisualShader**\ s do not require coding, they share the same logic with script shaders. They use :ref:`VisualShaderNode`\ s that can be connected to each other to control the flow of the shader. The visual shader graph is converted to a script shader behind the scenes. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Using VisualShaders <../tutorials/shaders/visual_shaders>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+---------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`graph_offset` | ``Vector2(0, 0)`` | +-------------------------------+---------------------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_node`\ (\ type\: :ref:`Type`, node\: :ref:`VisualShaderNode`, position\: :ref:`Vector2`, id\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_varying`\ (\ name\: :ref:`String`, mode\: :ref:`VaryingMode`, type\: :ref:`VaryingType`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`attach_node_to_frame`\ (\ type\: :ref:`Type`, id\: :ref:`int`, frame\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_connect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`connect_nodes_forced`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`detach_node_from_frame`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`disconnect_nodes`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VisualShaderNode` | :ref:`get_node`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_node_connections`\ (\ type\: :ref:`Type`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_node_list`\ (\ type\: :ref:`Type`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_node_position`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_valid_node_id`\ (\ type\: :ref:`Type`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_varying`\ (\ name\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_connection`\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_node`\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_varying`\ (\ name\: :ref:`String`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`replace_node`\ (\ type\: :ref:`Type`, id\: :ref:`int`, new_class\: :ref:`StringName`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_mode`\ (\ mode\: :ref:`Mode`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_node_position`\ (\ type\: :ref:`Type`, id\: :ref:`int`, position\: :ref:`Vector2`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualShader_Type: .. rst-class:: classref-enumeration enum **Type**: :ref:`🔗` .. _class_VisualShader_constant_TYPE_VERTEX: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_VERTEX** = ``0`` A vertex shader, operating on vertices. .. _class_VisualShader_constant_TYPE_FRAGMENT: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_FRAGMENT** = ``1`` A fragment shader, operating on fragments (pixels). .. _class_VisualShader_constant_TYPE_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_LIGHT** = ``2`` A shader for light calculations. .. _class_VisualShader_constant_TYPE_START: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_START** = ``3`` A function for the "start" stage of particle shader. .. _class_VisualShader_constant_TYPE_PROCESS: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_PROCESS** = ``4`` A function for the "process" stage of particle shader. .. _class_VisualShader_constant_TYPE_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_COLLIDE** = ``5`` A function for the "collide" stage (particle collision handler) of particle shader. .. _class_VisualShader_constant_TYPE_START_CUSTOM: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_START_CUSTOM** = ``6`` A function for the "start" stage of particle shader, with customized output. .. _class_VisualShader_constant_TYPE_PROCESS_CUSTOM: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_PROCESS_CUSTOM** = ``7`` A function for the "process" stage of particle shader, with customized output. .. _class_VisualShader_constant_TYPE_SKY: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_SKY** = ``8`` A shader for 3D environment's sky. .. _class_VisualShader_constant_TYPE_FOG: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_FOG** = ``9`` A compute shader that runs for each froxel of the volumetric fog map. .. _class_VisualShader_constant_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_MAX** = ``10`` Represents the size of the :ref:`Type` enum. .. rst-class:: classref-item-separator ---- .. _enum_VisualShader_VaryingMode: .. rst-class:: classref-enumeration enum **VaryingMode**: :ref:`🔗` .. _class_VisualShader_constant_VARYING_MODE_VERTEX_TO_FRAG_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`VaryingMode` **VARYING_MODE_VERTEX_TO_FRAG_LIGHT** = ``0`` Varying is passed from ``Vertex`` function to ``Fragment`` and ``Light`` functions. .. _class_VisualShader_constant_VARYING_MODE_FRAG_TO_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`VaryingMode` **VARYING_MODE_FRAG_TO_LIGHT** = ``1`` Varying is passed from ``Fragment`` function to ``Light`` function. .. _class_VisualShader_constant_VARYING_MODE_MAX: .. rst-class:: classref-enumeration-constant :ref:`VaryingMode` **VARYING_MODE_MAX** = ``2`` Represents the size of the :ref:`VaryingMode` enum. .. rst-class:: classref-item-separator ---- .. _enum_VisualShader_VaryingType: .. rst-class:: classref-enumeration enum **VaryingType**: :ref:`🔗` .. _class_VisualShader_constant_VARYING_TYPE_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_FLOAT** = ``0`` Varying is of type :ref:`float`. .. _class_VisualShader_constant_VARYING_TYPE_INT: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_INT** = ``1`` Varying is of type :ref:`int`. .. _class_VisualShader_constant_VARYING_TYPE_UINT: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_UINT** = ``2`` Varying is of type unsigned :ref:`int`. .. _class_VisualShader_constant_VARYING_TYPE_VECTOR_2D: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_VECTOR_2D** = ``3`` Varying is of type :ref:`Vector2`. .. _class_VisualShader_constant_VARYING_TYPE_VECTOR_3D: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_VECTOR_3D** = ``4`` Varying is of type :ref:`Vector3`. .. _class_VisualShader_constant_VARYING_TYPE_VECTOR_4D: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_VECTOR_4D** = ``5`` Varying is of type :ref:`Vector4`. .. _class_VisualShader_constant_VARYING_TYPE_BOOLEAN: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_BOOLEAN** = ``6`` Varying is of type :ref:`bool`. .. _class_VisualShader_constant_VARYING_TYPE_TRANSFORM: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_TRANSFORM** = ``7`` Varying is of type :ref:`Transform3D`. .. _class_VisualShader_constant_VARYING_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_MAX** = ``8`` Represents the size of the :ref:`VaryingType` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_VisualShader_constant_NODE_ID_INVALID: .. rst-class:: classref-constant **NODE_ID_INVALID** = ``-1`` :ref:`🔗` Indicates an invalid **VisualShader** node. .. _class_VisualShader_constant_NODE_ID_OUTPUT: .. rst-class:: classref-constant **NODE_ID_OUTPUT** = ``0`` :ref:`🔗` Indicates an output node of **VisualShader**. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualShader_property_graph_offset: .. rst-class:: classref-property :ref:`Vector2` **graph_offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_graph_offset**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_graph_offset**\ (\ ) The offset vector of the whole graph. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_VisualShader_method_add_node: .. rst-class:: classref-method |void| **add_node**\ (\ type\: :ref:`Type`, node\: :ref:`VisualShaderNode`, position\: :ref:`Vector2`, id\: :ref:`int`\ ) :ref:`🔗` Adds the specified ``node`` to the shader. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_add_varying: .. rst-class:: classref-method |void| **add_varying**\ (\ name\: :ref:`String`, mode\: :ref:`VaryingMode`, type\: :ref:`VaryingType`\ ) :ref:`🔗` Adds a new varying value node to the shader. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_attach_node_to_frame: .. rst-class:: classref-method |void| **attach_node_to_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`, frame\: :ref:`int`\ ) :ref:`🔗` Attaches the given node to the given frame. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_can_connect_nodes: .. rst-class:: classref-method :ref:`bool` **can_connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the specified nodes and ports can be connected together. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_connect_nodes: .. rst-class:: classref-method :ref:`Error` **connect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) :ref:`🔗` Connects the specified nodes and ports. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_connect_nodes_forced: .. rst-class:: classref-method |void| **connect_nodes_forced**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) :ref:`🔗` Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_detach_node_from_frame: .. rst-class:: classref-method |void| **detach_node_from_frame**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) :ref:`🔗` Detaches the given node from the frame it is attached to. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_disconnect_nodes: .. rst-class:: classref-method |void| **disconnect_nodes**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) :ref:`🔗` Connects the specified nodes and ports. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node: .. rst-class:: classref-method :ref:`VisualShaderNode` **get_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the shader node instance with specified ``type`` and ``id``. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node_connections: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **get_node_connections**\ (\ type\: :ref:`Type`\ ) |const| :ref:`🔗` Returns the list of connected nodes with the specified type. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node_list: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_node_list**\ (\ type\: :ref:`Type`\ ) |const| :ref:`🔗` Returns the list of all nodes in the shader with the specified type. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node_position: .. rst-class:: classref-method :ref:`Vector2` **get_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the position of the specified node within the shader graph. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_valid_node_id: .. rst-class:: classref-method :ref:`int` **get_valid_node_id**\ (\ type\: :ref:`Type`\ ) |const| :ref:`🔗` Returns next valid node ID that can be added to the shader graph. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_has_varying: .. rst-class:: classref-method :ref:`bool` **has_varying**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns ``true`` if the shader has a varying with the given ``name``. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_is_node_connection: .. rst-class:: classref-method :ref:`bool` **is_node_connection**\ (\ type\: :ref:`Type`, from_node\: :ref:`int`, from_port\: :ref:`int`, to_node\: :ref:`int`, to_port\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if the specified node and port connection exist. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_remove_node: .. rst-class:: classref-method |void| **remove_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`\ ) :ref:`🔗` Removes the specified node from the shader. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_remove_varying: .. rst-class:: classref-method |void| **remove_varying**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Removes a varying value node with the given ``name``. Prints an error if a node with this name is not found. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_replace_node: .. rst-class:: classref-method |void| **replace_node**\ (\ type\: :ref:`Type`, id\: :ref:`int`, new_class\: :ref:`StringName`\ ) :ref:`🔗` Replaces the specified node with a node of new class type. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_set_mode: .. rst-class:: classref-method |void| **set_mode**\ (\ mode\: :ref:`Mode`\ ) :ref:`🔗` Sets the mode of this shader. .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_set_node_position: .. rst-class:: classref-method |void| **set_node_position**\ (\ type\: :ref:`Type`, id\: :ref:`int`, position\: :ref:`Vector2`\ ) :ref:`🔗` Sets the position of the specified node. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`