godot-docs/classes/class_visualshadernodefloatfunc.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatFunc.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VisualShaderNodeFloatFunc:

VisualShaderNodeFloatFunc
=========================

**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A scalar floating-point function to be used within the visual shader graph.

Description
-----------

Accept a floating-point scalar (``x``) to the input port and transform it according to :ref:`function<class_VisualShaderNodeFloatFunc_property_function>`.

Properties
----------

+----------------------------------------------------------+--------------------------------------------------------------------+--------+
| :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` | :ref:`function<class_VisualShaderNodeFloatFunc_property_function>` | ``13`` |
+----------------------------------------------------------+--------------------------------------------------------------------+--------+

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_FRAC:

.. _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:

enum **Function**:

- **FUNC_SIN** = **0** --- Returns the sine of the parameter. Translates to ``sin(x)`` in the Godot Shader Language.

- **FUNC_COS** = **1** --- Returns the cosine of the parameter. Translates to ``cos(x)`` in the Godot Shader Language.

- **FUNC_TAN** = **2** --- Returns the tangent of the parameter. Translates to ``tan(x)`` in the Godot Shader Language.

- **FUNC_ASIN** = **3** --- Returns the arc-sine of the parameter. Translates to ``asin(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.

- **FUNC_ATAN** = **5** --- Returns the arc-tangent of the parameter. Translates to ``atan(x)`` in the Godot Shader Language.

- **FUNC_SINH** = **6** --- Returns the hyperbolic sine of the parameter. Translates to ``sinh(x)`` in the Godot Shader Language.

- **FUNC_COSH** = **7** --- Returns the hyperbolic cosine of the parameter. Translates to ``cosh(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.

- **FUNC_LOG** = **9** --- Returns the natural logarithm of the parameter. Translates to ``log(x)`` in the Godot Shader Language.

- **FUNC_EXP** = **10** --- Returns the natural exponentiation of the parameter. Translates to ``exp(x)`` in the Godot Shader Language.

- **FUNC_SQRT** = **11** --- Returns the square root of the parameter. Translates to ``sqrt(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.

- **FUNC_SIGN** = **13** --- Extracts the sign of the parameter. Translates to ``sign(x)`` in the Godot Shader Language.

- **FUNC_FLOOR** = **14** --- Finds the nearest integer less than or equal to the parameter. Translates to ``floor(x)`` in the Godot Shader Language.

- **FUNC_ROUND** = **15** --- Finds the nearest integer to the parameter. Translates to ``round(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.

- **FUNC_FRAC** = **17** --- Computes the fractional part of the argument. Translates to ``fract(x)`` in the Godot Shader Language.

- **FUNC_SATURATE** = **18** --- Clamps the value between ``0.0`` and ``1.0`` using ``min(max(x, 0.0), 1.0)``.

- **FUNC_NEGATE** = **19** --- Negates the ``x`` using ``-(x)``.

- **FUNC_ACOSH** = **20** --- Returns the arc-hyperbolic-cosine of the parameter. Translates to ``acosh(x)`` in the Godot Shader Language.

- **FUNC_ASINH** = **21** --- Returns the arc-hyperbolic-sine of the parameter. Translates to ``asinh(x)`` in the Godot Shader Language.

- **FUNC_ATANH** = **22** --- Returns the arc-hyperbolic-tangent of the parameter. Translates to ``atanh(x)`` in the Godot Shader Language.

- **FUNC_DEGREES** = **23** --- Convert a quantity in radians to degrees. Translates to ``degrees(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.

- **FUNC_INVERSE_SQRT** = **25** --- Returns the inverse of the square root of the parameter. Translates to ``inversesqrt(x)`` in the Godot Shader Language.

- **FUNC_LOG2** = **26** --- Returns the base 2 logarithm of the parameter. Translates to ``log2(x)`` in the Godot Shader Language.

- **FUNC_RADIANS** = **27** --- Convert a quantity in degrees to radians. Translates to ``radians(x)`` in the Godot Shader Language.

- **FUNC_RECIPROCAL** = **28** --- Finds reciprocal value of dividing 1 by ``x`` (i.e. ``1 / x``).

- **FUNC_ROUNDEVEN** = **29** --- Finds the nearest even integer to the parameter. Translates to ``roundEven(x)`` in the Godot Shader Language.

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

- **FUNC_ONEMINUS** = **31** --- Subtracts scalar ``x`` from 1 (i.e. ``1 - x``).

- **FUNC_MAX** = **32** --- Represents the size of the :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` enum.

Property Descriptions
---------------------

.. _class_VisualShaderNodeFloatFunc_property_function:

- :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` **function**

+-----------+---------------------+
| *Default* | ``13``              |
+-----------+---------------------+
| *Setter*  | set_function(value) |
+-----------+---------------------+
| *Getter*  | get_function()      |
+-----------+---------------------+

A function to be applied to the scalar. See :ref:`Function<enum_VisualShaderNodeFloatFunc_Function>` for options.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`