Struct Shader 

pub struct Shader {
    pub entry_name: String,
    pub specialization: Option<SpecializationMap>,
    pub spirv: SpirvBinary,
    pub stage: ShaderStageFlags,
    /* private fields */
}

Describes a shader program which runs on a pipeline stage.

See VkShaderModuleCreateInfo and VkPipelineShaderStageCreateInfo.

Fields

entry_name: String

The name of the entry point which will be executed by this shader.

The default value is main.

specialization: Option<SpecializationMap>

Data about Vulkan specialization constants.

See VkSpecializationInfo.

Examples

Basic usage (GLSL):

#version 460 core
#pragma shader_stage(compute)

// Defaults to 6 if not set using Shader specialization!
layout(constant_id = 0) const uint MY_COUNT = 6;

layout(set = 0, binding = 0) uniform sampler2D my_samplers[MY_COUNT];

void main()
{
    // Code uses MY_COUNT number of my_samplers here
}

// We instead specify 42 for MY_COUNT:
let shader = Shader::new_fragment(my_shader_code.as_slice())
    .specialization(
        SpecializationMap::new(42u32.to_ne_bytes())
            .constant(0, 0, 4)
    );

spirv: SpirvBinary

Shader code.

Although SPIR-V code is specified as u32 values, this field uses u8 in order to make loading from file simpler. You should always have a SPIR-V code length which is a multiple of four bytes, or an error will be returned during pipeline creation.

See VkShaderModuleCreateInfo.

stage: ShaderStageFlags

The shader stage this structure applies to.

See VkShaderStageFlagBits.

Implementations

impl Shader

pub fn new( stage: ShaderStageFlags, spirv: impl Into<SpirvBinary>, ) -> ShaderBuilder

Specifies a shader with the given stage and shader code.

See VkShaderModuleCreateInfo.

pub fn new_any_hit(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new ray tracing any-hit shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_any_hit( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new ray tracing any-hit shader. , returning an error if the SPIR-V is invalid.

pub fn new_callable(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new ray tracing callable shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_callable( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new ray tracing callable shader. , returning an error if the SPIR-V is invalid.

pub fn new_closest_hit(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new ray tracing closest-hit shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_closest_hit( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new ray tracing closest-hit shader. , returning an error if the SPIR-V is invalid.

pub fn new_compute(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new compute shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_compute( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new compute shader. , returning an error if the SPIR-V is invalid.

pub fn new_fragment(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new fragment shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_fragment( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new fragment shader. , returning an error if the SPIR-V is invalid.

pub fn new_geometry(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new geometry shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_geometry( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new geometry shader. , returning an error if the SPIR-V is invalid.

pub fn new_intersection(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new ray tracing intersection shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_intersection( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new ray tracing intersection shader. , returning an error if the SPIR-V is invalid.

pub fn new_mesh(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new mesh shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_mesh( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new mesh shader. , returning an error if the SPIR-V is invalid.

pub fn new_miss(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new ray tracing miss shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_miss( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new ray tracing miss shader. , returning an error if the SPIR-V is invalid.

pub fn new_ray_gen(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new ray tracing ray-generation shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_ray_gen( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new ray tracing ray-generation shader. , returning an error if the SPIR-V is invalid.

pub fn new_task(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new task shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_task( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new task shader. , returning an error if the SPIR-V is invalid.

pub fn new_tessellation_ctrl(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new tessellation control shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_tessellation_ctrl( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new tessellation control shader. , returning an error if the SPIR-V is invalid.

pub fn new_tessellation_eval(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new tessellation evaluation shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_tessellation_eval( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new tessellation evaluation shader. , returning an error if the SPIR-V is invalid.

pub fn new_vertex(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Creates a new vertex shader.

Panics

Panics if the shader code is invalid. Use try_build on the returned builder for a fallible path.

pub fn try_new_vertex( spirv: impl Into<SpirvBinary>, ) -> Result<Shader, DriverError>

Creates a Creates a new vertex shader. , returning an error if the SPIR-V is invalid.

pub fn builder() -> ShaderBuilder

Creates a default ShaderBuilder.

pub fn from_spirv(spirv: impl Into<SpirvBinary>) -> ShaderBuilder

Specifies a shader with the given shader code.

See VkShaderModuleCreateInfo.

Trait Implementations

impl Clone for Shader

fn clone(&self) -> Shader

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Shader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TryFrom<&[u8]> for Shader

type Error = DriverError

The type returned in the event of a conversion error.

fn try_from(spirv: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&[u32]> for Shader

type Error = DriverError

The type returned in the event of a conversion error.

fn try_from(spirv: &[u32]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ShaderBuilder> for Shader

type Error = DriverError

The type returned in the event of a conversion error.

fn try_from(shader: ShaderBuilder) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Shader

type Error = DriverError

The type returned in the event of a conversion error.

fn try_from(spirv: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u32>> for Shader

type Error = DriverError

The type returned in the event of a conversion error.

fn try_from(spirv: Vec<u32>) -> Result<Self, Self::Error>

Performs the conversion.