class_rdshaderspirv.rst 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RDShaderSPIRV.xml.
  6. .. _class_RDShaderSPIRV:
  7. RDShaderSPIRV
  8. =============
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. .. rst-class:: classref-reftable-group
  13. Properties
  14. ----------
  15. .. table::
  16. :widths: auto
  17. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  18. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_compute<class_RDShaderSPIRV_property_bytecode_compute>` | ``PackedByteArray()`` |
  19. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  20. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_fragment<class_RDShaderSPIRV_property_bytecode_fragment>` | ``PackedByteArray()`` |
  21. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  22. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_tesselation_control<class_RDShaderSPIRV_property_bytecode_tesselation_control>` | ``PackedByteArray()`` |
  23. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  24. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_tesselation_evaluation<class_RDShaderSPIRV_property_bytecode_tesselation_evaluation>` | ``PackedByteArray()`` |
  25. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  26. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_vertex<class_RDShaderSPIRV_property_bytecode_vertex>` | ``PackedByteArray()`` |
  27. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  28. | :ref:`String<class_String>` | :ref:`compile_error_compute<class_RDShaderSPIRV_property_compile_error_compute>` | ``""`` |
  29. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  30. | :ref:`String<class_String>` | :ref:`compile_error_fragment<class_RDShaderSPIRV_property_compile_error_fragment>` | ``""`` |
  31. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  32. | :ref:`String<class_String>` | :ref:`compile_error_tesselation_control<class_RDShaderSPIRV_property_compile_error_tesselation_control>` | ``""`` |
  33. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  34. | :ref:`String<class_String>` | :ref:`compile_error_tesselation_evaluation<class_RDShaderSPIRV_property_compile_error_tesselation_evaluation>` | ``""`` |
  35. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  36. | :ref:`String<class_String>` | :ref:`compile_error_vertex<class_RDShaderSPIRV_property_compile_error_vertex>` | ``""`` |
  37. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
  38. .. rst-class:: classref-reftable-group
  39. Methods
  40. -------
  41. .. table::
  42. :widths: auto
  43. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_stage_bytecode<class_RDShaderSPIRV_method_get_stage_bytecode>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const| |
  45. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`String<class_String>` | :ref:`get_stage_compile_error<class_RDShaderSPIRV_method_get_stage_compile_error>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const| |
  47. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`set_stage_bytecode<class_RDShaderSPIRV_method_set_stage_bytecode>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)** |
  49. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | void | :ref:`set_stage_compile_error<class_RDShaderSPIRV_method_set_stage_compile_error>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)** |
  51. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. .. rst-class:: classref-section-separator
  53. ----
  54. .. rst-class:: classref-descriptions-group
  55. Property Descriptions
  56. ---------------------
  57. .. _class_RDShaderSPIRV_property_bytecode_compute:
  58. .. rst-class:: classref-property
  59. :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_compute** = ``PackedByteArray()``
  60. .. rst-class:: classref-property-setget
  61. - void **set_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)**
  62. - :ref:`PackedByteArray<class_PackedByteArray>` **get_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  63. .. container:: contribute
  64. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  65. .. rst-class:: classref-item-separator
  66. ----
  67. .. _class_RDShaderSPIRV_property_bytecode_fragment:
  68. .. rst-class:: classref-property
  69. :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_fragment** = ``PackedByteArray()``
  70. .. rst-class:: classref-property-setget
  71. - void **set_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)**
  72. - :ref:`PackedByteArray<class_PackedByteArray>` **get_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  73. .. container:: contribute
  74. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  75. .. rst-class:: classref-item-separator
  76. ----
  77. .. _class_RDShaderSPIRV_property_bytecode_tesselation_control:
  78. .. rst-class:: classref-property
  79. :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_tesselation_control** = ``PackedByteArray()``
  80. .. rst-class:: classref-property-setget
  81. - void **set_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)**
  82. - :ref:`PackedByteArray<class_PackedByteArray>` **get_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  83. .. container:: contribute
  84. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  85. .. rst-class:: classref-item-separator
  86. ----
  87. .. _class_RDShaderSPIRV_property_bytecode_tesselation_evaluation:
  88. .. rst-class:: classref-property
  89. :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_tesselation_evaluation** = ``PackedByteArray()``
  90. .. rst-class:: classref-property-setget
  91. - void **set_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)**
  92. - :ref:`PackedByteArray<class_PackedByteArray>` **get_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  93. .. container:: contribute
  94. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  95. .. rst-class:: classref-item-separator
  96. ----
  97. .. _class_RDShaderSPIRV_property_bytecode_vertex:
  98. .. rst-class:: classref-property
  99. :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_vertex** = ``PackedByteArray()``
  100. .. rst-class:: classref-property-setget
  101. - void **set_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)**
  102. - :ref:`PackedByteArray<class_PackedByteArray>` **get_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  103. .. container:: contribute
  104. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  105. .. rst-class:: classref-item-separator
  106. ----
  107. .. _class_RDShaderSPIRV_property_compile_error_compute:
  108. .. rst-class:: classref-property
  109. :ref:`String<class_String>` **compile_error_compute** = ``""``
  110. .. rst-class:: classref-property-setget
  111. - void **set_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)**
  112. - :ref:`String<class_String>` **get_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  113. .. container:: contribute
  114. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  115. .. rst-class:: classref-item-separator
  116. ----
  117. .. _class_RDShaderSPIRV_property_compile_error_fragment:
  118. .. rst-class:: classref-property
  119. :ref:`String<class_String>` **compile_error_fragment** = ``""``
  120. .. rst-class:: classref-property-setget
  121. - void **set_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)**
  122. - :ref:`String<class_String>` **get_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  123. .. container:: contribute
  124. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  125. .. rst-class:: classref-item-separator
  126. ----
  127. .. _class_RDShaderSPIRV_property_compile_error_tesselation_control:
  128. .. rst-class:: classref-property
  129. :ref:`String<class_String>` **compile_error_tesselation_control** = ``""``
  130. .. rst-class:: classref-property-setget
  131. - void **set_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)**
  132. - :ref:`String<class_String>` **get_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  133. .. container:: contribute
  134. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  135. .. rst-class:: classref-item-separator
  136. ----
  137. .. _class_RDShaderSPIRV_property_compile_error_tesselation_evaluation:
  138. .. rst-class:: classref-property
  139. :ref:`String<class_String>` **compile_error_tesselation_evaluation** = ``""``
  140. .. rst-class:: classref-property-setget
  141. - void **set_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)**
  142. - :ref:`String<class_String>` **get_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  143. .. container:: contribute
  144. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  145. .. rst-class:: classref-item-separator
  146. ----
  147. .. _class_RDShaderSPIRV_property_compile_error_vertex:
  148. .. rst-class:: classref-property
  149. :ref:`String<class_String>` **compile_error_vertex** = ``""``
  150. .. rst-class:: classref-property-setget
  151. - void **set_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)**
  152. - :ref:`String<class_String>` **get_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  153. .. container:: contribute
  154. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  155. .. rst-class:: classref-section-separator
  156. ----
  157. .. rst-class:: classref-descriptions-group
  158. Method Descriptions
  159. -------------------
  160. .. _class_RDShaderSPIRV_method_get_stage_bytecode:
  161. .. rst-class:: classref-method
  162. :ref:`PackedByteArray<class_PackedByteArray>` **get_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  163. .. container:: contribute
  164. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  165. .. rst-class:: classref-item-separator
  166. ----
  167. .. _class_RDShaderSPIRV_method_get_stage_compile_error:
  168. .. rst-class:: classref-method
  169. :ref:`String<class_String>` **get_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|
  170. .. container:: contribute
  171. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  172. .. rst-class:: classref-item-separator
  173. ----
  174. .. _class_RDShaderSPIRV_method_set_stage_bytecode:
  175. .. rst-class:: classref-method
  176. void **set_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)**
  177. .. container:: contribute
  178. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  179. .. rst-class:: classref-item-separator
  180. ----
  181. .. _class_RDShaderSPIRV_method_set_stage_compile_error:
  182. .. rst-class:: classref-method
  183. void **set_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)**
  184. .. container:: contribute
  185. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  186. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  187. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  188. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  189. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  190. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  191. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`