Startsida Utforska Hjälp
Logga in
Godot
/
godot-docs
spegling av https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Filer Ärenden 0 Wiki
Träd: cedcbd1c5c
Grenar Taggar
godot-docs
/
classes
/
class_visualshader.rst

class_visualshader.rst 14 KB
Historik Rå

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the VisualShader.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_VisualShader:
    6. 

  6. 

  7. VisualShader
    8. 

  8. ============
    9. 

  9. 

  10. **Inherits:** :ref:`Shader<class_Shader>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. 

  18. 

  19. Properties
    20. 

  20. ----------
    21. 

  21. 

  22. +-------------------------------+---------------------------------------------------------------+
    23. 

  23. | :ref:`Vector2<class_Vector2>` | :ref:`graph_offset<class_VisualShader_property_graph_offset>` |
    24. 

  24. +-------------------------------+---------------------------------------------------------------+
    25. 

  25. 

  26. Methods
    27. 

  27. -------
    28. 

  28. 

  29. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                                            | :ref:`add_node<class_VisualShader_method_add_node>` **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`VisualShaderNode<class_VisualShaderNode>` node, :ref:`Vector2<class_Vector2>` position, :ref:`int<class_int>` id **)**                                   |
    31. 

  31. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`bool<class_bool>`                         | :ref:`can_connect_nodes<class_VisualShader_method_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   |
    33. 

  33. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Error<enum_@GlobalScope_Error>`           | :ref:`connect_nodes<class_VisualShader_method_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 **)**                 |
    35. 

  35. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | void                                            | :ref:`connect_nodes_forced<class_VisualShader_method_connect_nodes_forced>` **(** :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 **)**   |
    37. 

  37. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                                            | :ref:`disconnect_nodes<class_VisualShader_method_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 **)**           |
    39. 

  39. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`VisualShaderNode<class_VisualShaderNode>` | :ref:`get_node<class_VisualShader_method_get_node>` **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id **)** const                                                                                                                           |
    41. 

  41. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`Array<class_Array>`                       | :ref:`get_node_connections<class_VisualShader_method_get_node_connections>` **(** :ref:`Type<enum_VisualShader_Type>` type **)** const                                                                                                                             |
    43. 

  43. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`PoolIntArray<class_PoolIntArray>`         | :ref:`get_node_list<class_VisualShader_method_get_node_list>` **(** :ref:`Type<enum_VisualShader_Type>` type **)** const                                                                                                                                           |
    45. 

  45. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`Vector2<class_Vector2>`                   | :ref:`get_node_position<class_VisualShader_method_get_node_position>` **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id **)** const                                                                                                         |
    47. 

  47. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`                           | :ref:`get_valid_node_id<class_VisualShader_method_get_valid_node_id>` **(** :ref:`Type<enum_VisualShader_Type>` type **)** const                                                                                                                                   |
    49. 

  49. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`bool<class_bool>`                         | :ref:`is_node_connection<class_VisualShader_method_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 |
    51. 

  51. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | void                                            | :ref:`rebuild<class_VisualShader_method_rebuild>` **(** **)**                                                                                                                                                                                                      |
    53. 

  53. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | void                                            | :ref:`remove_node<class_VisualShader_method_remove_node>` **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id **)**                                                                                                                           |
    55. 

  55. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | void                                            | :ref:`set_mode<class_VisualShader_method_set_mode>` **(** :ref:`Mode<enum_Shader_Mode>` mode **)**                                                                                                                                                                 |
    57. 

  57. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | void                                            | :ref:`set_node_position<class_VisualShader_method_set_node_position>` **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position **)**                                                                       |
    59. 

  59. +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. 

  61. Enumerations
    62. 

  62. ------------
    63. 

  63. 

  64. .. _enum_VisualShader_Type:
    65. 

  65. 

  66. .. _class_VisualShader_constant_TYPE_VERTEX:
    67. 

  67. 

  68. .. _class_VisualShader_constant_TYPE_FRAGMENT:
    69. 

  69. 

  70. .. _class_VisualShader_constant_TYPE_LIGHT:
    71. 

  71. 

  72. .. _class_VisualShader_constant_TYPE_MAX:
    73. 

  73. 

  74. enum **Type**:
    75. 

  75. 

  76. - **TYPE_VERTEX** = **0**
    77. 

  77. 

  78. - **TYPE_FRAGMENT** = **1**
    79. 

  79. 

  80. - **TYPE_LIGHT** = **2**
    81. 

  81. 

  82. - **TYPE_MAX** = **3**
    83. 

  83. 

  84. Constants
    85. 

  85. ---------
    86. 

  86. 

  87. .. _class_VisualShader_constant_NODE_ID_INVALID:
    88. 

  88. 

  89. .. _class_VisualShader_constant_NODE_ID_OUTPUT:
    90. 

  90. 

  91. - **NODE_ID_INVALID** = **-1**
    92. 

  92. 

  93. - **NODE_ID_OUTPUT** = **0**
    94. 

  94. 

  95. Property Descriptions
    96. 

  96. ---------------------
    97. 

  97. 

  98. .. _class_VisualShader_property_graph_offset:
    99. 

  99. 

  100. - :ref:`Vector2<class_Vector2>` **graph_offset**
    101. 

  101. 

  102. +----------+-------------------------+
    103. 

  103. | *Setter* | set_graph_offset(value) |
    104. 

  104. +----------+-------------------------+
    105. 

  105. | *Getter* | get_graph_offset()      |
    106. 

  106. +----------+-------------------------+
    107. 

  107. 

  108. Method Descriptions
    109. 

  109. -------------------
    110. 

  110. 

  111. .. _class_VisualShader_method_add_node:
    112. 

  112. 

  113. - void **add_node** **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`VisualShaderNode<class_VisualShaderNode>` node, :ref:`Vector2<class_Vector2>` position, :ref:`int<class_int>` id **)**
    114. 

  114. 

  115. .. _class_VisualShader_method_can_connect_nodes:
    116. 

  116. 

  117. - :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
    118. 

  118. 

  119. .. _class_VisualShader_method_connect_nodes:
    120. 

  120. 

  121. - :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 **)**
    122. 

  122. 

  123. .. _class_VisualShader_method_connect_nodes_forced:
    124. 

  124. 

  125. - void **connect_nodes_forced** **(** :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 **)**
    126. 

  126. 

  127. .. _class_VisualShader_method_disconnect_nodes:
    128. 

  128. 

  129. - 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 **)**
    130. 

  130. 

  131. .. _class_VisualShader_method_get_node:
    132. 

  132. 

  133. - :ref:`VisualShaderNode<class_VisualShaderNode>` **get_node** **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id **)** const
    134. 

  134. 

  135. .. _class_VisualShader_method_get_node_connections:
    136. 

  136. 

  137. - :ref:`Array<class_Array>` **get_node_connections** **(** :ref:`Type<enum_VisualShader_Type>` type **)** const
    138. 

  138. 

  139. .. _class_VisualShader_method_get_node_list:
    140. 

  140. 

  141. - :ref:`PoolIntArray<class_PoolIntArray>` **get_node_list** **(** :ref:`Type<enum_VisualShader_Type>` type **)** const
    142. 

  142. 

  143. .. _class_VisualShader_method_get_node_position:
    144. 

  144. 

  145. - :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id **)** const
    146. 

  146. 

  147. .. _class_VisualShader_method_get_valid_node_id:
    148. 

  148. 

  149. - :ref:`int<class_int>` **get_valid_node_id** **(** :ref:`Type<enum_VisualShader_Type>` type **)** const
    150. 

  150. 

  151. .. _class_VisualShader_method_is_node_connection:
    152. 

  152. 

  153. - :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
    154. 

  154. 

  155. .. _class_VisualShader_method_rebuild:
    156. 

  156. 

  157. - void **rebuild** **(** **)**
    158. 

  158. 

  159. .. _class_VisualShader_method_remove_node:
    160. 

  160. 

  161. - void **remove_node** **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id **)**
    162. 

  162. 

  163. .. _class_VisualShader_method_set_mode:
    164. 

  164. 

  165. - void **set_mode** **(** :ref:`Mode<enum_Shader_Mode>` mode **)**
    166. 

  166. 

  167. .. _class_VisualShader_method_set_node_position:
    168. 

  168. 

  169. - void **set_node_position** **(** :ref:`Type<enum_VisualShader_Type>` type, :ref:`int<class_int>` id, :ref:`Vector2<class_Vector2>` position **)**
    170. 

  170.