Files
godot-docs/classes/class_visualshadernodecoloruniform.rst
2022-04-29 14:16:57 +02:00

66 lines
2.9 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorUniform.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeColorUniform:
VisualShaderNodeColorUniform
============================
**Inherits:** :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
A :ref:`Color<class_Color>` uniform to be used within the visual shader graph.
Description
-----------
Translated to ``uniform vec4`` in the shader language.
Properties
----------
+---------------------------+-------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>` | :ref:`default_value<class_VisualShaderNodeColorUniform_property_default_value>` | ``Color( 1, 1, 1, 1 )`` |
+---------------------------+-------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`default_value_enabled<class_VisualShaderNodeColorUniform_property_default_value_enabled>` | ``false`` |
+---------------------------+-------------------------------------------------------------------------------------------------+-------------------------+
Property Descriptions
---------------------
.. _class_VisualShaderNodeColorUniform_property_default_value:
- :ref:`Color<class_Color>` **default_value**
+-----------+--------------------------+
| *Default* | ``Color( 1, 1, 1, 1 )`` |
+-----------+--------------------------+
| *Setter* | set_default_value(value) |
+-----------+--------------------------+
| *Getter* | get_default_value() |
+-----------+--------------------------+
A default value to be assigned within the shader.
----
.. _class_VisualShaderNodeColorUniform_property_default_value_enabled:
- :ref:`bool<class_bool>` **default_value_enabled**
+-----------+----------------------------------+
| *Default* | ``false`` |
+-----------+----------------------------------+
| *Setter* | set_default_value_enabled(value) |
+-----------+----------------------------------+
| *Getter* | is_default_value_enabled() |
+-----------+----------------------------------+
Enables usage of the :ref:`default_value<class_VisualShaderNodeColorUniform_property_default_value>`.
.. |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.)`