class_rdshaderfile.rst 3.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 RDShaderFile.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RDShaderFile:
  6. RDShaderFile
  7. ============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +-----------------------------+-----------------------------------------------------------+--------+
  12. | :ref:`String<class_String>` | :ref:`base_error<class_RDShaderFile_property_base_error>` | ``""`` |
  13. +-----------------------------+-----------------------------------------------------------+--------+
  14. Methods
  15. -------
  16. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` | :ref:`get_spirv<class_RDShaderFile_method_get_spirv>` **(** :ref:`StringName<class_StringName>` version=&"" **)** |const| |
  18. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_version_list<class_RDShaderFile_method_get_version_list>` **(** **)** |const| |
  20. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_bytecode<class_RDShaderFile_method_set_bytecode>` **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` bytecode, :ref:`StringName<class_StringName>` version=&"" **)** |
  22. +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_RDShaderFile_property_base_error:
  26. - :ref:`String<class_String>` **base_error**
  27. +-----------+-----------------------+
  28. | *Default* | ``""`` |
  29. +-----------+-----------------------+
  30. | *Setter* | set_base_error(value) |
  31. +-----------+-----------------------+
  32. | *Getter* | get_base_error() |
  33. +-----------+-----------------------+
  34. Method Descriptions
  35. -------------------
  36. .. _class_RDShaderFile_method_get_spirv:
  37. - :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` **get_spirv** **(** :ref:`StringName<class_StringName>` version=&"" **)** |const|
  38. ----
  39. .. _class_RDShaderFile_method_get_version_list:
  40. - :ref:`PackedStringArray<class_PackedStringArray>` **get_version_list** **(** **)** |const|
  41. ----
  42. .. _class_RDShaderFile_method_set_bytecode:
  43. - void **set_bytecode** **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` bytecode, :ref:`StringName<class_StringName>` version=&"" **)**
  44. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  45. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  46. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  47. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  48. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  49. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`