pandemonium_engine_docs/classes/class_visualshadernodescalarderivativefunc.rst

68 lines
2.6 KiB
ReStructuredText
Raw Normal View 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/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.
Description
-----------
This node is only available in ``Fragment`` and ``Light`` visual shaders.
Properties
----------
+---------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
| :ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` | :ref:`function<class_VisualShaderNodeScalarDerivativeFunc_property_function>` | ``0`` |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------+-------+
Enumerations
------------
.. _enum_VisualShaderNodeScalarDerivativeFunc_Function:
.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_SUM:
.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_X:
.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_Y:
enum **Function**:
- **FUNC_SUM** = **0** --- Sum of absolute derivative in ``x`` and ``y``.
- **FUNC_X** = **1** --- Derivative in ``x`` using local differencing.
- **FUNC_Y** = **2** --- Derivative in ``y`` using local differencing.
Property Descriptions
---------------------
.. _class_VisualShaderNodeScalarDerivativeFunc_property_function:
- :ref:`Function<enum_VisualShaderNodeScalarDerivativeFunc_Function>` **function**
+-----------+---------------------+
| *Default* | ``0`` |
+-----------+---------------------+
| *Setter* | set_function(value) |
+-----------+---------------------+
| *Getter* | 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.)`