godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
0ce22eb52be7e13b8e92e72e2d01279f13347a9d
godot-docs/classes/class_visualshader.rst
Rémi Verschelde 0ce22eb52b Sync classref with current source
2018-08-21 00:37:52 +02:00

133 lines
12 KiB
ReStructuredText
Raw Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShader.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShader:
VisualShader
============
**Inherits:** :ref:`Shader<class_shader>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_node<class_VisualShader_add_node>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`VisualShaderNode<class_visualshadernode>` node, :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` id **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_connect_nodes<class_VisualShader_can_connect_nodes>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`connect_nodes<class_VisualShader_connect_nodes>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_nodes<class_VisualShader_disconnect_nodes>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VisualShaderNode<class_visualshadernode>` | :ref:`get_node<class_VisualShader_get_node>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_node_connections<class_VisualShader_get_node_connections>` **(** :ref:`Type<enum_visualshader_type>` type **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_node_list<class_VisualShader_get_node_list>` **(** :ref:`Type<enum_visualshader_type>` type **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_node_position<class_VisualShader_get_node_position>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_valid_node_id<class_VisualShader_get_valid_node_id>` **(** :ref:`Type<enum_visualshader_type>` type **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_node_connection<class_VisualShader_is_node_connection>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_node<class_VisualShader_remove_node>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_VisualShader_set_mode>` **(** :ref:`Mode<enum_shader_mode>` mode **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_node_position<class_VisualShader_set_node_position>` **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` position **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_VisualShader_graph_offset:
- :ref:`Vector2<class_vector2>` **graph_offset**
Numeric Constants
-----------------
- **NODE_ID_INVALID** = **-1**
- **NODE_ID_OUTPUT** = **0**
Enums
-----
.. _enum_VisualShader_Type:
enum **Type**
- **TYPE_VERTEX** = **0**
- **TYPE_FRAGMENT** = **1**
- **TYPE_LIGHT** = **2**
- **TYPE_MAX** = **3**
Member Function Description
---------------------------
.. _class_VisualShader_add_node:
- void **add_node** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`VisualShaderNode<class_visualshadernode>` node, :ref:`Vector2<class_vector2>` position, :ref:`int<class_int>` id **)**
.. _class_VisualShader_can_connect_nodes:
- :ref:`bool<class_bool>` **can_connect_nodes** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const
.. _class_VisualShader_connect_nodes:
- :ref:`Error<enum_@globalscope_error>` **connect_nodes** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)**
.. _class_VisualShader_disconnect_nodes:
- void **disconnect_nodes** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)**
.. _class_VisualShader_get_node:
- :ref:`VisualShaderNode<class_visualshadernode>` **get_node** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id **)** const
.. _class_VisualShader_get_node_connections:
- :ref:`Array<class_array>` **get_node_connections** **(** :ref:`Type<enum_visualshader_type>` type **)** const
.. _class_VisualShader_get_node_list:
- :ref:`PoolIntArray<class_poolintarray>` **get_node_list** **(** :ref:`Type<enum_visualshader_type>` type **)** const
.. _class_VisualShader_get_node_position:
- :ref:`Vector2<class_vector2>` **get_node_position** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id **)** const
.. _class_VisualShader_get_valid_node_id:
- :ref:`int<class_int>` **get_valid_node_id** **(** :ref:`Type<enum_visualshader_type>` type **)** const
.. _class_VisualShader_is_node_connection:
- :ref:`bool<class_bool>` **is_node_connection** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` from_node, :ref:`int<class_int>` from_port, :ref:`int<class_int>` to_node, :ref:`int<class_int>` to_port **)** const
.. _class_VisualShader_remove_node:
- void **remove_node** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id **)**
.. _class_VisualShader_set_mode:
- void **set_mode** **(** :ref:`Mode<enum_shader_mode>` mode **)**
.. _class_VisualShader_set_node_position:
- void **set_node_position** **(** :ref:`Type<enum_visualshader_type>` type, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` position **)**
Reference in New Issue View Git Blame Copy Permalink