class_visualshadernodecoloruniform.rst 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorUniform.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeColorUniform:
  6. VisualShaderNodeColorUniform
  7. ============================
  8. **Inherits:** :ref:`VisualShaderNodeUniform<class_VisualShaderNodeUniform>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. A :ref:`Color<class_Color>` uniform to be used within the visual shader graph.
  10. Description
  11. -----------
  12. Translated to ``uniform vec4`` in the shader language.
  13. Properties
  14. ----------
  15. +---------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  16. | :ref:`Color<class_Color>` | :ref:`default_value<class_VisualShaderNodeColorUniform_property_default_value>` | ``Color(1, 1, 1, 1)`` |
  17. +---------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  18. | :ref:`bool<class_bool>` | :ref:`default_value_enabled<class_VisualShaderNodeColorUniform_property_default_value_enabled>` | ``false`` |
  19. +---------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_VisualShaderNodeColorUniform_property_default_value:
  23. - :ref:`Color<class_Color>` **default_value**
  24. +-----------+--------------------------+
  25. | *Default* | ``Color(1, 1, 1, 1)`` |
  26. +-----------+--------------------------+
  27. | *Setter* | set_default_value(value) |
  28. +-----------+--------------------------+
  29. | *Getter* | get_default_value() |
  30. +-----------+--------------------------+
  31. A default value to be assigned within the shader.
  32. ----
  33. .. _class_VisualShaderNodeColorUniform_property_default_value_enabled:
  34. - :ref:`bool<class_bool>` **default_value_enabled**
  35. +-----------+----------------------------------+
  36. | *Default* | ``false`` |
  37. +-----------+----------------------------------+
  38. | *Setter* | set_default_value_enabled(value) |
  39. +-----------+----------------------------------+
  40. | *Getter* | is_default_value_enabled() |
  41. +-----------+----------------------------------+
  42. Enables usage of the :ref:`default_value<class_VisualShaderNodeColorUniform_property_default_value>`.
  43. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  44. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  45. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  46. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  47. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  48. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`