Struct Shader

pub struct Shader {
    pub path: String,
    pub source: Source,
    pub import_path: ShaderImport,
    pub imports: Vec<ShaderImport>,
    pub additional_imports: Vec<ImportDefinition>,
    pub shader_defs: Vec<ShaderDefVal>,
    pub file_dependencies: Vec<Handle<Shader>>,
    pub validate_shader: ValidateShader,
}

A shader, as defined by its ShaderSource and ShaderStage This is an “unprocessed” shader. It can contain preprocessor directives.

Fields

path: String

source: Source

import_path: ShaderImport

imports: Vec<ShaderImport>

additional_imports: Vec<ImportDefinition>

shader_defs: Vec<ShaderDefVal>

file_dependencies: Vec<Handle<Shader>>

validate_shader: ValidateShader

Enable or disable runtime shader validation, trading safety against speed.

Please read the ValidateShader docs for a discussion of the tradeoffs involved.

Implementations

impl Shader

pub fn from_wgsl( source: impl Into<Cow<'static, str>>, path: impl Into<String>, ) -> Shader

Examples found in repository

examples/2d/mesh2d_manual.rs (line 302)

    fn build(&self, app: &mut App) {
        // Load our custom shader
        let mut shaders = app.world_mut().resource_mut::<Assets<Shader>>();
        shaders.insert(
            &COLORED_MESH2D_SHADER_HANDLE,
            Shader::from_wgsl(COLORED_MESH2D_SHADER, file!()),
        );
        app.add_plugins(SyncComponentPlugin::<ColoredMesh2d>::default());

        // Register our custom draw function, and add our render systems
        app.get_sub_app_mut(RenderApp)
            .unwrap()
            .add_render_command::<Transparent2d, DrawColoredMesh2d>()
            .init_resource::<SpecializedRenderPipelines<ColoredMesh2dPipeline>>()
            .init_resource::<RenderColoredMesh2dInstances>()
            .add_systems(
                ExtractSchedule,
                extract_colored_mesh2d.after(extract_mesh2d),
            )
            .add_systems(Render, queue_colored_mesh2d.in_set(RenderSet::QueueMeshes));
    }

pub fn from_wgsl_with_defs( source: impl Into<Cow<'static, str>>, path: impl Into<String>, shader_defs: Vec<ShaderDefVal>, ) -> Shader

pub fn from_glsl( source: impl Into<Cow<'static, str>>, stage: ShaderStage, path: impl Into<String>, ) -> Shader

pub fn from_spirv( source: impl Into<Cow<'static, [u8]>>, path: impl Into<String>, ) -> Shader

pub fn from_wesl( source: impl Into<Cow<'static, str>>, path: impl Into<String>, ) -> Shader

pub fn set_import_path<P>(&mut self, import_path: P)

where P: Into<String>,

pub fn with_import_path<P>(self, import_path: P) -> Shader

where P: Into<String>,

pub fn import_path(&self) -> &ShaderImport

pub fn imports(&self) -> impl ExactSizeIterator

Trait Implementations

impl Clone for Shader

fn clone(&self) -> Shader

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl<'a> From<&'a Shader> for ComposableModuleDescriptor<'a>

fn from(shader: &'a Shader) -> ComposableModuleDescriptor<'a>

Converts to this type from the input type.

impl<'a> From<&'a Shader> for NagaModuleDescriptor<'a>

fn from(shader: &'a Shader) -> NagaModuleDescriptor<'a>

Converts to this type from the input type.

impl TypePath for Shader

where Shader: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl VisitAssetDependencies for Shader

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Asset for Shader