Enum ShaderSource

#[non_exhaustive]
pub enum ShaderSource<'a> {
    SpirV(Cow<'a, [u32]>),
    Glsl {
        shader: Cow<'a, str>,
        stage: ShaderStage,
        defines: FastHashMap<String, String>,
    },
    Wgsl(Cow<'a, str>),
    Naga(Cow<'static, Module>),
}

Source of a shader module.

The source will be parsed and validated.

Any necessary shader translation (e.g. from WGSL to SPIR-V or vice versa) will be done internally by wgpu.

This type is unique to the Rust API of wgpu. In the WebGPU specification, only WGSL source code strings are accepted.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SpirV(Cow<'a, [u32]>)

Available on crate feature spirv only.

SPIR-V module represented as a slice of words.

See also: util::make_spirv, include_spirv

Glsl

Available on crate feature glsl only.

GLSL module as a string slice.

Note: GLSL is not yet fully supported and must be a specific ShaderStage.

Fields

shader: Cow<'a, str>

The source code of the shader.

stage: ShaderStage

The shader stage that the shader targets. For example, naga::ShaderStage::Vertex

defines: FastHashMap<String, String>

Defines to unlock configured shader features.

Wgsl(Cow<'a, str>)

Available on crate feature wgsl only.

WGSL module as a string slice.

Naga(Cow<'static, Module>)

Available on crate feature naga-ir only.

Naga module.

Trait Implementations

impl<'a> Clone for ShaderSource<'a>

fn clone(&self) -> ShaderSource<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ShaderSource<'a>

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

Formats the value using the given formatter.