godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.5
godot-docs/classes/class_visualshadernodevectorfunc.rst
Godot Organization 2ff57f2967 classref: Sync with current 3.5 branch (fc32e06)
2023-09-20 12:07:07 +00:00

357 lines
11 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorFunc.xml.
.. _class_VisualShaderNodeVectorFunc:
VisualShaderNodeVectorFunc
==========================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
A vector function to be used within the visual shader graph.
.. rst-class:: classref-introduction-group
Description
-----------
A visual shader node able to perform different functions using vectors.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-----------------------------------------------------------+---------------------------------------------------------------------+-------+
| :ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` | :ref:`function<class_VisualShaderNodeVectorFunc_property_function>` | ``0`` |
+-----------------------------------------------------------+---------------------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_VisualShaderNodeVectorFunc_Function:
.. rst-class:: classref-enumeration
enum **Function**:
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_NORMALIZE:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_NORMALIZE** = ``0``
Normalizes the vector so that it has a length of ``1`` but points in the same direction.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SATURATE:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_SATURATE** = ``1``
Clamps the value between ``0.0`` and ``1.0``.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_NEGATE:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_NEGATE** = ``2``
Returns the opposite value of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_RECIPROCAL:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_RECIPROCAL** = ``3``
Returns ``1/vector``.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_RGB2HSV:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_RGB2HSV** = ``4``
Converts RGB vector to HSV equivalent.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_HSV2RGB:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_HSV2RGB** = ``5``
Converts HSV vector to RGB equivalent.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ABS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ABS** = ``6``
Returns the absolute value of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ACOS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ACOS** = ``7``
Returns the arc-cosine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ACOSH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ACOSH** = ``8``
Returns the inverse hyperbolic cosine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ASIN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ASIN** = ``9``
Returns the arc-sine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ASINH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ASINH** = ``10``
Returns the inverse hyperbolic sine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ATAN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ATAN** = ``11``
Returns the arc-tangent of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ATANH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ATANH** = ``12``
Returns the inverse hyperbolic tangent of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_CEIL:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_CEIL** = ``13``
Finds the nearest integer that is greater than or equal to the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_COS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_COS** = ``14``
Returns the cosine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_COSH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_COSH** = ``15``
Returns the hyperbolic cosine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_DEGREES:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_DEGREES** = ``16``
Converts a quantity in radians to degrees.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_EXP:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_EXP** = ``17``
Base-e Exponential.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_EXP2:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_EXP2** = ``18``
Base-2 Exponential.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_FLOOR:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_FLOOR** = ``19``
Finds the nearest integer less than or equal to the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_FRAC:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_FRAC** = ``20``
Computes the fractional part of the argument.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_INVERSE_SQRT:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_INVERSE_SQRT** = ``21``
Returns the inverse of the square root of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_LOG:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_LOG** = ``22``
Natural logarithm.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_LOG2:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_LOG2** = ``23``
Base-2 logarithm.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_RADIANS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_RADIANS** = ``24``
Converts a quantity in degrees to radians.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ROUND:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ROUND** = ``25``
Finds the nearest integer to the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ROUNDEVEN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ROUNDEVEN** = ``26``
Finds the nearest even integer to the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SIGN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_SIGN** = ``27``
Extracts the sign of the parameter, i.e. returns ``-1`` if the parameter is negative, ``1`` if it's positive and ``0`` otherwise.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SIN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_SIN** = ``28``
Returns the sine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SINH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_SINH** = ``29``
Returns the hyperbolic sine of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SQRT:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_SQRT** = ``30``
Returns the square root of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_TAN:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_TAN** = ``31``
Returns the tangent of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_TANH:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_TANH** = ``32``
Returns the hyperbolic tangent of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_TRUNC:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_TRUNC** = ``33``
Returns a value equal to the nearest integer to the parameter whose absolute value is not larger than the absolute value of the parameter.
.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ONEMINUS:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **FUNC_ONEMINUS** = ``34``
Returns ``1.0 - vector``.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeVectorFunc_property_function:
.. rst-class:: classref-property
:ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **function** = ``0``
.. rst-class:: classref-property-setget
- void **set_function** **(** :ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` value **)**
- :ref:`Function<enum_VisualShaderNodeVectorFunc_Function>` **get_function** **(** **)**
The function to be performed. See :ref:`Function<enum_VisualShaderNodeVectorFunc_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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
Reference in New Issue View Git Blame Copy Permalink