godot-docs/classes/class_rdshaderspirv.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RDShaderSPIRV.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_RDShaderSPIRV:

RDShaderSPIRV
=============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`



Properties
----------

+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_compute<class_RDShaderSPIRV_property_bytecode_compute>`                                         | ``PackedByteArray()`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_fragment<class_RDShaderSPIRV_property_bytecode_fragment>`                                       | ``PackedByteArray()`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_tesselation_control<class_RDShaderSPIRV_property_bytecode_tesselation_control>`                 | ``PackedByteArray()`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_tesselation_evaluation<class_RDShaderSPIRV_property_bytecode_tesselation_evaluation>`           | ``PackedByteArray()`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`bytecode_vertex<class_RDShaderSPIRV_property_bytecode_vertex>`                                           | ``PackedByteArray()`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`String<class_String>`                   | :ref:`compile_error_compute<class_RDShaderSPIRV_property_compile_error_compute>`                               | ``""``                |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`String<class_String>`                   | :ref:`compile_error_fragment<class_RDShaderSPIRV_property_compile_error_fragment>`                             | ``""``                |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`String<class_String>`                   | :ref:`compile_error_tesselation_control<class_RDShaderSPIRV_property_compile_error_tesselation_control>`       | ``""``                |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`String<class_String>`                   | :ref:`compile_error_tesselation_evaluation<class_RDShaderSPIRV_property_compile_error_tesselation_evaluation>` | ``""``                |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+
| :ref:`String<class_String>`                   | :ref:`compile_error_vertex<class_RDShaderSPIRV_property_compile_error_vertex>`                                 | ``""``                |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------+-----------------------+

Methods
-------

+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_stage_bytecode<class_RDShaderSPIRV_method_get_stage_bytecode>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|                                                 |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`get_stage_compile_error<class_RDShaderSPIRV_method_get_stage_compile_error>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|                                       |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_stage_bytecode<class_RDShaderSPIRV_method_set_stage_bytecode>` **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)**    |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_RDShaderSPIRV_property_bytecode_compute:

- :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_compute**

+-----------+---------------------------+
| *Default* | ``PackedByteArray()``     |
+-----------+---------------------------+
| *Setter*  | set_stage_bytecode(value) |
+-----------+---------------------------+
| *Getter*  | get_stage_bytecode()      |
+-----------+---------------------------+

----

.. _class_RDShaderSPIRV_property_bytecode_fragment:

- :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_fragment**

+-----------+---------------------------+
| *Default* | ``PackedByteArray()``     |
+-----------+---------------------------+
| *Setter*  | set_stage_bytecode(value) |
+-----------+---------------------------+
| *Getter*  | get_stage_bytecode()      |
+-----------+---------------------------+

----

.. _class_RDShaderSPIRV_property_bytecode_tesselation_control:

- :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_tesselation_control**

+-----------+---------------------------+
| *Default* | ``PackedByteArray()``     |
+-----------+---------------------------+
| *Setter*  | set_stage_bytecode(value) |
+-----------+---------------------------+
| *Getter*  | get_stage_bytecode()      |
+-----------+---------------------------+

----

.. _class_RDShaderSPIRV_property_bytecode_tesselation_evaluation:

- :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_tesselation_evaluation**

+-----------+---------------------------+
| *Default* | ``PackedByteArray()``     |
+-----------+---------------------------+
| *Setter*  | set_stage_bytecode(value) |
+-----------+---------------------------+
| *Getter*  | get_stage_bytecode()      |
+-----------+---------------------------+

----

.. _class_RDShaderSPIRV_property_bytecode_vertex:

- :ref:`PackedByteArray<class_PackedByteArray>` **bytecode_vertex**

+-----------+---------------------------+
| *Default* | ``PackedByteArray()``     |
+-----------+---------------------------+
| *Setter*  | set_stage_bytecode(value) |
+-----------+---------------------------+
| *Getter*  | get_stage_bytecode()      |
+-----------+---------------------------+

----

.. _class_RDShaderSPIRV_property_compile_error_compute:

- :ref:`String<class_String>` **compile_error_compute**

+-----------+--------------------------------+
| *Default* | ``""``                         |
+-----------+--------------------------------+
| *Setter*  | set_stage_compile_error(value) |
+-----------+--------------------------------+
| *Getter*  | get_stage_compile_error()      |
+-----------+--------------------------------+

----

.. _class_RDShaderSPIRV_property_compile_error_fragment:

- :ref:`String<class_String>` **compile_error_fragment**

+-----------+--------------------------------+
| *Default* | ``""``                         |
+-----------+--------------------------------+
| *Setter*  | set_stage_compile_error(value) |
+-----------+--------------------------------+
| *Getter*  | get_stage_compile_error()      |
+-----------+--------------------------------+

----

.. _class_RDShaderSPIRV_property_compile_error_tesselation_control:

- :ref:`String<class_String>` **compile_error_tesselation_control**

+-----------+--------------------------------+
| *Default* | ``""``                         |
+-----------+--------------------------------+
| *Setter*  | set_stage_compile_error(value) |
+-----------+--------------------------------+
| *Getter*  | get_stage_compile_error()      |
+-----------+--------------------------------+

----

.. _class_RDShaderSPIRV_property_compile_error_tesselation_evaluation:

- :ref:`String<class_String>` **compile_error_tesselation_evaluation**

+-----------+--------------------------------+
| *Default* | ``""``                         |
+-----------+--------------------------------+
| *Setter*  | set_stage_compile_error(value) |
+-----------+--------------------------------+
| *Getter*  | get_stage_compile_error()      |
+-----------+--------------------------------+

----

.. _class_RDShaderSPIRV_property_compile_error_vertex:

- :ref:`String<class_String>` **compile_error_vertex**

+-----------+--------------------------------+
| *Default* | ``""``                         |
+-----------+--------------------------------+
| *Setter*  | set_stage_compile_error(value) |
+-----------+--------------------------------+
| *Getter*  | get_stage_compile_error()      |
+-----------+--------------------------------+

Method Descriptions
-------------------

.. _class_RDShaderSPIRV_method_get_stage_bytecode:

- :ref:`PackedByteArray<class_PackedByteArray>` **get_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|

----

.. _class_RDShaderSPIRV_method_get_stage_compile_error:

- :ref:`String<class_String>` **get_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage **)** |const|

----

.. _class_RDShaderSPIRV_method_set_stage_bytecode:

- void **set_stage_bytecode** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`PackedByteArray<class_PackedByteArray>` bytecode **)**

----

.. _class_RDShaderSPIRV_method_set_stage_compile_error:

- void **set_stage_compile_error** **(** :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` stage, :ref:`String<class_String>` compile_error **)**

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`