godot-docs/classes/class_visualshadernodeuvfunc.rst

:github_url: hide

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

.. _class_VisualShaderNodeUVFunc:

VisualShaderNodeUVFunc
======================

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

Contains functions to modify texture coordinates (``uv``) to be used within the visual shader graph.

Properties
----------

+-------------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`Function<enum_VisualShaderNodeUVFunc_Function>` | :ref:`function<class_VisualShaderNodeUVFunc_property_function>` | ``0`` |
+-------------------------------------------------------+-----------------------------------------------------------------+-------+

Enumerations
------------

.. _enum_VisualShaderNodeUVFunc_Function:

.. _class_VisualShaderNodeUVFunc_constant_FUNC_PANNING:

.. _class_VisualShaderNodeUVFunc_constant_FUNC_SCALING:

.. _class_VisualShaderNodeUVFunc_constant_FUNC_MAX:

enum **Function**:

- **FUNC_PANNING** = **0** --- Translates ``uv`` by using ``scale`` and ``offset`` values using the following formula: ``uv = uv + offset * scale``. ``uv`` port is connected to ``UV`` built-in by default.

- **FUNC_SCALING** = **1** --- Scales ``uv[/uv] by using [code]scale`` and ``pivot`` values using the following formula: ``uv = (uv - pivot) * scale + pivot``. ``uv`` port is connected to ``UV`` built-in by default.

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

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

.. _class_VisualShaderNodeUVFunc_property_function:

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

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

A function to be applied to the texture coordinates. See :ref:`Function<enum_VisualShaderNodeUVFunc_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.)`