Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_visualshadernode.rst

class_visualshadernode.rst 13 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the VisualShaderNode.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_VisualShaderNode:
    8. 

  8. 

  9. VisualShaderNode
    10. 

  10. ================
    11. 

  11. 

  12. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`VisualShaderNodeBillboard<class_VisualShaderNodeBillboard>`, :ref:`VisualShaderNodeClamp<class_VisualShaderNodeClamp>`, :ref:`VisualShaderNodeColorFunc<class_VisualShaderNodeColorFunc>`, :ref:`VisualShaderNodeColorOp<class_VisualShaderNodeColorOp>`, :ref:`VisualShaderNodeCompare<class_VisualShaderNodeCompare>`, :ref:`VisualShaderNodeConstant<class_VisualShaderNodeConstant>`, :ref:`VisualShaderNodeCubemap<class_VisualShaderNodeCubemap>`, :ref:`VisualShaderNodeCustom<class_VisualShaderNodeCustom>`, :ref:`VisualShaderNodeDerivativeFunc<class_VisualShaderNodeDerivativeFunc>`, :ref:`VisualShaderNodeDeterminant<class_VisualShaderNodeDeterminant>`, :ref:`VisualShaderNodeDotProduct<class_VisualShaderNodeDotProduct>`, :ref:`VisualShaderNodeFloatFunc<class_VisualShaderNodeFloatFunc>`, :ref:`VisualShaderNodeFloatOp<class_VisualShaderNodeFloatOp>`, :ref:`VisualShaderNodeFresnel<class_VisualShaderNodeFresnel>`, :ref:`VisualShaderNodeIf<class_VisualShaderNodeIf>`, :ref:`VisualShaderNodeInput<class_VisualShaderNodeInput>`, :ref:`VisualShaderNodeIntFunc<class_VisualShaderNodeIntFunc>`, :ref:`VisualShaderNodeIntOp<class_VisualShaderNodeIntOp>`, :ref:`VisualShaderNodeIs<class_VisualShaderNodeIs>`, :ref:`VisualShaderNodeMix<class_VisualShaderNodeMix>`, :ref:`VisualShaderNodeMultiplyAdd<class_VisualShaderNodeMultiplyAdd>`, :ref:`VisualShaderNodeOuterProduct<class_VisualShaderNodeOuterProduct>`, :ref:`VisualShaderNodeOutput<class_VisualShaderNodeOutput>`, :ref:`VisualShaderNodeParticleAccelerator<class_VisualShaderNodeParticleAccelerator>`, :ref:`VisualShaderNodeParticleConeVelocity<class_VisualShaderNodeParticleConeVelocity>`, :ref:`VisualShaderNodeParticleEmit<class_VisualShaderNodeParticleEmit>`, :ref:`VisualShaderNodeParticleEmitter<class_VisualShaderNodeParticleEmitter>`, :ref:`VisualShaderNodeParticleMultiplyByAxisAngle<class_VisualShaderNodeParticleMultiplyByAxisAngle>`, :ref:`VisualShaderNodeParticleRandomness<class_VisualShaderNodeParticleRandomness>`, :ref:`VisualShaderNodeResizableBase<class_VisualShaderNodeResizableBase>`, :ref:`VisualShaderNodeSDFRaymarch<class_VisualShaderNodeSDFRaymarch>`, :ref:`VisualShaderNodeSDFToScreenUV<class_VisualShaderNodeSDFToScreenUV>`, :ref:`VisualShaderNodeSample3D<class_VisualShaderNodeSample3D>`, :ref:`VisualShaderNodeScreenUVToSDF<class_VisualShaderNodeScreenUVToSDF>`, :ref:`VisualShaderNodeSmoothStep<class_VisualShaderNodeSmoothStep>`, :ref:`VisualShaderNodeStep<class_VisualShaderNodeStep>`, :ref:`VisualShaderNodeSwitch<class_VisualShaderNodeSwitch>`, :ref:`VisualShaderNodeTexture<class_VisualShaderNodeTexture>`, :ref:`VisualShaderNodeTextureSDF<class_VisualShaderNodeTextureSDF>`, :ref:`VisualShaderNodeTextureSDFNormal<class_VisualShaderNodeTextureSDFNormal>`, :ref:`VisualShaderNodeTransformCompose<class_VisualShaderNodeTransformCompose>`, :ref:`VisualShaderNodeTransformDecompose<class_VisualShaderNodeTransformDecompose>`, :ref:`VisualShaderNodeTransformFunc<class_VisualShaderNodeTransformFunc>`, :ref:`VisualShaderNodeTransformOp<class_VisualShaderNodeTransformOp>`, :ref:`VisualShaderNodeTransformVecMult<class_VisualShaderNodeTransformVecMult>`, :ref:`VisualShaderNodeUVFunc<class_VisualShaderNodeUVFunc>`, :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>`, :ref:`VisualShaderNodeUniformRef<class_VisualShaderNodeUniformRef>`, :ref:`VisualShaderNodeVarying<class_VisualShaderNodeVarying>`, :ref:`VisualShaderNodeVectorBase<class_VisualShaderNodeVectorBase>`, :ref:`VisualShaderNodeVectorRefract<class_VisualShaderNodeVectorRefract>`
    15. 

  15. 

  16. Base class for nodes in a visual shader graph.
    17. 

  17. 

  18. Description
    19. 

  19. -----------
    20. 

  20. 

  21. Visual shader graphs consist of various nodes. Each node in the graph is a separate object and they are represented as a rectangular boxes with title and a set of properties. Each node has also connection ports that allow to connect it to another nodes and control the flow of the shader.
    22. 

  22. 

  23. Tutorials
    24. 

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

  25. 

  26. - :doc:`VisualShaders <../tutorials/shaders/visual_shaders>`
    27. 

  27. 

  28. Properties
    29. 

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

  30. 

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

  32. | :ref:`int<class_int>` | :ref:`output_port_for_preview<class_VisualShaderNode_property_output_port_for_preview>` | ``-1`` |
    33. 

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

  34. 

  35. Methods
    36. 

  36. -------
    37. 

  37. 

  38. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | void                          | :ref:`clear_default_input_values<class_VisualShaderNode_method_clear_default_input_values>` **(** **)**                                                                                                                    |
    40. 

  40. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`Array<class_Array>`     | :ref:`get_default_input_values<class_VisualShaderNode_method_get_default_input_values>` **(** **)** |const|                                                                                                                |
    42. 

  42. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`Variant<class_Variant>` | :ref:`get_input_port_default_value<class_VisualShaderNode_method_get_input_port_default_value>` **(** :ref:`int<class_int>` port **)** |const|                                                                             |
    44. 

  44. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | void                          | :ref:`remove_input_port_default_value<class_VisualShaderNode_method_remove_input_port_default_value>` **(** :ref:`int<class_int>` port **)**                                                                               |
    46. 

  46. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | void                          | :ref:`set_default_input_values<class_VisualShaderNode_method_set_default_input_values>` **(** :ref:`Array<class_Array>` values **)**                                                                                       |
    48. 

  48. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | void                          | :ref:`set_input_port_default_value<class_VisualShaderNode_method_set_input_port_default_value>` **(** :ref:`int<class_int>` port, :ref:`Variant<class_Variant>` value, :ref:`Variant<class_Variant>` prev_value=null **)** |
    50. 

  50. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. 

  52. Signals
    53. 

  53. -------
    54. 

  54. 

  55. .. _class_VisualShaderNode_signal_editor_refresh_request:
    56. 

  56. 

  57. - **editor_refresh_request** **(** **)**
    58. 

  58. 

  59. Emitted when the node requests an editor refresh. Currently called only in setter of :ref:`VisualShaderNodeTexture.source<class_VisualShaderNodeTexture_property_source>`, :ref:`VisualShaderNodeTexture<class_VisualShaderNodeTexture>`, and :ref:`VisualShaderNodeCubemap<class_VisualShaderNodeCubemap>` (and their derivatives).
    60. 

  60. 

  61. Enumerations
    62. 

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

  63. 

  64. .. _enum_VisualShaderNode_PortType:
    65. 

  65. 

  66. .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR:
    67. 

  67. 

  68. .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR_INT:
    69. 

  69. 

  70. .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR_2D:
    71. 

  71. 

  72. .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR_3D:
    73. 

  73. 

  74. .. _class_VisualShaderNode_constant_PORT_TYPE_BOOLEAN:
    75. 

  75. 

  76. .. _class_VisualShaderNode_constant_PORT_TYPE_TRANSFORM:
    77. 

  77. 

  78. .. _class_VisualShaderNode_constant_PORT_TYPE_SAMPLER:
    79. 

  79. 

  80. .. _class_VisualShaderNode_constant_PORT_TYPE_MAX:
    81. 

  81. 

  82. enum **PortType**:
    83. 

  83. 

  84. - **PORT_TYPE_SCALAR** = **0** --- Floating-point scalar. Translated to ``float`` type in shader code.
    85. 

  85. 

  86. - **PORT_TYPE_SCALAR_INT** = **1** --- Integer scalar. Translated to ``int`` type in shader code.
    87. 

  87. 

  88. - **PORT_TYPE_VECTOR_2D** = **2** --- 2D vector of floating-point values. Translated to ``vec2`` type in shader code.
    89. 

  89. 

  90. - **PORT_TYPE_VECTOR_3D** = **3** --- 3D vector of floating-point values. Translated to ``vec3`` type in shader code.
    91. 

  91. 

  92. - **PORT_TYPE_BOOLEAN** = **4** --- Boolean type. Translated to ``bool`` type in shader code.
    93. 

  93. 

  94. - **PORT_TYPE_TRANSFORM** = **5** --- Transform type. Translated to ``mat4`` type in shader code.
    95. 

  95. 

  96. - **PORT_TYPE_SAMPLER** = **6** --- Sampler type. Translated to reference of sampler uniform in shader code. Can only be used for input ports in non-uniform nodes.
    97. 

  97. 

  98. - **PORT_TYPE_MAX** = **7** --- Represents the size of the :ref:`PortType<enum_VisualShaderNode_PortType>` enum.
    99. 

  99. 

  100. Property Descriptions
    101. 

  101. ---------------------
    102. 

  102. 

  103. .. _class_VisualShaderNode_property_output_port_for_preview:
    104. 

  104. 

  105. - :ref:`int<class_int>` **output_port_for_preview**
    106. 

  106. 

  107. +-----------+------------------------------------+
    108. 

  108. | *Default* | ``-1``                             |
    109. 

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

  110. | *Setter*  | set_output_port_for_preview(value) |
    111. 

  111. +-----------+------------------------------------+
    112. 

  112. | *Getter*  | get_output_port_for_preview()      |
    113. 

  113. +-----------+------------------------------------+
    114. 

  114. 

  115. Sets the output port index which will be showed for preview. If set to ``-1`` no port will be open for preview.
    116. 

  116. 

  117. Method Descriptions
    118. 

  118. -------------------
    119. 

  119. 

  120. .. _class_VisualShaderNode_method_clear_default_input_values:
    121. 

  121. 

  122. - void **clear_default_input_values** **(** **)**
    123. 

  123. 

  124. Clears the default input ports value.
    125. 

  125. 

  126. ----
    127. 

  127. 

  128. .. _class_VisualShaderNode_method_get_default_input_values:
    129. 

  129. 

  130. - :ref:`Array<class_Array>` **get_default_input_values** **(** **)** |const|
    131. 

  131. 

  132. Returns an :ref:`Array<class_Array>` containing default values for all of the input ports of the node in the form ``[index0, value0, index1, value1, ...]``.
    133. 

  133. 

  134. ----
    135. 

  135. 

  136. .. _class_VisualShaderNode_method_get_input_port_default_value:
    137. 

  137. 

  138. - :ref:`Variant<class_Variant>` **get_input_port_default_value** **(** :ref:`int<class_int>` port **)** |const|
    139. 

  139. 

  140. Returns the default value of the input ``port``.
    141. 

  141. 

  142. ----
    143. 

  143. 

  144. .. _class_VisualShaderNode_method_remove_input_port_default_value:
    145. 

  145. 

  146. - void **remove_input_port_default_value** **(** :ref:`int<class_int>` port **)**
    147. 

  147. 

  148. Removes the default value of the input ``port``.
    149. 

  149. 

  150. ----
    151. 

  151. 

  152. .. _class_VisualShaderNode_method_set_default_input_values:
    153. 

  153. 

  154. - void **set_default_input_values** **(** :ref:`Array<class_Array>` values **)**
    155. 

  155. 

  156. Sets the default input ports values using an :ref:`Array<class_Array>` of the form ``[index0, value0, index1, value1, ...]``. For example: ``[0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)]``.
    157. 

  157. 

  158. ----
    159. 

  159. 

  160. .. _class_VisualShaderNode_method_set_input_port_default_value:
    161. 

  161. 

  162. - void **set_input_port_default_value** **(** :ref:`int<class_int>` port, :ref:`Variant<class_Variant>` value, :ref:`Variant<class_Variant>` prev_value=null **)**
    163. 

  163. 

  164. Sets the default value for the selected input ``port``.
    165. 

  165. 

  166. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    167. 

  167. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    168. 

  168. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    169. 

  169. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    170. 

  170. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    171. 

  171. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    172.