wgpu

Enum ShaderSource

Source
#[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>), }
Expand description

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)§

This enum is marked as 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§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ShaderSource<'a>

§

impl<'a> RefUnwindSafe for ShaderSource<'a>

§

impl<'a> Send for ShaderSource<'a>

§

impl<'a> Sync for ShaderSource<'a>

§

impl<'a> Unpin for ShaderSource<'a>

§

impl<'a> UnwindSafe for ShaderSource<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,