class_visualshadernodescalarfunc.rst 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarFunc.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeScalarFunc:
  6. VisualShaderNodeScalarFunc
  7. ==========================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +-----------------------------------------------------------+---------------------------------------------------------------------+--------+
  12. | :ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` | :ref:`function<class_VisualShaderNodeScalarFunc_property_function>` | ``13`` |
  13. +-----------------------------------------------------------+---------------------------------------------------------------------+--------+
  14. Enumerations
  15. ------------
  16. .. _enum_VisualShaderNodeScalarFunc_Function:
  17. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIN:
  18. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_COS:
  19. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_TAN:
  20. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASIN:
  21. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOS:
  22. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATAN:
  23. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_SINH:
  24. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_COSH:
  25. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_TANH:
  26. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG:
  27. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP:
  28. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_SQRT:
  29. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ABS:
  30. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIGN:
  31. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_FLOOR:
  32. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUND:
  33. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_CEIL:
  34. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_FRAC:
  35. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_SATURATE:
  36. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_NEGATE:
  37. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOSH:
  38. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASINH:
  39. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATANH:
  40. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_DEGREES:
  41. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP2:
  42. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_INVERSE_SQRT:
  43. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG2:
  44. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_RADIANS:
  45. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_RECIPROCAL:
  46. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUNDEVEN:
  47. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_TRUNC:
  48. .. _class_VisualShaderNodeScalarFunc_constant_FUNC_ONEMINUS:
  49. enum **Function**:
  50. - **FUNC_SIN** = **0**
  51. - **FUNC_COS** = **1**
  52. - **FUNC_TAN** = **2**
  53. - **FUNC_ASIN** = **3**
  54. - **FUNC_ACOS** = **4**
  55. - **FUNC_ATAN** = **5**
  56. - **FUNC_SINH** = **6**
  57. - **FUNC_COSH** = **7**
  58. - **FUNC_TANH** = **8**
  59. - **FUNC_LOG** = **9**
  60. - **FUNC_EXP** = **10**
  61. - **FUNC_SQRT** = **11**
  62. - **FUNC_ABS** = **12**
  63. - **FUNC_SIGN** = **13**
  64. - **FUNC_FLOOR** = **14**
  65. - **FUNC_ROUND** = **15**
  66. - **FUNC_CEIL** = **16**
  67. - **FUNC_FRAC** = **17**
  68. - **FUNC_SATURATE** = **18**
  69. - **FUNC_NEGATE** = **19**
  70. - **FUNC_ACOSH** = **20**
  71. - **FUNC_ASINH** = **21**
  72. - **FUNC_ATANH** = **22**
  73. - **FUNC_DEGREES** = **23**
  74. - **FUNC_EXP2** = **24**
  75. - **FUNC_INVERSE_SQRT** = **25**
  76. - **FUNC_LOG2** = **26**
  77. - **FUNC_RADIANS** = **27**
  78. - **FUNC_RECIPROCAL** = **28**
  79. - **FUNC_ROUNDEVEN** = **29**
  80. - **FUNC_TRUNC** = **30**
  81. - **FUNC_ONEMINUS** = **31**
  82. Property Descriptions
  83. ---------------------
  84. .. _class_VisualShaderNodeScalarFunc_property_function:
  85. - :ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **function**
  86. +-----------+---------------------+
  87. | *Default* | ``13`` |
  88. +-----------+---------------------+
  89. | *Setter* | set_function(value) |
  90. +-----------+---------------------+
  91. | *Getter* | get_function() |
  92. +-----------+---------------------+
  93. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  94. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  95. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`