class_visualshadernodeinput.rst 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.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. Represents the input shader parameter within the visual shader graph.
  10. Properties
  11. ----------
  12. +-----------------------------+--------------------------------------------------------------------+--------------+
  13. | :ref:`String<class_String>` | :ref:`input_name<class_VisualShaderNodeInput_property_input_name>` | ``"[None]"`` |
  14. +-----------------------------+--------------------------------------------------------------------+--------------+
  15. Methods
  16. -------
  17. +-----------------------------+------------------------------------------------------------------------------------------------------+
  18. | :ref:`String<class_String>` | :ref:`get_input_real_name<class_VisualShaderNodeInput_method_get_input_real_name>` **(** **)** const |
  19. +-----------------------------+------------------------------------------------------------------------------------------------------+
  20. Signals
  21. -------
  22. .. _class_VisualShaderNodeInput_signal_input_type_changed:
  23. - **input_type_changed** **(** **)**
  24. Emitted when input is changed via :ref:`input_name<class_VisualShaderNodeInput_property_input_name>`.
  25. Property Descriptions
  26. ---------------------
  27. .. _class_VisualShaderNodeInput_property_input_name:
  28. - :ref:`String<class_String>` **input_name**
  29. +-----------+-----------------------+
  30. | *Default* | ``"[None]"`` |
  31. +-----------+-----------------------+
  32. | *Setter* | set_input_name(value) |
  33. +-----------+-----------------------+
  34. | *Getter* | get_input_name() |
  35. +-----------+-----------------------+
  36. One of the several input constants in lower-case style like: "vertex"(``\ VERTEX``) or "point_size"([code]POINT_SIZE``).
  37. Method Descriptions
  38. -------------------
  39. .. _class_VisualShaderNodeInput_method_get_input_real_name:
  40. - :ref:`String<class_String>` **get_input_real_name** **(** **)** const
  41. Returns a translated name of the current constant in the Godot Shader Language. eg. ``"ALBEDO"`` if the :ref:`input_name<class_VisualShaderNodeInput_property_input_name>` equal to ``"albedo"``.