class_visualshadernodeinput.rst 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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 VisualShaderNodeInput.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeInput:
  6. VisualShaderNodeInput
  7. =====================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Description
  10. -----------
  11. Gives access to input variables (built-ins) available for the shader. See the shading reference for the list of available built-ins for each shader type (check ``Tutorials`` section for link).
  12. Tutorials
  13. ---------
  14. - :doc:`../tutorials/shaders/shader_reference/index`
  15. Properties
  16. ----------
  17. +-----------------------------+--------------------------------------------------------------------+--------------+
  18. | :ref:`String<class_String>` | :ref:`input_name<class_VisualShaderNodeInput_property_input_name>` | ``"[None]"`` |
  19. +-----------------------------+--------------------------------------------------------------------+--------------+
  20. Methods
  21. -------
  22. +-----------------------------+--------------------------------------------------------------------------------------------------------+
  23. | :ref:`String<class_String>` | :ref:`get_input_real_name<class_VisualShaderNodeInput_method_get_input_real_name>` **(** **)** |const| |
  24. +-----------------------------+--------------------------------------------------------------------------------------------------------+
  25. Signals
  26. -------
  27. .. _class_VisualShaderNodeInput_signal_input_type_changed:
  28. - **input_type_changed** **(** **)**
  29. Property Descriptions
  30. ---------------------
  31. .. _class_VisualShaderNodeInput_property_input_name:
  32. - :ref:`String<class_String>` **input_name**
  33. +-----------+-----------------------+
  34. | *Default* | ``"[None]"`` |
  35. +-----------+-----------------------+
  36. | *Setter* | set_input_name(value) |
  37. +-----------+-----------------------+
  38. | *Getter* | get_input_name() |
  39. +-----------+-----------------------+
  40. One of the several input constants in lower-case style like: "vertex"(``VERTEX``) or "point_size"(``POINT_SIZE``).
  41. Method Descriptions
  42. -------------------
  43. .. _class_VisualShaderNodeInput_method_get_input_real_name:
  44. - :ref:`String<class_String>` **get_input_real_name** **(** **)** |const|
  45. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  46. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  47. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`