class_visualshadernodeinput.rst 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeInput.xml.
  6. .. _class_VisualShaderNodeInput:
  7. VisualShaderNodeInput
  8. =====================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. 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).
  14. .. rst-class:: classref-introduction-group
  15. Tutorials
  16. ---------
  17. - :doc:`../tutorials/shaders/shader_reference/index`
  18. .. rst-class:: classref-reftable-group
  19. Properties
  20. ----------
  21. .. table::
  22. :widths: auto
  23. +-----------------------------+--------------------------------------------------------------------+--------------+
  24. | :ref:`String<class_String>` | :ref:`input_name<class_VisualShaderNodeInput_property_input_name>` | ``"[None]"`` |
  25. +-----------------------------+--------------------------------------------------------------------+--------------+
  26. .. rst-class:: classref-reftable-group
  27. Methods
  28. -------
  29. .. table::
  30. :widths: auto
  31. +-----------------------------+--------------------------------------------------------------------------------------------------------+
  32. | :ref:`String<class_String>` | :ref:`get_input_real_name<class_VisualShaderNodeInput_method_get_input_real_name>` **(** **)** |const| |
  33. +-----------------------------+--------------------------------------------------------------------------------------------------------+
  34. .. rst-class:: classref-section-separator
  35. ----
  36. .. rst-class:: classref-descriptions-group
  37. Signals
  38. -------
  39. .. _class_VisualShaderNodeInput_signal_input_type_changed:
  40. .. rst-class:: classref-signal
  41. **input_type_changed** **(** **)**
  42. .. container:: contribute
  43. There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  44. .. rst-class:: classref-section-separator
  45. ----
  46. .. rst-class:: classref-descriptions-group
  47. Property Descriptions
  48. ---------------------
  49. .. _class_VisualShaderNodeInput_property_input_name:
  50. .. rst-class:: classref-property
  51. :ref:`String<class_String>` **input_name** = ``"[None]"``
  52. .. rst-class:: classref-property-setget
  53. - void **set_input_name** **(** :ref:`String<class_String>` value **)**
  54. - :ref:`String<class_String>` **get_input_name** **(** **)**
  55. One of the several input constants in lower-case style like: "vertex"(``VERTEX``) or "point_size"(``POINT_SIZE``).
  56. .. rst-class:: classref-section-separator
  57. ----
  58. .. rst-class:: classref-descriptions-group
  59. Method Descriptions
  60. -------------------
  61. .. _class_VisualShaderNodeInput_method_get_input_real_name:
  62. .. rst-class:: classref-method
  63. :ref:`String<class_String>` **get_input_real_name** **(** **)** |const|
  64. .. container:: contribute
  65. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  66. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  67. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  68. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  69. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`