mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
179 lines
6.0 KiB
ReStructuredText
179 lines
6.0 KiB
ReStructuredText
: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.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Accept a :ref:`Color<class_Color>` to the input port and transform it according to :ref:`function<class_VisualShaderNodeColorFunc_property_function>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+----------------------------------------------------------+--------------------------------------------------------------------+-------+
|
|
| :ref:`Function<enum_VisualShaderNodeColorFunc_Function>` | :ref:`function<class_VisualShaderNodeColorFunc_property_function>` | ``0`` |
|
|
+----------------------------------------------------------+--------------------------------------------------------------------+-------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeColorFunc_Function:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Function**: :ref:`🔗<enum_VisualShaderNodeColorFunc_Function>`
|
|
|
|
.. _class_VisualShaderNodeColorFunc_constant_FUNC_GRAYSCALE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_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);
|
|
|
|
.. _class_VisualShaderNodeColorFunc_constant_FUNC_HSV2RGB:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **FUNC_HSV2RGB** = ``1``
|
|
|
|
Converts HSV vector to RGB equivalent.
|
|
|
|
.. _class_VisualShaderNodeColorFunc_constant_FUNC_RGB2HSV:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **FUNC_RGB2HSV** = ``2``
|
|
|
|
Converts RGB vector to HSV equivalent.
|
|
|
|
.. _class_VisualShaderNodeColorFunc_constant_FUNC_SEPIA:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **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);
|
|
|
|
.. _class_VisualShaderNodeColorFunc_constant_FUNC_LINEAR_TO_SRGB:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **FUNC_LINEAR_TO_SRGB** = ``4``
|
|
|
|
Converts color from linear encoding to nonlinear sRGB encoding using the following formula:
|
|
|
|
::
|
|
|
|
vec3 c = clamp(c, vec3(0.0), vec3(1.0));
|
|
const vec3 a = vec3(0.055f);
|
|
return mix((vec3(1.0f) + a) * pow(c.rgb, vec3(1.0f / 2.4f)) - a, 12.92f * c.rgb, lessThan(c.rgb, vec3(0.0031308f)));
|
|
|
|
The Compatibility renderer uses a simpler formula:
|
|
|
|
::
|
|
|
|
vec3 c = input;
|
|
return max(vec3(1.055) * pow(c, vec3(0.416666667)) - vec3(0.055), vec3(0.0));
|
|
|
|
.. _class_VisualShaderNodeColorFunc_constant_FUNC_SRGB_TO_LINEAR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **FUNC_SRGB_TO_LINEAR** = ``5``
|
|
|
|
Converts color from nonlinear sRGB encoding to linear encoding using the following formula:
|
|
|
|
::
|
|
|
|
vec3 c = input;
|
|
return mix(pow((c.rgb + vec3(0.055)) * (1.0 / (1.0 + 0.055)), vec3(2.4)), c.rgb * (1.0 / 12.92), lessThan(c.rgb, vec3(0.04045)));
|
|
|
|
The Compatibility renderer uses a simpler formula:
|
|
|
|
::
|
|
|
|
vec3 c = input;
|
|
return c * (c * (c * 0.305306011 + 0.682171111) + 0.012522878);
|
|
|
|
.. _class_VisualShaderNodeColorFunc_constant_FUNC_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **FUNC_MAX** = ``6``
|
|
|
|
Represents the size of the :ref:`Function<enum_VisualShaderNodeColorFunc_Function>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeColorFunc_property_function:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **function** = ``0`` :ref:`🔗<class_VisualShaderNodeColorFunc_property_function>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_function**\ (\ value\: :ref:`Function<enum_VisualShaderNodeColorFunc_Function>`\ )
|
|
- :ref:`Function<enum_VisualShaderNodeColorFunc_Function>` **get_function**\ (\ )
|
|
|
|
A function to be applied to the input color.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |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.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|