virtualx-engine-docs/_sources/classes/class_visualshadernodescalarderivativefunc.rst.txt
2024-10-23 09:41:33 -07:00

100 lines
3.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/VisualShaderNodeScalarDerivativeFunc.xml.
.. _class_VisualShaderNodeScalarDerivativeFunc:
VisualShaderNodeScalarDerivativeFunc
====================================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Calculates a scalar derivative within the visual shader graph.
.. rst-class:: classref-introduction-group
Description
-----------
This node is only available in ``Fragment`` and ``Light`` visual shaders.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
| :ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` | :ref:`function<class_VisualShaderNodeScalarDerivativeFunc_property_function>` | ``0`` |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_VisualShaderNodeScalarDerivativeFunc_Function:
.. rst-class:: classref-enumeration
enum **Function**:
.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_SUM:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` **FUNC_SUM** = ``0``
Sum of absolute derivative in ``x`` and ``y``.
.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_X:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` **FUNC_X** = ``1``
Derivative in ``x`` using local differencing.
.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_Y:
.. rst-class:: classref-enumeration-constant
:ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` **FUNC_Y** = ``2``
Derivative in ``y`` using local differencing.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeScalarDerivativeFunc_property_function:
.. rst-class:: classref-property
:ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` **function** = ``0``
.. rst-class:: classref-property-setget
- void **set_function** **(** :ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` value **)**
- :ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` **get_function** **(** **)**
The derivative type. See :ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_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.)`