Struct ShaderSource 

pub struct ShaderSource {
    pub vertex: String,
    pub fragment: String,
    pub name: Option<ParamString>,
    pub parameters: SizedHashMap<ParamString, ShaderParameter, BuildHasherDefault<FxHasher>>,
    pub format: ImageFormat,
}

Available on crate feature preprocess only.

The source file for a single shader pass.

Fields

vertex: String

The source contents for the vertex shader.

fragment: String

The source contents for the fragment shader.

name: Option<ParamString>

The alias of the shader if available.

parameters: SizedHashMap<ParamString, ShaderParameter, BuildHasherDefault<FxHasher>>

The list of shader parameters found in the shader source.

format: ImageFormat

The image format the shader expects.

Implementations

impl ShaderSource

pub fn load( path: impl AsRef<Path>, features: ShaderFeatures, ) -> Result<ShaderSource, PreprocessError>

Load the source file at the given path, resolving includes relative to the location of the source file.

Trait Implementations

impl Clone for ShaderSource

fn clone(&self) -> ShaderSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShaderSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShaderSource

fn deserialize<__D>( __deserializer: __D, ) -> Result<ShaderSource, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShaderSource

fn eq(&self, other: &ShaderSource) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ShaderSource

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ShaderSource

impl TryFrom<&ShaderSource> for SpirvCompilation

fn try_from( source: &ShaderSource, ) -> Result<SpirvCompilation, <SpirvCompilation as TryFrom<&ShaderSource>>::Error>

Tries to compile SPIR-V from the provided shader source.

type Error = ShaderCompileError

The type returned in the event of a conversion error.

impl TryFrom<&ShaderSource> for WgslCompilation

fn try_from( source: &ShaderSource, ) -> Result<WgslCompilation, <WgslCompilation as TryFrom<&ShaderSource>>::Error>

Tries to compile from the provided shader source.

type Error = ShaderCompileError

The type returned in the event of a conversion error.