class_rdshadersource.rst 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  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 RDShaderSource.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RDShaderSource:
  6. RDShaderSource
  7. ==============
  8. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +------------------------------------------------------------+---------------------------------------------------------------------------------------------------+--------+
  12. | :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` | :ref:`language<class_RDShaderSource_property_language>` | ``0`` |
  13. +------------------------------------------------------------+---------------------------------------------------------------------------------------------------+--------+
  14. | :ref:`String<class_String>` | :ref:`source_compute<class_RDShaderSource_property_source_compute>` | ``""`` |
  15. +------------------------------------------------------------+---------------------------------------------------------------------------------------------------+--------+
  16. | :ref:`String<class_String>` | :ref:`source_fragment<class_RDShaderSource_property_source_fragment>` | ``""`` |
  17. +------------------------------------------------------------+---------------------------------------------------------------------------------------------------+--------+
  18. | :ref:`String<class_String>` | :ref:`source_tesselation_control<class_RDShaderSource_property_source_tesselation_control>` | ``""`` |
  19. +------------------------------------------------------------+---------------------------------------------------------------------------------------------------+--------+
  20. | :ref:`String<class_String>` | :ref:`source_tesselation_evaluation<class_RDShaderSource_property_source_tesselation_evaluation>` | ``""`` |
  21. +------------------------------------------------------------+---------------------------------------------------------------------------------------------------+--------+
  22. | :ref:`String<class_String>` | :ref:`source_vertex<class_RDShaderSource_property_source_vertex>` | ``""`` |
  23. +------------------------------------------------------------+---------------------------------------------------------------------------------------------------+--------+
  24. Methods
  25. -------
  26. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_String>` | :ref:`get_stage_source<class_RDShaderSource_method_get_stage_source>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const| |
  28. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_stage_source<class_RDShaderSource_method_set_stage_source>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` source **)** |
  30. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. Property Descriptions
  32. ---------------------
  33. .. _class_RDShaderSource_property_language:
  34. - :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` **language**
  35. +-----------+---------------------+
  36. | *Default* | ``0`` |
  37. +-----------+---------------------+
  38. | *Setter* | set_language(value) |
  39. +-----------+---------------------+
  40. | *Getter* | get_language() |
  41. +-----------+---------------------+
  42. ----
  43. .. _class_RDShaderSource_property_source_compute:
  44. - :ref:`String<class_String>` **source_compute**
  45. +-----------+-------------------------+
  46. | *Default* | ``""`` |
  47. +-----------+-------------------------+
  48. | *Setter* | set_stage_source(value) |
  49. +-----------+-------------------------+
  50. | *Getter* | get_stage_source() |
  51. +-----------+-------------------------+
  52. ----
  53. .. _class_RDShaderSource_property_source_fragment:
  54. - :ref:`String<class_String>` **source_fragment**
  55. +-----------+-------------------------+
  56. | *Default* | ``""`` |
  57. +-----------+-------------------------+
  58. | *Setter* | set_stage_source(value) |
  59. +-----------+-------------------------+
  60. | *Getter* | get_stage_source() |
  61. +-----------+-------------------------+
  62. ----
  63. .. _class_RDShaderSource_property_source_tesselation_control:
  64. - :ref:`String<class_String>` **source_tesselation_control**
  65. +-----------+-------------------------+
  66. | *Default* | ``""`` |
  67. +-----------+-------------------------+
  68. | *Setter* | set_stage_source(value) |
  69. +-----------+-------------------------+
  70. | *Getter* | get_stage_source() |
  71. +-----------+-------------------------+
  72. ----
  73. .. _class_RDShaderSource_property_source_tesselation_evaluation:
  74. - :ref:`String<class_String>` **source_tesselation_evaluation**
  75. +-----------+-------------------------+
  76. | *Default* | ``""`` |
  77. +-----------+-------------------------+
  78. | *Setter* | set_stage_source(value) |
  79. +-----------+-------------------------+
  80. | *Getter* | get_stage_source() |
  81. +-----------+-------------------------+
  82. ----
  83. .. _class_RDShaderSource_property_source_vertex:
  84. - :ref:`String<class_String>` **source_vertex**
  85. +-----------+-------------------------+
  86. | *Default* | ``""`` |
  87. +-----------+-------------------------+
  88. | *Setter* | set_stage_source(value) |
  89. +-----------+-------------------------+
  90. | *Getter* | get_stage_source() |
  91. +-----------+-------------------------+
  92. Method Descriptions
  93. -------------------
  94. .. _class_RDShaderSource_method_get_stage_source:
  95. - :ref:`String<class_String>` **get_stage_source** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  96. ----
  97. .. _class_RDShaderSource_method_set_stage_source:
  98. - void **set_stage_source** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` source **)**
  99. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  100. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  101. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  102. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  103. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  104. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`