class_shadergraph.rst 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_ShaderGraph:
  4. ShaderGraph
  5. ===========
  6. **Inherits:** :ref:`Shader<class_shader>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Inherited By:** :ref:`MaterialShaderGraph<class_materialshadergraph>`, :ref:`CanvasItemShaderGraph<class_canvasitemshadergraph>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`clear<class_ShaderGraph_clear>` **(** :ref:`int<class_int>` shader_type **)** |
  15. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`ColorArray<class_colorarray>` | :ref:`color_ramp_node_get_colors<class_ShaderGraph_color_ramp_node_get_colors>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  17. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`RealArray<class_realarray>` | :ref:`color_ramp_node_get_offsets<class_ShaderGraph_color_ramp_node_get_offsets>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  19. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`color_ramp_node_set_ramp<class_ShaderGraph_color_ramp_node_set_ramp>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`ColorArray<class_colorarray>` colors, :ref:`RealArray<class_realarray>` offsets **)** |
  21. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`String<class_string>` | :ref:`comment_node_get_text<class_ShaderGraph_comment_node_get_text>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  23. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`comment_node_set_text<class_ShaderGraph_comment_node_set_text>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`String<class_string>` text **)** |
  25. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | Error | :ref:`connect_node<class_ShaderGraph_connect_node>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` src_id, :ref:`int<class_int>` src_slot, :ref:`int<class_int>` dst_id, :ref:`int<class_int>` dst_slot **)** |
  27. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`CubeMap<class_cubemap>` | :ref:`cubemap_input_node_get_value<class_ShaderGraph_cubemap_input_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  29. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`cubemap_input_node_set_value<class_ShaderGraph_cubemap_input_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`CubeMap<class_cubemap>` value **)** |
  31. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`Vector2Array<class_vector2array>` | :ref:`curve_map_node_get_points<class_ShaderGraph_curve_map_node_get_points>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  33. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`curve_map_node_set_points<class_ShaderGraph_curve_map_node_set_points>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector2Array<class_vector2array>` points **)** |
  35. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`default_get_value<class_ShaderGraph_default_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` param_id **)** |
  37. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`default_set_value<class_ShaderGraph_default_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` param_id, :ref:`Variant<class_variant>` value **)** |
  39. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`disconnect_node<class_ShaderGraph_disconnect_node>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` src_id, :ref:`int<class_int>` src_slot, :ref:`int<class_int>` dst_id, :ref:`int<class_int>` dst_slot **)** |
  41. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Array<class_array>` | :ref:`get_node_connections<class_ShaderGraph_get_node_connections>` **(** :ref:`int<class_int>` shader_type **)** const |
  43. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`Array<class_array>` | :ref:`get_node_list<class_ShaderGraph_get_node_list>` **(** :ref:`int<class_int>` shader_type **)** const |
  45. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`String<class_string>` | :ref:`input_node_get_name<class_ShaderGraph_input_node_get_name>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** |
  47. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`input_node_set_name<class_ShaderGraph_input_node_set_name>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`String<class_string>` name **)** |
  49. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`bool<class_bool>` | :ref:`is_node_connected<class_ShaderGraph_is_node_connected>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` src_id, :ref:`int<class_int>` src_slot, :ref:`int<class_int>` dst_id, :ref:`int<class_int>` dst_slot **)** const |
  51. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`node_add<class_ShaderGraph_node_add>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` node_type, :ref:`int<class_int>` id **)** |
  53. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`Vector2<class_vector2>` | :ref:`node_get_pos<class_ShaderGraph_node_get_pos>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  55. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`Variant<class_variant>` | :ref:`node_get_state<class_ShaderGraph_node_get_state>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  57. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`int<class_int>` | :ref:`node_get_type<class_ShaderGraph_node_get_type>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  59. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | void | :ref:`node_remove<class_ShaderGraph_node_remove>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** |
  61. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | void | :ref:`node_set_pos<class_ShaderGraph_node_set_pos>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` pos **)** |
  63. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | void | :ref:`node_set_state<class_ShaderGraph_node_set_state>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Variant<class_variant>` state **)** |
  65. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Color<class_color>` | :ref:`rgb_const_node_get_value<class_ShaderGraph_rgb_const_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  67. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | void | :ref:`rgb_const_node_set_value<class_ShaderGraph_rgb_const_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Color<class_color>` value **)** |
  69. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`Color<class_color>` | :ref:`rgb_input_node_get_value<class_ShaderGraph_rgb_input_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  71. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | void | :ref:`rgb_input_node_set_value<class_ShaderGraph_rgb_input_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Color<class_color>` value **)** |
  73. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`int<class_int>` | :ref:`rgb_op_node_get_op<class_ShaderGraph_rgb_op_node_get_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const |
  75. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | void | :ref:`rgb_op_node_set_op<class_ShaderGraph_rgb_op_node_set_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)** |
  77. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`float<class_float>` | :ref:`scalar_const_node_get_value<class_ShaderGraph_scalar_const_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  79. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | void | :ref:`scalar_const_node_set_value<class_ShaderGraph_scalar_const_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`float<class_float>` value **)** |
  81. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`int<class_int>` | :ref:`scalar_func_node_get_function<class_ShaderGraph_scalar_func_node_get_function>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  83. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | void | :ref:`scalar_func_node_set_function<class_ShaderGraph_scalar_func_node_set_function>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` func **)** |
  85. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`float<class_float>` | :ref:`scalar_input_node_get_value<class_ShaderGraph_scalar_input_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  87. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | void | :ref:`scalar_input_node_set_value<class_ShaderGraph_scalar_input_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`float<class_float>` value **)** |
  89. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`int<class_int>` | :ref:`scalar_op_node_get_op<class_ShaderGraph_scalar_op_node_get_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const |
  91. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | void | :ref:`scalar_op_node_set_op<class_ShaderGraph_scalar_op_node_set_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)** |
  93. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`Texture<class_texture>` | :ref:`texture_input_node_get_value<class_ShaderGraph_texture_input_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  95. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | void | :ref:`texture_input_node_set_value<class_ShaderGraph_texture_input_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Texture<class_texture>` value **)** |
  97. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`int<class_int>` | :ref:`texture_node_get_filter_size<class_ShaderGraph_texture_node_get_filter_size>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  99. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`float<class_float>` | :ref:`texture_node_get_filter_strength<class_ShaderGraph_texture_node_get_filter_strength>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const |
  101. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | void | :ref:`texture_node_set_filter_size<class_ShaderGraph_texture_node_set_filter_size>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` filter_size **)** |
  103. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | void | :ref:`texture_node_set_filter_strength<class_ShaderGraph_texture_node_set_filter_strength>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`float<class_float>` filter_strength **)** |
  105. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`Vector3<class_vector3>` | :ref:`vec_const_node_get_value<class_ShaderGraph_vec_const_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  107. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | void | :ref:`vec_const_node_set_value<class_ShaderGraph_vec_const_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` value **)** |
  109. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`int<class_int>` | :ref:`vec_func_node_get_function<class_ShaderGraph_vec_func_node_get_function>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  111. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | void | :ref:`vec_func_node_set_function<class_ShaderGraph_vec_func_node_set_function>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` func **)** |
  113. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`Vector3<class_vector3>` | :ref:`vec_input_node_get_value<class_ShaderGraph_vec_input_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  115. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | void | :ref:`vec_input_node_set_value<class_ShaderGraph_vec_input_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` value **)** |
  117. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`int<class_int>` | :ref:`vec_op_node_get_op<class_ShaderGraph_vec_op_node_get_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const |
  119. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | void | :ref:`vec_op_node_set_op<class_ShaderGraph_vec_op_node_set_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)** |
  121. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`int<class_int>` | :ref:`vec_scalar_op_node_get_op<class_ShaderGraph_vec_scalar_op_node_get_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const |
  123. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | void | :ref:`vec_scalar_op_node_set_op<class_ShaderGraph_vec_scalar_op_node_set_op>` **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)** |
  125. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`Transform<class_transform>` | :ref:`xform_const_node_get_value<class_ShaderGraph_xform_const_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  127. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | void | :ref:`xform_const_node_set_value<class_ShaderGraph_xform_const_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Transform<class_transform>` value **)** |
  129. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`Transform<class_transform>` | :ref:`xform_input_node_get_value<class_ShaderGraph_xform_input_node_get_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  131. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | void | :ref:`xform_input_node_set_value<class_ShaderGraph_xform_input_node_set_value>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Transform<class_transform>` value **)** |
  133. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`bool<class_bool>` | :ref:`xform_vec_mult_node_get_no_translation<class_ShaderGraph_xform_vec_mult_node_get_no_translation>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const |
  135. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | void | :ref:`xform_vec_mult_node_set_no_translation<class_ShaderGraph_xform_vec_mult_node_set_no_translation>` **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`bool<class_bool>` disable **)** |
  137. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. Signals
  139. -------
  140. - **updated** **(** **)**
  141. Numeric Constants
  142. -----------------
  143. - **NODE_INPUT** = **0**
  144. - **NODE_SCALAR_CONST** = **1**
  145. - **NODE_VEC_CONST** = **2**
  146. - **NODE_RGB_CONST** = **3**
  147. - **NODE_XFORM_CONST** = **4**
  148. - **NODE_TIME** = **5**
  149. - **NODE_SCREEN_TEX** = **6**
  150. - **NODE_SCALAR_OP** = **7**
  151. - **NODE_VEC_OP** = **8**
  152. - **NODE_VEC_SCALAR_OP** = **9**
  153. - **NODE_RGB_OP** = **10**
  154. - **NODE_XFORM_MULT** = **11**
  155. - **NODE_XFORM_VEC_MULT** = **12**
  156. - **NODE_XFORM_VEC_INV_MULT** = **13**
  157. - **NODE_SCALAR_FUNC** = **14**
  158. - **NODE_VEC_FUNC** = **15**
  159. - **NODE_VEC_LEN** = **16**
  160. - **NODE_DOT_PROD** = **17**
  161. - **NODE_VEC_TO_SCALAR** = **18**
  162. - **NODE_SCALAR_TO_VEC** = **19**
  163. - **NODE_VEC_TO_XFORM** = **21**
  164. - **NODE_XFORM_TO_VEC** = **20**
  165. - **NODE_SCALAR_INTERP** = **22**
  166. - **NODE_VEC_INTERP** = **23**
  167. - **NODE_COLOR_RAMP** = **24**
  168. - **NODE_CURVE_MAP** = **25**
  169. - **NODE_SCALAR_INPUT** = **26**
  170. - **NODE_VEC_INPUT** = **27**
  171. - **NODE_RGB_INPUT** = **28**
  172. - **NODE_XFORM_INPUT** = **29**
  173. - **NODE_TEXTURE_INPUT** = **30**
  174. - **NODE_CUBEMAP_INPUT** = **31**
  175. - **NODE_DEFAULT_TEXTURE** = **32**
  176. - **NODE_OUTPUT** = **33**
  177. - **NODE_COMMENT** = **34**
  178. - **NODE_TYPE_MAX** = **35**
  179. - **SLOT_TYPE_SCALAR** = **0**
  180. - **SLOT_TYPE_VEC** = **1**
  181. - **SLOT_TYPE_XFORM** = **2**
  182. - **SLOT_TYPE_TEXTURE** = **3**
  183. - **SLOT_MAX** = **4**
  184. - **SHADER_TYPE_VERTEX** = **0**
  185. - **SHADER_TYPE_FRAGMENT** = **1**
  186. - **SHADER_TYPE_LIGHT** = **2**
  187. - **SHADER_TYPE_MAX** = **3**
  188. - **SLOT_IN** = **0**
  189. - **SLOT_OUT** = **1**
  190. - **GRAPH_OK** = **0**
  191. - **GRAPH_ERROR_CYCLIC** = **1**
  192. - **GRAPH_ERROR_MISSING_CONNECTIONS** = **2**
  193. - **SCALAR_OP_ADD** = **0**
  194. - **SCALAR_OP_SUB** = **1**
  195. - **SCALAR_OP_MUL** = **2**
  196. - **SCALAR_OP_DIV** = **3**
  197. - **SCALAR_OP_MOD** = **4**
  198. - **SCALAR_OP_POW** = **5**
  199. - **SCALAR_OP_MAX** = **6**
  200. - **SCALAR_OP_MIN** = **7**
  201. - **SCALAR_OP_ATAN2** = **8**
  202. - **SCALAR_MAX_OP** = **9**
  203. - **VEC_OP_ADD** = **0**
  204. - **VEC_OP_SUB** = **1**
  205. - **VEC_OP_MUL** = **2**
  206. - **VEC_OP_DIV** = **3**
  207. - **VEC_OP_MOD** = **4**
  208. - **VEC_OP_POW** = **5**
  209. - **VEC_OP_MAX** = **6**
  210. - **VEC_OP_MIN** = **7**
  211. - **VEC_OP_CROSS** = **8**
  212. - **VEC_MAX_OP** = **9**
  213. - **VEC_SCALAR_OP_MUL** = **0**
  214. - **VEC_SCALAR_OP_DIV** = **1**
  215. - **VEC_SCALAR_OP_POW** = **2**
  216. - **VEC_SCALAR_MAX_OP** = **3**
  217. - **RGB_OP_SCREEN** = **0**
  218. - **RGB_OP_DIFFERENCE** = **1**
  219. - **RGB_OP_DARKEN** = **2**
  220. - **RGB_OP_LIGHTEN** = **3**
  221. - **RGB_OP_OVERLAY** = **4**
  222. - **RGB_OP_DODGE** = **5**
  223. - **RGB_OP_BURN** = **6**
  224. - **RGB_OP_SOFT_LIGHT** = **7**
  225. - **RGB_OP_HARD_LIGHT** = **8**
  226. - **RGB_MAX_OP** = **9**
  227. - **SCALAR_FUNC_SIN** = **0**
  228. - **SCALAR_FUNC_COS** = **1**
  229. - **SCALAR_FUNC_TAN** = **2**
  230. - **SCALAR_FUNC_ASIN** = **3**
  231. - **SCALAR_FUNC_ACOS** = **4**
  232. - **SCALAR_FUNC_ATAN** = **5**
  233. - **SCALAR_FUNC_SINH** = **6**
  234. - **SCALAR_FUNC_COSH** = **7**
  235. - **SCALAR_FUNC_TANH** = **8**
  236. - **SCALAR_FUNC_LOG** = **9**
  237. - **SCALAR_FUNC_EXP** = **10**
  238. - **SCALAR_FUNC_SQRT** = **11**
  239. - **SCALAR_FUNC_ABS** = **12**
  240. - **SCALAR_FUNC_SIGN** = **13**
  241. - **SCALAR_FUNC_FLOOR** = **14**
  242. - **SCALAR_FUNC_ROUND** = **15**
  243. - **SCALAR_FUNC_CEIL** = **16**
  244. - **SCALAR_FUNC_FRAC** = **17**
  245. - **SCALAR_FUNC_SATURATE** = **18**
  246. - **SCALAR_FUNC_NEGATE** = **19**
  247. - **SCALAR_MAX_FUNC** = **20**
  248. - **VEC_FUNC_NORMALIZE** = **0**
  249. - **VEC_FUNC_SATURATE** = **1**
  250. - **VEC_FUNC_NEGATE** = **2**
  251. - **VEC_FUNC_RECIPROCAL** = **3**
  252. - **VEC_FUNC_RGB2HSV** = **4**
  253. - **VEC_FUNC_HSV2RGB** = **5**
  254. - **VEC_MAX_FUNC** = **6**
  255. Member Function Description
  256. ---------------------------
  257. .. _class_ShaderGraph_clear:
  258. - void **clear** **(** :ref:`int<class_int>` shader_type **)**
  259. .. _class_ShaderGraph_color_ramp_node_get_colors:
  260. - :ref:`ColorArray<class_colorarray>` **color_ramp_node_get_colors** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  261. .. _class_ShaderGraph_color_ramp_node_get_offsets:
  262. - :ref:`RealArray<class_realarray>` **color_ramp_node_get_offsets** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  263. .. _class_ShaderGraph_color_ramp_node_set_ramp:
  264. - void **color_ramp_node_set_ramp** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`ColorArray<class_colorarray>` colors, :ref:`RealArray<class_realarray>` offsets **)**
  265. .. _class_ShaderGraph_comment_node_get_text:
  266. - :ref:`String<class_string>` **comment_node_get_text** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  267. .. _class_ShaderGraph_comment_node_set_text:
  268. - void **comment_node_set_text** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`String<class_string>` text **)**
  269. .. _class_ShaderGraph_connect_node:
  270. - Error **connect_node** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` src_id, :ref:`int<class_int>` src_slot, :ref:`int<class_int>` dst_id, :ref:`int<class_int>` dst_slot **)**
  271. .. _class_ShaderGraph_cubemap_input_node_get_value:
  272. - :ref:`CubeMap<class_cubemap>` **cubemap_input_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  273. .. _class_ShaderGraph_cubemap_input_node_set_value:
  274. - void **cubemap_input_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`CubeMap<class_cubemap>` value **)**
  275. .. _class_ShaderGraph_curve_map_node_get_points:
  276. - :ref:`Vector2Array<class_vector2array>` **curve_map_node_get_points** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  277. .. _class_ShaderGraph_curve_map_node_set_points:
  278. - void **curve_map_node_set_points** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector2Array<class_vector2array>` points **)**
  279. .. _class_ShaderGraph_default_get_value:
  280. - void **default_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` param_id **)**
  281. .. _class_ShaderGraph_default_set_value:
  282. - void **default_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` param_id, :ref:`Variant<class_variant>` value **)**
  283. .. _class_ShaderGraph_disconnect_node:
  284. - void **disconnect_node** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` src_id, :ref:`int<class_int>` src_slot, :ref:`int<class_int>` dst_id, :ref:`int<class_int>` dst_slot **)**
  285. .. _class_ShaderGraph_get_node_connections:
  286. - :ref:`Array<class_array>` **get_node_connections** **(** :ref:`int<class_int>` shader_type **)** const
  287. .. _class_ShaderGraph_get_node_list:
  288. - :ref:`Array<class_array>` **get_node_list** **(** :ref:`int<class_int>` shader_type **)** const
  289. .. _class_ShaderGraph_input_node_get_name:
  290. - :ref:`String<class_string>` **input_node_get_name** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)**
  291. .. _class_ShaderGraph_input_node_set_name:
  292. - void **input_node_set_name** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`String<class_string>` name **)**
  293. .. _class_ShaderGraph_is_node_connected:
  294. - :ref:`bool<class_bool>` **is_node_connected** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` src_id, :ref:`int<class_int>` src_slot, :ref:`int<class_int>` dst_id, :ref:`int<class_int>` dst_slot **)** const
  295. .. _class_ShaderGraph_node_add:
  296. - void **node_add** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` node_type, :ref:`int<class_int>` id **)**
  297. .. _class_ShaderGraph_node_get_pos:
  298. - :ref:`Vector2<class_vector2>` **node_get_pos** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  299. .. _class_ShaderGraph_node_get_state:
  300. - :ref:`Variant<class_variant>` **node_get_state** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  301. .. _class_ShaderGraph_node_get_type:
  302. - :ref:`int<class_int>` **node_get_type** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  303. .. _class_ShaderGraph_node_remove:
  304. - void **node_remove** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)**
  305. .. _class_ShaderGraph_node_set_pos:
  306. - void **node_set_pos** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` pos **)**
  307. .. _class_ShaderGraph_node_set_state:
  308. - void **node_set_state** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Variant<class_variant>` state **)**
  309. .. _class_ShaderGraph_rgb_const_node_get_value:
  310. - :ref:`Color<class_color>` **rgb_const_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  311. .. _class_ShaderGraph_rgb_const_node_set_value:
  312. - void **rgb_const_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Color<class_color>` value **)**
  313. .. _class_ShaderGraph_rgb_input_node_get_value:
  314. - :ref:`Color<class_color>` **rgb_input_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  315. .. _class_ShaderGraph_rgb_input_node_set_value:
  316. - void **rgb_input_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Color<class_color>` value **)**
  317. .. _class_ShaderGraph_rgb_op_node_get_op:
  318. - :ref:`int<class_int>` **rgb_op_node_get_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const
  319. .. _class_ShaderGraph_rgb_op_node_set_op:
  320. - void **rgb_op_node_set_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)**
  321. .. _class_ShaderGraph_scalar_const_node_get_value:
  322. - :ref:`float<class_float>` **scalar_const_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  323. .. _class_ShaderGraph_scalar_const_node_set_value:
  324. - void **scalar_const_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`float<class_float>` value **)**
  325. .. _class_ShaderGraph_scalar_func_node_get_function:
  326. - :ref:`int<class_int>` **scalar_func_node_get_function** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  327. .. _class_ShaderGraph_scalar_func_node_set_function:
  328. - void **scalar_func_node_set_function** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` func **)**
  329. .. _class_ShaderGraph_scalar_input_node_get_value:
  330. - :ref:`float<class_float>` **scalar_input_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  331. .. _class_ShaderGraph_scalar_input_node_set_value:
  332. - void **scalar_input_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`float<class_float>` value **)**
  333. .. _class_ShaderGraph_scalar_op_node_get_op:
  334. - :ref:`int<class_int>` **scalar_op_node_get_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const
  335. .. _class_ShaderGraph_scalar_op_node_set_op:
  336. - void **scalar_op_node_set_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)**
  337. .. _class_ShaderGraph_texture_input_node_get_value:
  338. - :ref:`Texture<class_texture>` **texture_input_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  339. .. _class_ShaderGraph_texture_input_node_set_value:
  340. - void **texture_input_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Texture<class_texture>` value **)**
  341. .. _class_ShaderGraph_texture_node_get_filter_size:
  342. - :ref:`int<class_int>` **texture_node_get_filter_size** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  343. .. _class_ShaderGraph_texture_node_get_filter_strength:
  344. - :ref:`float<class_float>` **texture_node_get_filter_strength** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const
  345. .. _class_ShaderGraph_texture_node_set_filter_size:
  346. - void **texture_node_set_filter_size** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` filter_size **)**
  347. .. _class_ShaderGraph_texture_node_set_filter_strength:
  348. - void **texture_node_set_filter_strength** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`float<class_float>` filter_strength **)**
  349. .. _class_ShaderGraph_vec_const_node_get_value:
  350. - :ref:`Vector3<class_vector3>` **vec_const_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  351. .. _class_ShaderGraph_vec_const_node_set_value:
  352. - void **vec_const_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` value **)**
  353. .. _class_ShaderGraph_vec_func_node_get_function:
  354. - :ref:`int<class_int>` **vec_func_node_get_function** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  355. .. _class_ShaderGraph_vec_func_node_set_function:
  356. - void **vec_func_node_set_function** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`int<class_int>` func **)**
  357. .. _class_ShaderGraph_vec_input_node_get_value:
  358. - :ref:`Vector3<class_vector3>` **vec_input_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  359. .. _class_ShaderGraph_vec_input_node_set_value:
  360. - void **vec_input_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` value **)**
  361. .. _class_ShaderGraph_vec_op_node_get_op:
  362. - :ref:`int<class_int>` **vec_op_node_get_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const
  363. .. _class_ShaderGraph_vec_op_node_set_op:
  364. - void **vec_op_node_set_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)**
  365. .. _class_ShaderGraph_vec_scalar_op_node_get_op:
  366. - :ref:`int<class_int>` **vec_scalar_op_node_get_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id **)** const
  367. .. _class_ShaderGraph_vec_scalar_op_node_set_op:
  368. - void **vec_scalar_op_node_set_op** **(** :ref:`int<class_int>` shader_type, :ref:`float<class_float>` id, :ref:`int<class_int>` op **)**
  369. .. _class_ShaderGraph_xform_const_node_get_value:
  370. - :ref:`Transform<class_transform>` **xform_const_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  371. .. _class_ShaderGraph_xform_const_node_set_value:
  372. - void **xform_const_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Transform<class_transform>` value **)**
  373. .. _class_ShaderGraph_xform_input_node_get_value:
  374. - :ref:`Transform<class_transform>` **xform_input_node_get_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  375. .. _class_ShaderGraph_xform_input_node_set_value:
  376. - void **xform_input_node_set_value** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`Transform<class_transform>` value **)**
  377. .. _class_ShaderGraph_xform_vec_mult_node_get_no_translation:
  378. - :ref:`bool<class_bool>` **xform_vec_mult_node_get_no_translation** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id **)** const
  379. .. _class_ShaderGraph_xform_vec_mult_node_set_no_translation:
  380. - void **xform_vec_mult_node_set_no_translation** **(** :ref:`int<class_int>` shader_type, :ref:`int<class_int>` id, :ref:`bool<class_bool>` disable **)**