pandemonium_engine_docs/classes/class_visualshadernodescalarfunc.rst

176 lines
4.5 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarFunc.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeScalarFunc:
VisualShaderNodeScalarFunc
==========================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Properties
----------
+-----------------------------------------------------------+---------------------------------------------------------------------+--------+
| :ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` | :ref:`function<class_VisualShaderNodeScalarFunc_property_function>` | ``13`` |
+-----------------------------------------------------------+---------------------------------------------------------------------+--------+
Enumerations
------------
.. _enum_VisualShaderNodeScalarFunc_Function:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIN:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COS:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TAN:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASIN:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOS:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATAN:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SINH:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COSH:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TANH:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SQRT:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ABS:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIGN:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FLOOR:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUND:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_CEIL:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FRAC:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SATURATE:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_NEGATE:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOSH:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASINH:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATANH:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_DEGREES:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP2:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_INVERSE_SQRT:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG2:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RADIANS:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RECIPROCAL:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUNDEVEN:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TRUNC:
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ONEMINUS:
enum **Function**:
- **FUNC_SIN** = **0**
- **FUNC_COS** = **1**
- **FUNC_TAN** = **2**
- **FUNC_ASIN** = **3**
- **FUNC_ACOS** = **4**
- **FUNC_ATAN** = **5**
- **FUNC_SINH** = **6**
- **FUNC_COSH** = **7**
- **FUNC_TANH** = **8**
- **FUNC_LOG** = **9**
- **FUNC_EXP** = **10**
- **FUNC_SQRT** = **11**
- **FUNC_ABS** = **12**
- **FUNC_SIGN** = **13**
- **FUNC_FLOOR** = **14**
- **FUNC_ROUND** = **15**
- **FUNC_CEIL** = **16**
- **FUNC_FRAC** = **17**
- **FUNC_SATURATE** = **18**
- **FUNC_NEGATE** = **19**
- **FUNC_ACOSH** = **20**
- **FUNC_ASINH** = **21**
- **FUNC_ATANH** = **22**
- **FUNC_DEGREES** = **23**
- **FUNC_EXP2** = **24**
- **FUNC_INVERSE_SQRT** = **25**
- **FUNC_LOG2** = **26**
- **FUNC_RADIANS** = **27**
- **FUNC_RECIPROCAL** = **28**
- **FUNC_ROUNDEVEN** = **29**
- **FUNC_TRUNC** = **30**
- **FUNC_ONEMINUS** = **31**
Property Descriptions
---------------------
.. _class_VisualShaderNodeScalarFunc_property_function:
- :ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **function**
+-----------+---------------------+
| *Default* | ``13`` |
+-----------+---------------------+
| *Setter* | set_function(value) |
+-----------+---------------------+
| *Getter* | get_function() |
+-----------+---------------------+
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`