Files
godot-docs/classes/class_visualshadernodevec4parameter.rst
2022-09-09 15:22:52 +02:00

70 lines
3.3 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/VisualShaderNodeVec4Parameter.xml.
.. _class_VisualShaderNodeVec4Parameter:
VisualShaderNodeVec4Parameter
=============================
**Inherits:** :ref:`VisualShaderNodeParameter<class_VisualShaderNodeParameter>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A 4D vector parameter to be used within the visual shader graph.
Description
-----------
Translated to ``uniform vec4`` in the shader language.
Properties
----------
+-------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`default_value<class_VisualShaderNodeVec4Parameter_property_default_value>` | ``Vector4(0, 0, 0, 0)`` |
+-------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`default_value_enabled<class_VisualShaderNodeVec4Parameter_property_default_value_enabled>` | ``false`` |
+-------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+
Property Descriptions
---------------------
.. _class_VisualShaderNodeVec4Parameter_property_default_value:
- :ref:`Vector4<class_Vector4>` **default_value**
+-----------+--------------------------+
| *Default* | ``Vector4(0, 0, 0, 0)`` |
+-----------+--------------------------+
| *Setter* | set_default_value(value) |
+-----------+--------------------------+
| *Getter* | get_default_value() |
+-----------+--------------------------+
A default value to be assigned within the shader.
----
.. _class_VisualShaderNodeVec4Parameter_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_VisualShaderNodeVec4Parameter_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.)`
.. |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.)`