329 lines
8.5 KiB
ReStructuredText
329 lines
8.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarFunc.xml.
|
|
|
|
.. _class_VisualShaderNodeScalarFunc:
|
|
|
|
VisualShaderNodeScalarFunc
|
|
==========================
|
|
|
|
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------------------------------+---------------------------------------------------------------------+--------+
|
|
| :ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` | :ref:`function<class_VisualShaderNodeScalarFunc_property_function>` | ``13`` |
|
|
+-----------------------------------------------------------+---------------------------------------------------------------------+--------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeScalarFunc_Function:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Function**:
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_SIN** = ``0``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_COS** = ``1``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TAN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_TAN** = ``2``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASIN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ASIN** = ``3``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ACOS** = ``4``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATAN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ATAN** = ``5``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SINH:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_SINH** = ``6``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COSH:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_COSH** = ``7``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TANH:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_TANH** = ``8``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_LOG** = ``9``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_EXP** = ``10``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SQRT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_SQRT** = ``11``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ABS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ABS** = ``12``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIGN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_SIGN** = ``13``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FLOOR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_FLOOR** = ``14``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUND:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ROUND** = ``15``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_CEIL:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_CEIL** = ``16``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FRAC:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_FRAC** = ``17``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SATURATE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_SATURATE** = ``18``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_NEGATE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_NEGATE** = ``19``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOSH:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ACOSH** = ``20``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASINH:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ASINH** = ``21``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATANH:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ATANH** = ``22``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_DEGREES:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_DEGREES** = ``23``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP2:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_EXP2** = ``24``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_INVERSE_SQRT:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_INVERSE_SQRT** = ``25``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG2:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_LOG2** = ``26``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RADIANS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_RADIANS** = ``27``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RECIPROCAL:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_RECIPROCAL** = ``28``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUNDEVEN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ROUNDEVEN** = ``29``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TRUNC:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_TRUNC** = ``30``
|
|
|
|
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ONEMINUS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **FUNC_ONEMINUS** = ``31``
|
|
|
|
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeScalarFunc_property_function:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **function** = ``13``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_function** **(** :ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` value **)**
|
|
- :ref:`Function<enum_VisualShaderNodeScalarFunc_Function>` **get_function** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. |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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|