godot-docs/classes/class_visualshadernodecolorfunc.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeColorFunc.xml.

.. _class_VisualShaderNodeColorFunc:

VisualShaderNodeColorFunc
=========================

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

A :ref:`Color<class_Color>` function to be used within the visual shader graph.

Description
-----------

Accept a :ref:`Color<class_Color>` to the input port and transform it according to :ref:`function<class_VisualShaderNodeColorFunc_property_function>`.

Properties
----------

+----------------------------------------------------------+--------------------------------------------------------------------+-------+
| :ref:`Function<enum_VisualShaderNodeColorFunc_Function>` | :ref:`function<class_VisualShaderNodeColorFunc_property_function>` | ``0`` |
+----------------------------------------------------------+--------------------------------------------------------------------+-------+

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

.. _enum_VisualShaderNodeColorFunc_Function:

.. _class_VisualShaderNodeColorFunc_constant_FUNC_GRAYSCALE:

.. _class_VisualShaderNodeColorFunc_constant_FUNC_HSV2RGB:

.. _class_VisualShaderNodeColorFunc_constant_FUNC_RGB2HSV:

.. _class_VisualShaderNodeColorFunc_constant_FUNC_SEPIA:

.. _class_VisualShaderNodeColorFunc_constant_FUNC_MAX:

enum **Function**:

- **FUNC_GRAYSCALE** = **0** --- Converts the color to grayscale using the following formula:

::

    vec3 c = input;
    float max1 = max(c.r, c.g);
    float max2 = max(max1, c.b);
    float max3 = max(max1, max2);
    return vec3(max3, max3, max3);

- **FUNC_HSV2RGB** = **1** --- Converts HSV vector to RGB equivalent.

- **FUNC_RGB2HSV** = **2** --- Converts RGB vector to HSV equivalent.

- **FUNC_SEPIA** = **3** --- Applies sepia tone effect using the following formula:

::

    vec3 c = input;
    float r = (c.r * 0.393) + (c.g * 0.769) + (c.b * 0.189);
    float g = (c.r * 0.349) + (c.g * 0.686) + (c.b * 0.168);
    float b = (c.r * 0.272) + (c.g * 0.534) + (c.b * 0.131);
    return vec3(r, g, b);

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

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

.. _class_VisualShaderNodeColorFunc_property_function:

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

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

A function to be applied to the input color. See :ref:`Function<enum_VisualShaderNodeColorFunc_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.)`