Files
godot-docs/classes/class_visualshadernodetransformuniform.rst
2021-11-15 12:28:38 +01:00

69 lines
3.7 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 VisualShaderNodeTransformUniform.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeTransformUniform:
VisualShaderNodeTransformUniform
================================
**Inherits:** :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A :ref:`Transform3D<class_Transform3D>` uniform for use within the visual shader graph.
Description
-----------
Translated to ``uniform mat4`` in the shader language.
Properties
----------
+---------------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>` | :ref:`default_value<class_VisualShaderNodeTransformUniform_property_default_value>` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
+---------------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`default_value_enabled<class_VisualShaderNodeTransformUniform_property_default_value_enabled>` | ``false`` |
+---------------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------+
Property Descriptions
---------------------
.. _class_VisualShaderNodeTransformUniform_property_default_value:
- :ref:`Transform3D<class_Transform3D>` **default_value**
+-----------+-----------------------------------------------------+
| *Default* | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` |
+-----------+-----------------------------------------------------+
| *Setter* | set_default_value(value) |
+-----------+-----------------------------------------------------+
| *Getter* | get_default_value() |
+-----------+-----------------------------------------------------+
A default value to be assigned within the shader.
----
.. _class_VisualShaderNodeTransformUniform_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_VisualShaderNodeTransformUniform_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.)`