首頁 探索 說明
登入
godotengine
/
godot-docs
镜像来自 https://github.com/godotengine/godot-docs
關註 1
讚好 1
複刻 0
檔案
分支: 3.2
分支列表 標籤列表
godot-docs
/
classes
/
class_visualshadernode.rst

class_visualshadernode.rst 9.8 KB
永久連結 文件歷史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.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:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`VisualShaderNodeBooleanConstant<class_VisualShaderNodeBooleanConstant>`, :ref:`VisualShaderNodeColorConstant<class_VisualShaderNodeColorConstant>`, :ref:`VisualShaderNodeColorFunc<class_VisualShaderNodeColorFunc>`, :ref:`VisualShaderNodeColorOp<class_VisualShaderNodeColorOp>`, :ref:`VisualShaderNodeCompare<class_VisualShaderNodeCompare>`, :ref:`VisualShaderNodeCubeMap<class_VisualShaderNodeCubeMap>`, :ref:`VisualShaderNodeCustom<class_VisualShaderNodeCustom>`, :ref:`VisualShaderNodeDeterminant<class_VisualShaderNodeDeterminant>`, :ref:`VisualShaderNodeDotProduct<class_VisualShaderNodeDotProduct>`, :ref:`VisualShaderNodeFaceForward<class_VisualShaderNodeFaceForward>`, :ref:`VisualShaderNodeFresnel<class_VisualShaderNodeFresnel>`, :ref:`VisualShaderNodeGroupBase<class_VisualShaderNodeGroupBase>`, :ref:`VisualShaderNodeIf<class_VisualShaderNodeIf>`, :ref:`VisualShaderNodeInput<class_VisualShaderNodeInput>`, :ref:`VisualShaderNodeIs<class_VisualShaderNodeIs>`, :ref:`VisualShaderNodeOuterProduct<class_VisualShaderNodeOuterProduct>`, :ref:`VisualShaderNodeOutput<class_VisualShaderNodeOutput>`, :ref:`VisualShaderNodeScalarClamp<class_VisualShaderNodeScalarClamp>`, :ref:`VisualShaderNodeScalarConstant<class_VisualShaderNodeScalarConstant>`, :ref:`VisualShaderNodeScalarDerivativeFunc<class_VisualShaderNodeScalarDerivativeFunc>`, :ref:`VisualShaderNodeScalarFunc<class_VisualShaderNodeScalarFunc>`, :ref:`VisualShaderNodeScalarInterp<class_VisualShaderNodeScalarInterp>`, :ref:`VisualShaderNodeScalarOp<class_VisualShaderNodeScalarOp>`, :ref:`VisualShaderNodeScalarSmoothStep<class_VisualShaderNodeScalarSmoothStep>`, :ref:`VisualShaderNodeSwitch<class_VisualShaderNodeSwitch>`, :ref:`VisualShaderNodeTexture<class_VisualShaderNodeTexture>`, :ref:`VisualShaderNodeTransformCompose<class_VisualShaderNodeTransformCompose>`, :ref:`VisualShaderNodeTransformConstant<class_VisualShaderNodeTransformConstant>`, :ref:`VisualShaderNodeTransformDecompose<class_VisualShaderNodeTransformDecompose>`, :ref:`VisualShaderNodeTransformFunc<class_VisualShaderNodeTransformFunc>`, :ref:`VisualShaderNodeTransformMult<class_VisualShaderNodeTransformMult>`, :ref:`VisualShaderNodeTransformVecMult<class_VisualShaderNodeTransformVecMult>`, :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>`, :ref:`VisualShaderNodeVec3Constant<class_VisualShaderNodeVec3Constant>`, :ref:`VisualShaderNodeVectorClamp<class_VisualShaderNodeVectorClamp>`, :ref:`VisualShaderNodeVectorCompose<class_VisualShaderNodeVectorCompose>`, :ref:`VisualShaderNodeVectorDecompose<class_VisualShaderNodeVectorDecompose>`, :ref:`VisualShaderNodeVectorDerivativeFunc<class_VisualShaderNodeVectorDerivativeFunc>`, :ref:`VisualShaderNodeVectorDistance<class_VisualShaderNodeVectorDistance>`, :ref:`VisualShaderNodeVectorFunc<class_VisualShaderNodeVectorFunc>`, :ref:`VisualShaderNodeVectorInterp<class_VisualShaderNodeVectorInterp>`, :ref:`VisualShaderNodeVectorLen<class_VisualShaderNodeVectorLen>`, :ref:`VisualShaderNodeVectorOp<class_VisualShaderNodeVectorOp>`, :ref:`VisualShaderNodeVectorRefract<class_VisualShaderNodeVectorRefract>`, :ref:`VisualShaderNodeVectorScalarMix<class_VisualShaderNodeVectorScalarMix>`, :ref:`VisualShaderNodeVectorScalarSmoothStep<class_VisualShaderNodeVectorScalarSmoothStep>`, :ref:`VisualShaderNodeVectorScalarStep<class_VisualShaderNodeVectorScalarStep>`, :ref:`VisualShaderNodeVectorSmoothStep<class_VisualShaderNodeVectorSmoothStep>`
    15. 

  15. 

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

  17. 

  18. Tutorials
    19. 

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

  20. 

  21. - :doc:`../tutorials/shading/visual_shaders`
    22. 

  22. 

  23. Properties
    24. 

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

  25. 

  26. +-----------------------+-----------------------------------------------------------------------------------------+--------+
    27. 

  27. | :ref:`int<class_int>` | :ref:`output_port_for_preview<class_VisualShaderNode_property_output_port_for_preview>` | ``-1`` |
    28. 

  28. +-----------------------+-----------------------------------------------------------------------------------------+--------+
    29. 

  29. 

  30. Methods
    31. 

  31. -------
    32. 

  32. 

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

  34. | :ref:`Array<class_Array>`     | :ref:`get_default_input_values<class_VisualShaderNode_method_get_default_input_values>` **(** **)** |const|                                                                 |
    35. 

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

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

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

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

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

  40. | 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 **)** |
    41. 

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

  42. 

  43. Signals
    44. 

  44. -------
    45. 

  45. 

  46. .. _class_VisualShaderNode_signal_editor_refresh_request:
    47. 

  47. 

  48. - **editor_refresh_request** **(** **)**
    49. 

  49. 

  50. 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).
    51. 

  51. 

  52. Enumerations
    53. 

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

  54. 

  55. .. _enum_VisualShaderNode_PortType:
    56. 

  56. 

  57. .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR:
    58. 

  58. 

  59. .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR:
    60. 

  60. 

  61. .. _class_VisualShaderNode_constant_PORT_TYPE_BOOLEAN:
    62. 

  62. 

  63. .. _class_VisualShaderNode_constant_PORT_TYPE_TRANSFORM:
    64. 

  64. 

  65. .. _class_VisualShaderNode_constant_PORT_TYPE_SAMPLER:
    66. 

  66. 

  67. .. _class_VisualShaderNode_constant_PORT_TYPE_MAX:
    68. 

  68. 

  69. enum **PortType**:
    70. 

  70. 

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

  72. 

  73. - **PORT_TYPE_VECTOR** = **1** --- 3D vector of floating-point values. Translated to ``vec3`` type in shader code.
    74. 

  74. 

  75. - **PORT_TYPE_BOOLEAN** = **2** --- Boolean type. Translated to ``bool`` type in shader code.
    76. 

  76. 

  77. - **PORT_TYPE_TRANSFORM** = **3** --- Transform type. Translated to ``mat4`` type in shader code.
    78. 

  78. 

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

  80. 

  81. - **PORT_TYPE_MAX** = **5** --- Represents the size of the :ref:`PortType<enum_VisualShaderNode_PortType>` enum.
    82. 

  82. 

  83. Property Descriptions
    84. 

  84. ---------------------
    85. 

  85. 

  86. .. _class_VisualShaderNode_property_output_port_for_preview:
    87. 

  87. 

  88. - :ref:`int<class_int>` **output_port_for_preview**
    89. 

  89. 

  90. +-----------+------------------------------------+
    91. 

  91. | *Default* | ``-1``                             |
    92. 

  92. +-----------+------------------------------------+
    93. 

  93. | *Setter*  | set_output_port_for_preview(value) |
    94. 

  94. +-----------+------------------------------------+
    95. 

  95. | *Getter*  | get_output_port_for_preview()      |
    96. 

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

  97. 

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

  99. 

  100. Method Descriptions
    101. 

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

  102. 

  103. .. _class_VisualShaderNode_method_get_default_input_values:
    104. 

  104. 

  105. - :ref:`Array<class_Array>` **get_default_input_values** **(** **)** |const|
    106. 

  106. 

  107. 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, ...]``.
    108. 

  108. 

  109. ----
    110. 

  110. 

  111. .. _class_VisualShaderNode_method_get_input_port_default_value:
    112. 

  112. 

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

  114. 

  115. Returns the default value of the input ``port``.
    116. 

  116. 

  117. ----
    118. 

  118. 

  119. .. _class_VisualShaderNode_method_set_default_input_values:
    120. 

  120. 

  121. - void **set_default_input_values** **(** :ref:`Array<class_Array>` values **)**
    122. 

  122. 

  123. 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)]``.
    124. 

  124. 

  125. ----
    126. 

  126. 

  127. .. _class_VisualShaderNode_method_set_input_port_default_value:
    128. 

  128. 

  129. - void **set_input_port_default_value** **(** :ref:`int<class_int>` port, :ref:`Variant<class_Variant>` value **)**
    130. 

  130. 

  131. Sets the default value for the selected input ``port``.
    132. 

  132. 

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

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

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

  136.