.. 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/docs/gdscript/doc/classes/VisualShader.xml. .. _class_VisualShader: VisualShader ============ **Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. 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` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_varying` **(** :ref:`String` name, :ref:`VaryingMode` mode, :ref:`VaryingType` type **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`attach_node_to_frame` **(** :ref:`Type` type, :ref:`int` id, :ref:`int` frame **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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:`detach_node_from_frame` **(** :ref:`Type` type, :ref:`int` id **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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:`Dictionary[]` | :ref:`get_node_connections` **(** :ref:`Type` type **)** |const| | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :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:`has_varying` **(** :ref:`String` name **)** |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:`remove_varying` **(** :ref:`String` name **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`replace_node` **(** :ref:`Type` type, :ref:`int` id, :ref:`StringName` new_class **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualShader_Type: .. rst-class:: classref-enumeration enum **Type**: .. _class_VisualShader_constant_TYPE_VERTEX: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_VERTEX** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_FRAGMENT: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_FRAGMENT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_LIGHT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_START: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_START** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_PROCESS: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_PROCESS** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_COLLIDE** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_START_CUSTOM: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_START_CUSTOM** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_PROCESS_CUSTOM: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_PROCESS_CUSTOM** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_SKY: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_SKY** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_FOG: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_FOG** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`Type` **TYPE_MAX** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_VisualShader_VaryingMode: .. rst-class:: classref-enumeration enum **VaryingMode**: .. _class_VisualShader_constant_VARYING_MODE_VERTEX_TO_FRAG_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`VaryingMode` **VARYING_MODE_VERTEX_TO_FRAG_LIGHT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_MODE_FRAG_TO_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`VaryingMode` **VARYING_MODE_FRAG_TO_LIGHT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_MODE_MAX: .. rst-class:: classref-enumeration-constant :ref:`VaryingMode` **VARYING_MODE_MAX** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_VisualShader_VaryingType: .. rst-class:: classref-enumeration enum **VaryingType**: .. _class_VisualShader_constant_VARYING_TYPE_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_FLOAT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_INT: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_INT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_UINT: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_UINT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_VECTOR_2D: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_VECTOR_2D** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_VECTOR_3D: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_VECTOR_3D** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_VECTOR_4D: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_VECTOR_4D** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_BOOLEAN: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_BOOLEAN** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_TRANSFORM: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_TRANSFORM** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_VARYING_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`VaryingType` **VARYING_TYPE_MAX** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. 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`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_VisualShader_constant_NODE_ID_OUTPUT: .. rst-class:: classref-constant **NODE_ID_OUTPUT** = ``0`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. 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)`` .. rst-class:: classref-property-setget - void **set_graph_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_graph_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_VisualShader_method_add_node: .. rst-class:: classref-method void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_add_varying: .. rst-class:: classref-method void **add_varying** **(** :ref:`String` name, :ref:`VaryingMode` mode, :ref:`VaryingType` type **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_attach_node_to_frame: .. rst-class:: classref-method void **attach_node_to_frame** **(** :ref:`Type` type, :ref:`int` id, :ref:`int` frame **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_can_connect_nodes: .. rst-class:: classref-method :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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_connect_nodes: .. rst-class:: classref-method :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_connect_nodes_forced: .. rst-class:: classref-method void **connect_nodes_forced** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_detach_node_from_frame: .. rst-class:: classref-method void **detach_node_from_frame** **(** :ref:`Type` type, :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_disconnect_nodes: .. rst-class:: classref-method void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node: .. rst-class:: classref-method :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node_connections: .. rst-class:: classref-method :ref:`Dictionary[]` **get_node_connections** **(** :ref:`Type` type **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node_list: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_node_list** **(** :ref:`Type` type **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_node_position: .. rst-class:: classref-method :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_get_valid_node_id: .. rst-class:: classref-method :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_has_varying: .. rst-class:: classref-method :ref:`bool` **has_varying** **(** :ref:`String` name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_is_node_connection: .. rst-class:: classref-method :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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_remove_node: .. rst-class:: classref-method void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_remove_varying: .. rst-class:: classref-method void **remove_varying** **(** :ref:`String` name **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_replace_node: .. rst-class:: classref-method void **replace_node** **(** :ref:`Type` type, :ref:`int` id, :ref:`StringName` new_class **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_set_mode: .. rst-class:: classref-method void **set_mode** **(** :ref:`Mode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShader_method_set_node_position: .. rst-class:: classref-method void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)`