mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
78 lines
3.3 KiB
ReStructuredText
78 lines
3.3 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 VisualShaderNodeIntFunc.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_VisualShaderNodeIntFunc:
|
|
|
|
VisualShaderNodeIntFunc
|
|
=======================
|
|
|
|
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
A scalar integer function to be used within the visual shader graph.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Accept an integer scalar (``x``) to the input port and transform it according to :ref:`function<class_VisualShaderNodeIntFunc_property_function>`.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+--------------------------------------------------------+------------------------------------------------------------------+-------+
|
|
| :ref:`Function<enum_VisualShaderNodeIntFunc_Function>` | :ref:`function<class_VisualShaderNodeIntFunc_property_function>` | ``2`` |
|
|
+--------------------------------------------------------+------------------------------------------------------------------+-------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeIntFunc_Function:
|
|
|
|
.. _class_VisualShaderNodeIntFunc_constant_FUNC_ABS:
|
|
|
|
.. _class_VisualShaderNodeIntFunc_constant_FUNC_NEGATE:
|
|
|
|
.. _class_VisualShaderNodeIntFunc_constant_FUNC_SIGN:
|
|
|
|
.. _class_VisualShaderNodeIntFunc_constant_FUNC_BITWISE_NOT:
|
|
|
|
.. _class_VisualShaderNodeIntFunc_constant_FUNC_MAX:
|
|
|
|
enum **Function**:
|
|
|
|
- **FUNC_ABS** = **0** --- Returns the absolute value of the parameter. Translates to ``abs(x)`` in the Godot Shader Language.
|
|
|
|
- **FUNC_NEGATE** = **1** --- Negates the ``x`` using ``-(x)``.
|
|
|
|
- **FUNC_SIGN** = **2** --- Extracts the sign of the parameter. Translates to ``sign(x)`` in the Godot Shader Language.
|
|
|
|
- **FUNC_BITWISE_NOT** = **3** --- Returns the result of bitwise ``NOT`` operation on the integer. Translates to ``~a`` in the Godot Shader Language.
|
|
|
|
- **FUNC_MAX** = **4** --- Represents the size of the :ref:`Function<enum_VisualShaderNodeIntFunc_Function>` enum.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeIntFunc_property_function:
|
|
|
|
- :ref:`Function<enum_VisualShaderNodeIntFunc_Function>` **function**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``2`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_function(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_function() |
|
|
+-----------+---------------------+
|
|
|
|
A function to be applied to the scalar. See :ref:`Function<enum_VisualShaderNodeIntFunc_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.)`
|