:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShader.xml. .. _class_VisualShader: VisualShader ============ **Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` A custom shader program with a visual editor. Description ----------- This class allows you to define a custom shader program that can be used for various materials to render objects. The visual shader editor creates the shader. Properties ---------- +-------------------------------+---------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`graph_offset` | ``Vector2( 0, 0 )`` | +-------------------------------+---------------------------------------------------------------+---------------------+ Methods ------- +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_node` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`connect_nodes_forced` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_node_connections` **(** :ref:`Type` type **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_node_list` **(** :ref:`Type` type **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_valid_node_id` **(** :ref:`Type` type **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_VisualShader_Type: .. _class_VisualShader_constant_TYPE_VERTEX: .. _class_VisualShader_constant_TYPE_FRAGMENT: .. _class_VisualShader_constant_TYPE_LIGHT: .. _class_VisualShader_constant_TYPE_MAX: enum **Type**: - **TYPE_VERTEX** = **0** --- A vertex shader, operating on vertices. - **TYPE_FRAGMENT** = **1** --- A fragment shader, operating on fragments (pixels). - **TYPE_LIGHT** = **2** --- A shader for light calculations. - **TYPE_MAX** = **3** --- Represents the size of the :ref:`Type` enum. Constants --------- .. _class_VisualShader_constant_NODE_ID_INVALID: .. _class_VisualShader_constant_NODE_ID_OUTPUT: - **NODE_ID_INVALID** = **-1** - **NODE_ID_OUTPUT** = **0** Property Descriptions --------------------- .. _class_VisualShader_property_graph_offset: - :ref:`Vector2` **graph_offset** +-----------+-------------------------+ | *Default* | ``Vector2( 0, 0 )`` | +-----------+-------------------------+ | *Setter* | set_graph_offset(value) | +-----------+-------------------------+ | *Getter* | get_graph_offset() | +-----------+-------------------------+ The offset vector of the whole graph. Method Descriptions ------------------- .. _class_VisualShader_method_add_node: - void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** Adds the specified node to the shader. ---- .. _class_VisualShader_method_can_connect_nodes: - :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| Returns ``true`` if the specified nodes and ports can be connected together. ---- .. _class_VisualShader_method_connect_nodes: - :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Connects the specified nodes and ports. ---- .. _class_VisualShader_method_connect_nodes_forced: - void **connect_nodes_forced** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. ---- .. _class_VisualShader_method_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Connects the specified nodes and ports. ---- .. _class_VisualShader_method_get_node: - :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** |const| Returns the shader node instance with specified ``type`` and ``id``. ---- .. _class_VisualShader_method_get_node_connections: - :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** |const| Returns the list of connected nodes with the specified type. ---- .. _class_VisualShader_method_get_node_list: - :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** |const| Returns the list of all nodes in the shader with the specified type. ---- .. _class_VisualShader_method_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** |const| Returns the position of the specified node within the shader graph. ---- .. _class_VisualShader_method_get_valid_node_id: - :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** |const| ---- .. _class_VisualShader_method_is_node_connection: - :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** |const| Returns ``true`` if the specified node and port connection exist. ---- .. _class_VisualShader_method_remove_node: - void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** Removes the specified node from the shader. ---- .. _class_VisualShader_method_set_mode: - void **set_mode** **(** :ref:`Mode` mode **)** Sets the mode of this shader. ---- .. _class_VisualShader_method_set_node_position: - void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** 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.)`