class_visualshadernodevarying.rst 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVarying.xml.
  6. .. _class_VisualShaderNodeVarying:
  7. VisualShaderNodeVarying
  8. =======================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`VisualShaderNodeVaryingGetter<class_VisualShaderNodeVaryingGetter>`, :ref:`VisualShaderNodeVaryingSetter<class_VisualShaderNodeVaryingSetter>`
  11. A visual shader node that represents a "varying" shader value.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Varying values are shader variables that can be passed between shader functions, e.g. from Vertex shader to Fragment shader.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +---------------------------------------------------+--------------------------------------------------------------------------+--------------+
  22. | :ref:`String<class_String>` | :ref:`varying_name<class_VisualShaderNodeVarying_property_varying_name>` | ``"[None]"`` |
  23. +---------------------------------------------------+--------------------------------------------------------------------------+--------------+
  24. | :ref:`VaryingType<enum_VisualShader_VaryingType>` | :ref:`varying_type<class_VisualShaderNodeVarying_property_varying_type>` | ``0`` |
  25. +---------------------------------------------------+--------------------------------------------------------------------------+--------------+
  26. .. rst-class:: classref-section-separator
  27. ----
  28. .. rst-class:: classref-descriptions-group
  29. Property Descriptions
  30. ---------------------
  31. .. _class_VisualShaderNodeVarying_property_varying_name:
  32. .. rst-class:: classref-property
  33. :ref:`String<class_String>` **varying_name** = ``"[None]"`` :ref:`🔗<class_VisualShaderNodeVarying_property_varying_name>`
  34. .. rst-class:: classref-property-setget
  35. - |void| **set_varying_name**\ (\ value\: :ref:`String<class_String>`\ )
  36. - :ref:`String<class_String>` **get_varying_name**\ (\ )
  37. Name of the variable. Must be unique.
  38. .. rst-class:: classref-item-separator
  39. ----
  40. .. _class_VisualShaderNodeVarying_property_varying_type:
  41. .. rst-class:: classref-property
  42. :ref:`VaryingType<enum_VisualShader_VaryingType>` **varying_type** = ``0`` :ref:`🔗<class_VisualShaderNodeVarying_property_varying_type>`
  43. .. rst-class:: classref-property-setget
  44. - |void| **set_varying_type**\ (\ value\: :ref:`VaryingType<enum_VisualShader_VaryingType>`\ )
  45. - :ref:`VaryingType<enum_VisualShader_VaryingType>` **get_varying_type**\ (\ )
  46. Type of the variable. Determines where the variable can be accessed.
  47. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  48. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  49. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  50. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  51. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  52. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  53. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  54. .. |void| replace:: :abbr:`void (No return value.)`