Class reference
RDShaderSPIRV
Inherits Resource
SPIR-V intermediate representation as part of an RDShaderFile (used by RenderingDevice).
Description
RDShaderSPIRV represents an RDShaderFile's SPIR-V code for various shader stages, as well as possible compilation error messages. SPIR-V is a low-level intermediate shader representation. This intermediate representation is not used directly by GPUs for rendering, but it can be compiled into binary shaders that GPUs can understand. Unlike compiled shaders, SPIR-V is portable across GPU models and driver versions. This object is used by RenderingDevice.
Properties
PackedByteArray bytecode_compute = PackedByteArray()
PackedByteArray bytecode_compute = PackedByteArray()The SPIR-V bytecode for the compute shader stage.
PackedByteArray bytecode_fragment = PackedByteArray()
PackedByteArray bytecode_fragment = PackedByteArray()The SPIR-V bytecode for the fragment shader stage.
PackedByteArray bytecode_tesselation_control = PackedByteArray()
PackedByteArray bytecode_tesselation_control = PackedByteArray()The SPIR-V bytecode for the tessellation control shader stage.
PackedByteArray bytecode_tesselation_evaluation = PackedByteArray()
PackedByteArray bytecode_tesselation_evaluation = PackedByteArray()The SPIR-V bytecode for the tessellation evaluation shader stage.
PackedByteArray bytecode_vertex = PackedByteArray()
PackedByteArray bytecode_vertex = PackedByteArray()The SPIR-V bytecode for the vertex shader stage.
String compile_error_compute = ""
String compile_error_compute = ""The compilation error message for the compute shader stage (set by the SPIR-V compiler and Redot). If empty, shader compilation was successful.
String compile_error_fragment = ""
String compile_error_fragment = ""The compilation error message for the fragment shader stage (set by the SPIR-V compiler and Redot). If empty, shader compilation was successful.
String compile_error_tesselation_control = ""
String compile_error_tesselation_control = ""The compilation error message for the tessellation control shader stage (set by the SPIR-V compiler and Redot). If empty, shader compilation was successful.
String compile_error_tesselation_evaluation = ""
String compile_error_tesselation_evaluation = ""The compilation error message for the tessellation evaluation shader stage (set by the SPIR-V compiler and Redot). If empty, shader compilation was successful.
String compile_error_vertex = ""
String compile_error_vertex = ""The compilation error message for the vertex shader stage (set by the SPIR-V compiler and Redot). If empty, shader compilation was successful.
Methods
PackedByteArray get_stage_bytecode(int stage) const
PackedByteArray get_stage_bytecode(int stage) constEquivalent to getting one of bytecode_compute, bytecode_fragment, bytecode_tesselation_control, bytecode_tesselation_evaluation, bytecode_vertex.
String get_stage_compile_error(int stage) const
String get_stage_compile_error(int stage) constReturns the compilation error message for the given shader stage. Equivalent to getting one of compile_error_compute, compile_error_fragment, compile_error_tesselation_control, compile_error_tesselation_evaluation, compile_error_vertex.
void set_stage_bytecode(int stage, PackedByteArray bytecode)
int stage, PackedByteArray bytecode)Sets the SPIR-V bytecode for the given shader stage. Equivalent to setting one of bytecode_compute, bytecode_fragment, bytecode_tesselation_control, bytecode_tesselation_evaluation, bytecode_vertex.
void set_stage_compile_error(int stage, String compile_error)
int stage, String compile_error)Sets the compilation error message for the given shader stage to compile_error. Equivalent to setting one of compile_error_compute, compile_error_fragment, compile_error_tesselation_control, compile_error_tesselation_evaluation, compile_error_vertex.