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: 9329aa8b51
Branches Tags
godot-docs
/
classes
/
class_visualshadernode.rst

class_visualshadernode.rst 7.9 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111 
  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. 

  17. 

  18. Properties
    19. 

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

  20. 

  21. +---------------------------+-----------------------------------------------------------------------------------------+-------------------------------+
    22. 

  22. | :ref:`Array<class_Array>` | :ref:`default_input_values<class_VisualShaderNode_property_default_input_values>`       | ``[ 0, Vector3( 0, 0, 0 ) ]`` |
    23. 

  23. +---------------------------+-----------------------------------------------------------------------------------------+-------------------------------+
    24. 

  24. | :ref:`int<class_int>`     | :ref:`output_port_for_preview<class_VisualShaderNode_property_output_port_for_preview>` | ``-1``                        |
    25. 

  25. +---------------------------+-----------------------------------------------------------------------------------------+-------------------------------+
    26. 

  26. 

  27. Methods
    28. 

  28. -------
    29. 

  29. 

  30. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

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

  32. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | 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 **)** |
    34. 

  34. +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. 

  36. Signals
    37. 

  37. -------
    38. 

  38. 

  39. .. _class_VisualShaderNode_signal_editor_refresh_request:
    40. 

  40. 

  41. - **editor_refresh_request** **(** **)**
    42. 

  42. 

  43. Enumerations
    44. 

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

  45. 

  46. .. _enum_VisualShaderNode_PortType:
    47. 

  47. 

  48. .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR:
    49. 

  49. 

  50. .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR:
    51. 

  51. 

  52. .. _class_VisualShaderNode_constant_PORT_TYPE_BOOLEAN:
    53. 

  53. 

  54. .. _class_VisualShaderNode_constant_PORT_TYPE_TRANSFORM:
    55. 

  55. 

  56. .. _class_VisualShaderNode_constant_PORT_TYPE_SAMPLER:
    57. 

  57. 

  58. .. _class_VisualShaderNode_constant_PORT_TYPE_MAX:
    59. 

  59. 

  60. enum **PortType**:
    61. 

  61. 

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

  63. 

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

  65. 

  66. - **PORT_TYPE_BOOLEAN** = **2** --- Boolean type. Translated to ``bool`` type in shader code.
    67. 

  67. 

  68. - **PORT_TYPE_TRANSFORM** = **3** --- Transform type. Translated to ``mat4`` type in shader code.
    69. 

  69. 

  70. - **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.
    71. 

  71. 

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

  73. 

  74. Property Descriptions
    75. 

  75. ---------------------
    76. 

  76. 

  77. .. _class_VisualShaderNode_property_default_input_values:
    78. 

  78. 

  79. - :ref:`Array<class_Array>` **default_input_values**
    80. 

  80. 

  81. +-----------+-------------------------------+
    82. 

  82. | *Default* | ``[ 0, Vector3( 0, 0, 0 ) ]`` |
    83. 

  83. +-----------+-------------------------------+
    84. 

  84. 

  85. ----
    86. 

  86. 

  87. .. _class_VisualShaderNode_property_output_port_for_preview:
    88. 

  88. 

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

  90. 

  91. +-----------+------------------------------------+
    92. 

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

  93. +-----------+------------------------------------+
    94. 

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

  95. +-----------+------------------------------------+
    96. 

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

  97. +-----------+------------------------------------+
    98. 

  98. 

  99. Method Descriptions
    100. 

  100. -------------------
    101. 

  101. 

  102. .. _class_VisualShaderNode_method_get_input_port_default_value:
    103. 

  103. 

  104. - :ref:`Variant<class_Variant>` **get_input_port_default_value** **(** :ref:`int<class_int>` port **)** const
    105. 

  105. 

  106. ----
    107. 

  107. 

  108. .. _class_VisualShaderNode_method_set_input_port_default_value:
    109. 

  109. 

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

  111.