class_visualshadernodecolorconstant.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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 VisualShaderNodeColorConstant.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeColorConstant:
  6. VisualShaderNodeColorConstant
  7. =============================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. A :ref:`Color<class_Color>` constant to be used within the visual shader graph.
  10. Description
  11. -----------
  12. Has two output ports representing RGB and alpha channels of :ref:`Color<class_Color>`.
  13. Translated to ``vec3 rgb`` and ``float alpha`` in the shader language.
  14. Properties
  15. ----------
  16. +---------------------------+------------------------------------------------------------------------+-------------------------+
  17. | :ref:`Color<class_Color>` | :ref:`constant<class_VisualShaderNodeColorConstant_property_constant>` | ``Color( 1, 1, 1, 1 )`` |
  18. +---------------------------+------------------------------------------------------------------------+-------------------------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_VisualShaderNodeColorConstant_property_constant:
  22. - :ref:`Color<class_Color>` **constant**
  23. +-----------+-------------------------+
  24. | *Default* | ``Color( 1, 1, 1, 1 )`` |
  25. +-----------+-------------------------+
  26. | *Setter* | set_constant(value) |
  27. +-----------+-------------------------+
  28. | *Getter* | get_constant() |
  29. +-----------+-------------------------+
  30. A :ref:`Color<class_Color>` constant which represents a state of this node.
  31. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  32. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  33. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`