Struct Material 

pub struct Material { /* private fields */ }

A render pipeline asset, plus the bind group values (textures/samplers/ uniforms/storage buffers) it renders with — WGSL shader source and fixed-function state (vertex layouts, cull mode, depth, targets) compile into a wgpu::RenderPipeline; many Materials sharing the same shader and fixed-function state automatically share one compiled pipeline (see MaterialPipelineCache), so “the same shader, several different uniform-value combinations” is just several Materials, not a separate instance concept.

Bind group 0 is this material’s own — build it with the streamlined per-binding calls (.texture(...)/.sampler(...)/.uniform_value(...)/etc., each declaring the entry and providing its value in one call, visible to the fragment stage, binding index auto-assigned) for the common case, or .with_entry(...)/.with_entry_at(...) plus the matching .with_texture(...)/etc. value-only call when you need to override visibility, sample type, or the binding index. .with_extra_group(...) appends group 1 and up — a shared/global layout, most often.

Implementations

impl Material

pub fn new(shader_source: &'static str) -> Self

pub fn standard(shader_source: &'static str) -> Self

Like new, but pre-filled with the common opaque-3D-geometry defaults instead of leaving them empty: Vertex::layout() for .with_vertex_layouts, a single opaque target in the real surface format for .with_targets (rendering straight to the screen is the common case this saves you from getting wrong — the surface format varies by platform/backend, e.g. Bgra8Unorm is common on Windows/DX12, not the Rgba8Unorm [DEFAULT_TARGET] assumes), and DepthStencilState::DEFAULT for .with_depth. The surface format is resolved against Backend at upload time, not here — standard itself needs no Backend reference, same as new. Still a plain builder — chain .with_vertex_layouts(...)/.with_targets(...)/ .with_depth(...)/.without_depth()/etc. afterwards to override any of these for a material that doesn’t fit the common case (a custom vertex type, an offscreen target with a different/blended format, no depth test).

pub fn with_label(self, label: &'static str) -> Self

pub fn with_vertex_entry(self, entry: &'static str) -> Self

pub fn without_vertex_entry(self) -> Self

pub fn with_fragment_entry(self, entry: &'static str) -> Self

pub fn without_fragment_entry(self) -> Self

pub fn with_vertex_layouts(self, layouts: Vec<VertexBufferLayout>) -> Self

pub fn with_entry(self, name: &'static str, kind: BindingKind) -> Self

Declares one of this material’s own (group 0) bind group entries, at the next auto-assigned binding index — the low-level counterpart to the streamlined .texture(...)/.sampler(...)/etc. calls, for when you need a kind one of those doesn’t produce (vertex/compute visibility, a non-default sample type, a dynamic-offset buffer). Pair it with the matching value-only .with_texture(...)/.with_sampler(...)/etc. call.

pub fn with_entry_at( self, name: &'static str, binding: u32, kind: BindingKind, ) -> Self

Same as with_entry, pinning an explicit binding index instead of auto-assigning the next one.

pub fn with_extra_group(self, group: GroupEntry) -> Self

Appends a bind group beyond this material’s own (group 0) — typically GroupEntry::Global, a layout shared with other materials/computes via GlobalLayoutPool. Groups append in call order, starting at group 1.

pub fn with_cull_mode(self, mode: Face) -> Self

pub fn without_cull_mode(self) -> Self

pub fn with_depth(self, depth: DepthStencilState) -> Self

pub fn without_depth(self) -> Self

pub fn with_targets(self, targets: Vec<ColorTargetState>) -> Self

pub fn with_polygon_mode(self, mode: PolygonMode) -> Self

pub fn with_sample_count(self, count: u32) -> Self

pub fn with_texture(self, name: &'static str, handle: Handle<Texture>) -> Self

Binds a texture value against an entry declared separately (via .with_entry(...)/.with_entry_at(...)) — for when .texture(...)’s fragment-visible/filterable-float default isn’t right. Most materials want .texture(...) instead.

pub fn with_texture_array( self, name: &'static str, handle: Handle<TextureArray>, ) -> Self

Value-only counterpart to .texture_array(...) — see .with_texture.

pub fn with_cubemap(self, name: &'static str, handle: Handle<Cubemap>) -> Self

Value-only counterpart to .cubemap(...) — see .with_texture.

pub fn with_texture_view(self, name: &'static str, view: TextureView) -> Self

Binds an already-built TextureView directly — e.g. one mip level from GPUTexture::get_view, or a standalone render target from Texture::empty. Unlike .with_texture/.with_texture_array/.with_cubemap, no Handle lookup happens at upload time — view must already exist.

pub fn with_sampler(self, name: &'static str, kind: SamplerKind) -> Self

Value-only counterpart to .sampler(...) — see .with_texture.

pub fn with_uniform(self, name: &'static str, data: Vec<u8>) -> Self

Value-only counterpart to .uniform(...) — see .with_texture.

pub fn with_storage(self, name: &'static str, data: Vec<u8>) -> Self

Value-only counterpart to .storage(...) — see .with_texture. Declares a read-write entry via .with_entry(...) if you need one; .storage(...)’s streamlined default is read-only.

pub fn with_uniform_value<T>(self, name: &'static str, value: &T) -> Self

where T: ShaderType + WriteInto,

Same as with_uniform, but takes a typed value instead of pre-packed bytes — uses encase to lay it out with correct WGSL uniform (std140) alignment. Value-only counterpart to .uniform_value(...).

pub fn with_storage_value<T>(self, name: &'static str, value: &T) -> Self

where T: ShaderType + WriteInto,

Same as with_storage, but takes a typed value instead of pre-packed bytes — uses encase to lay it out with correct WGSL storage (std430) alignment. Value-only counterpart to .storage_value(...).

pub fn texture(self, name: &'static str, handle: Handle<Texture>) -> Self

Declares a fragment-visible texture_2d<f32> entry at the next auto-assigned binding index and binds handle to it — the streamlined one-call form of .with_entry(name, BindingKind::texture_2d(FRAGMENT)) followed by .with_texture(name, handle). Reach for those two directly instead when you need vertex/compute visibility, a non-default sample type, or an explicit binding index.

pub fn texture_array( self, name: &'static str, handle: Handle<TextureArray>, ) -> Self

Streamlined form of .texture_array(...) — see texture.

pub fn cubemap(self, name: &'static str, handle: Handle<Cubemap>) -> Self

Streamlined form of .cubemap(...) — see texture.

pub fn sampler(self, name: &'static str, kind: SamplerKind) -> Self

Streamlined form of .sampler(...) — see texture.

pub fn uniform(self, name: &'static str, data: Vec<u8>) -> Self

Streamlined form of .uniform(...) — see texture.

pub fn storage(self, name: &'static str, data: Vec<u8>) -> Self

Streamlined form of .storage(...) (read-only) — see texture.

pub fn uniform_value<T>(self, name: &'static str, value: &T) -> Self

where T: ShaderType + WriteInto,

Streamlined, typed form of .uniform(...) — declares the entry and binds an encase-laid-out value in one call. See texture.

pub fn storage_value<T>(self, name: &'static str, value: &T) -> Self

where T: ShaderType + WriteInto,

Streamlined, typed form of .storage(...) (read-only) — see texture.

pub fn with_buffer(self, name: &'static str, buffer: Buffer) -> Self

Binds an existing Buffer instead of uploading raw bytes — for a buffer you already built yourself (e.g. one a compute pass writes to, then this material reads from). Unlike .with_uniform/.with_storage, no buffer is created here; buffer must already carry the usage flags this binding needs.

pub fn with_dynamic_buffer( self, name: &'static str, buffer: DynamicBuffer, ) -> Self

Binds an existing DynamicBuffer — the dynamic-offset counterpart to .with_buffer.

pub fn with_param(self, name: &'static str, entry: BindingValue) -> Self

pub fn build_asset( self, name: &str, assets: &mut Assets<Material>, ) -> Handle<Material>

Trait Implementations

impl Asset<Backend> for Material

type Deps<'a> = (Read<'a, GlobalLayoutPool>, Read<'a, MaterialPipelineCache>, Read<'a, Assets<Texture>>, Read<'a, Assets<TextureArray>>, Read<'a, Assets<Cubemap>>, Read<'a, GlobalSamplers>)

fn upload<'a>( &self, backend: &Backend, deps: &Self::Deps<'a>, ) -> Option<GPUMaterial>

impl AssetSource for Material

type Processed = GPUMaterial

impl Default for Material

fn default() -> Self

Returns the “default value” for a type.