godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

370
classes/class_visualshadernodefloatfunc.rst
View File

@@ -14,171 +14,323 @@ VisualShaderNodeFloatFunc
A scalar floating-point function to be used within the visual shader graph.
.. rst-class:: classref-introduction-group
Description
-----------
Accept a floating-point scalar (``x``) to the input port and transform it according to :ref:`function<class_VisualShaderNodeFloatFunc_property_function>`.
.. rst-class:: classref-reftable-group
Properties
----------
+----------------------------------------------------------+--------------------------------------------------------------------+--------+
| :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` | :ref:`function<class_VisualShaderNodeFloatFunc_property_function>` | ``13`` |
+----------------------------------------------------------+--------------------------------------------------------------------+--------+
.. table::
:widths: auto
+----------------------------------------------------------+--------------------------------------------------------------------+--------+
| :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` | :ref:`function<class_VisualShaderNodeFloatFunc_property_function>` | ``13`` |
+----------------------------------------------------------+--------------------------------------------------------------------+--------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_VisualShaderNodeFloatFunc_Function:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SIN:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_COS:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TAN:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ASIN:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ACOS:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ATAN:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SINH:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_COSH:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TANH:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_LOG:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_EXP:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SQRT:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ABS:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SIGN:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_FLOOR:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ROUND:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_CEIL:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_FRACT:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SATURATE:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_NEGATE:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ACOSH:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ASINH:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ATANH:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_DEGREES:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_EXP2:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_INVERSE_SQRT:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_LOG2:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_RADIANS:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_RECIPROCAL:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ROUNDEVEN:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TRUNC:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ONEMINUS:
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_MAX:
.. rst-class:: classref-enumeration
enum **Function**:
- **FUNC_SIN** = **0** --- Returns the sine of the parameter. Translates to ``sin(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SIN:
- **FUNC_COS** = **1** --- Returns the cosine of the parameter. Translates to ``cos(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_TAN** = **2** --- Returns the tangent of the parameter. Translates to ``tan(x)`` in the Godot Shader Language.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_SIN** = ``0``
- **FUNC_ASIN** = **3** --- Returns the arc-sine of the parameter. Translates to ``asin(x)`` in the Godot Shader Language.
Returns the sine of the parameter. Translates to ``sin(x)`` in the Godot Shader Language.
- **FUNC_ACOS** = **4** --- Returns the arc-cosine of the parameter. Translates to ``acos(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_COS:
- **FUNC_ATAN** = **5** --- Returns the arc-tangent of the parameter. Translates to ``atan(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_SINH** = **6** --- Returns the hyperbolic sine of the parameter. Translates to ``sinh(x)`` in the Godot Shader Language.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_COS** = ``1``
- **FUNC_COSH** = **7** --- Returns the hyperbolic cosine of the parameter. Translates to ``cosh(x)`` in the Godot Shader Language.
Returns the cosine of the parameter. Translates to ``cos(x)`` in the Godot Shader Language.
- **FUNC_TANH** = **8** --- Returns the hyperbolic tangent of the parameter. Translates to ``tanh(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TAN:
- **FUNC_LOG** = **9** --- Returns the natural logarithm of the parameter. Translates to ``log(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_EXP** = **10** --- Returns the natural exponentiation of the parameter. Translates to ``exp(x)`` in the Godot Shader Language.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_TAN** = ``2``
- **FUNC_SQRT** = **11** --- Returns the square root of the parameter. Translates to ``sqrt(x)`` in the Godot Shader Language.
Returns the tangent of the parameter. Translates to ``tan(x)`` in the Godot Shader Language.
- **FUNC_ABS** = **12** --- Returns the absolute value of the parameter. Translates to ``abs(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ASIN:
- **FUNC_SIGN** = **13** --- Extracts the sign of the parameter. Translates to ``sign(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_FLOOR** = **14** --- Finds the nearest integer less than or equal to the parameter. Translates to ``floor(x)`` in the Godot Shader Language.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ASIN** = ``3``
- **FUNC_ROUND** = **15** --- Finds the nearest integer to the parameter. Translates to ``round(x)`` in the Godot Shader Language.
Returns the arc-sine of the parameter. Translates to ``asin(x)`` in the Godot Shader Language.
- **FUNC_CEIL** = **16** --- Finds the nearest integer that is greater than or equal to the parameter. Translates to ``ceil(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ACOS:
- **FUNC_FRACT** = **17** --- Computes the fractional part of the argument. Translates to ``fract(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_SATURATE** = **18** --- Clamps the value between ``0.0`` and ``1.0`` using ``min(max(x, 0.0), 1.0)``.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ACOS** = ``4``
- **FUNC_NEGATE** = **19** --- Negates the ``x`` using ``-(x)``.
Returns the arc-cosine of the parameter. Translates to ``acos(x)`` in the Godot Shader Language.
- **FUNC_ACOSH** = **20** --- Returns the arc-hyperbolic-cosine of the parameter. Translates to ``acosh(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ATAN:
- **FUNC_ASINH** = **21** --- Returns the arc-hyperbolic-sine of the parameter. Translates to ``asinh(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_ATANH** = **22** --- Returns the arc-hyperbolic-tangent of the parameter. Translates to ``atanh(x)`` in the Godot Shader Language.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ATAN** = ``5``
- **FUNC_DEGREES** = **23** --- Convert a quantity in radians to degrees. Translates to ``degrees(x)`` in the Godot Shader Language.
Returns the arc-tangent of the parameter. Translates to ``atan(x)`` in the Godot Shader Language.
- **FUNC_EXP2** = **24** --- Returns 2 raised by the power of the parameter. Translates to ``exp2(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SINH:
- **FUNC_INVERSE_SQRT** = **25** --- Returns the inverse of the square root of the parameter. Translates to ``inversesqrt(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_LOG2** = **26** --- Returns the base 2 logarithm of the parameter. Translates to ``log2(x)`` in the Godot Shader Language.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_SINH** = ``6``
- **FUNC_RADIANS** = **27** --- Convert a quantity in degrees to radians. Translates to ``radians(x)`` in the Godot Shader Language.
Returns the hyperbolic sine of the parameter. Translates to ``sinh(x)`` in the Godot Shader Language.
- **FUNC_RECIPROCAL** = **28** --- Finds reciprocal value of dividing 1 by ``x`` (i.e. ``1 / x``).
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_COSH:
- **FUNC_ROUNDEVEN** = **29** --- Finds the nearest even integer to the parameter. Translates to ``roundEven(x)`` in the Godot Shader Language.
.. rst-class:: classref-enumeration-constant
- **FUNC_TRUNC** = **30** --- Returns a value equal to the nearest integer to ``x`` whose absolute value is not larger than the absolute value of ``x``. Translates to ``trunc(x)`` in the Godot Shader Language.
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_COSH** = ``7``
- **FUNC_ONEMINUS** = **31** --- Subtracts scalar ``x`` from 1 (i.e. ``1 - x``).
Returns the hyperbolic cosine of the parameter. Translates to ``cosh(x)`` in the Godot Shader Language.
- **FUNC_MAX** = **32** --- Represents the size of the :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` enum.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TANH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_TANH** = ``8``
Returns the hyperbolic tangent of the parameter. Translates to ``tanh(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_LOG:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_LOG** = ``9``
Returns the natural logarithm of the parameter. Translates to ``log(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_EXP:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_EXP** = ``10``
Returns the natural exponentiation of the parameter. Translates to ``exp(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SQRT:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_SQRT** = ``11``
Returns the square root of the parameter. Translates to ``sqrt(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ABS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ABS** = ``12``
Returns the absolute value of the parameter. Translates to ``abs(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SIGN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_SIGN** = ``13``
Extracts the sign of the parameter. Translates to ``sign(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_FLOOR:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_FLOOR** = ``14``
Finds the nearest integer less than or equal to the parameter. Translates to ``floor(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ROUND:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ROUND** = ``15``
Finds the nearest integer to the parameter. Translates to ``round(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_CEIL:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_CEIL** = ``16``
Finds the nearest integer that is greater than or equal to the parameter. Translates to ``ceil(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_FRACT:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_FRACT** = ``17``
Computes the fractional part of the argument. Translates to ``fract(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SATURATE:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_SATURATE** = ``18``
Clamps the value between ``0.0`` and ``1.0`` using ``min(max(x, 0.0), 1.0)``.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_NEGATE:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_NEGATE** = ``19``
Negates the ``x`` using ``-(x)``.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ACOSH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ACOSH** = ``20``
Returns the arc-hyperbolic-cosine of the parameter. Translates to ``acosh(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ASINH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ASINH** = ``21``
Returns the arc-hyperbolic-sine of the parameter. Translates to ``asinh(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ATANH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ATANH** = ``22``
Returns the arc-hyperbolic-tangent of the parameter. Translates to ``atanh(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_DEGREES:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_DEGREES** = ``23``
Convert a quantity in radians to degrees. Translates to ``degrees(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_EXP2:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_EXP2** = ``24``
Returns 2 raised by the power of the parameter. Translates to ``exp2(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_INVERSE_SQRT:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_INVERSE_SQRT** = ``25``
Returns the inverse of the square root of the parameter. Translates to ``inversesqrt(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_LOG2:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_LOG2** = ``26``
Returns the base 2 logarithm of the parameter. Translates to ``log2(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_RADIANS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_RADIANS** = ``27``
Convert a quantity in degrees to radians. Translates to ``radians(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_RECIPROCAL:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_RECIPROCAL** = ``28``
Finds reciprocal value of dividing 1 by ``x`` (i.e. ``1 / x``).
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ROUNDEVEN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ROUNDEVEN** = ``29``
Finds the nearest even integer to the parameter. Translates to ``roundEven(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TRUNC:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_TRUNC** = ``30``
Returns a value equal to the nearest integer to ``x`` whose absolute value is not larger than the absolute value of ``x``. Translates to ``trunc(x)`` in the Godot Shader Language.
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ONEMINUS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_ONEMINUS** = ``31``
Subtracts scalar ``x`` from 1 (i.e. ``1 - x``).
.. _class_VisualShaderNodeFloatFunc_constant_FUNC_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **FUNC_MAX** = ``32``
Represents the size of the :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` enum.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeFloatFunc_property_function:
- :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **function**
.. rst-class:: classref-property
+-----------+---------------------+
| *Default* | ``13`` |
+-----------+---------------------+
| *Setter* | set_function(value) |
+-----------+---------------------+
| *Getter* | get_function() |
+-----------+---------------------+
:ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **function** = ``13``
.. rst-class:: classref-property-setget
- void **set_function** **(** :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` value **)**
- :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **get_function** **(** **)**
A function to be applied to the scalar. See :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` for options.