class_visualshadernodeexpression.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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/VisualShaderNodeExpression.xml.
  6. .. _class_VisualShaderNodeExpression:
  7. VisualShaderNodeExpression
  8. ==========================
  9. **Inherits:** :ref:`VisualShaderNodeGroupBase<class_VisualShaderNodeGroupBase>` **<** :ref:`VisualShaderNodeResizableBase<class_VisualShaderNodeResizableBase>` **<** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`VisualShaderNodeGlobalExpression<class_VisualShaderNodeGlobalExpression>`
  11. A custom visual shader graph expression written in Godot Shading Language.
  12. Description
  13. -----------
  14. Custom Godot Shading Language expression, with a custom amount of input and output ports.
  15. The provided code is directly injected into the graph's matching shader function (``vertex``, ``fragment``, or ``light``), so it cannot be used to declare functions, varyings, uniforms, or global constants. See :ref:`VisualShaderNodeGlobalExpression<class_VisualShaderNodeGlobalExpression>` for such global definitions.
  16. Properties
  17. ----------
  18. +-----------------------------+-------------------------------------------------------------------------+--------+
  19. | :ref:`String<class_String>` | :ref:`expression<class_VisualShaderNodeExpression_property_expression>` | ``""`` |
  20. +-----------------------------+-------------------------------------------------------------------------+--------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_VisualShaderNodeExpression_property_expression:
  24. - :ref:`String<class_String>` **expression**
  25. +-----------+-----------------------+
  26. | *Default* | ``""`` |
  27. +-----------+-----------------------+
  28. | *Setter* | set_expression(value) |
  29. +-----------+-----------------------+
  30. | *Getter* | get_expression() |
  31. +-----------+-----------------------+
  32. An expression in Godot Shading Language, which will be injected at the start of the graph's matching shader function (``vertex``, ``fragment``, or ``light``), and thus cannot be used to declare functions, varyings, uniforms, or global constants.
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  36. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  37. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  38. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`