Struct bevy::pbr::ExtendedMaterial

pub struct ExtendedMaterial<B, E>
where
    B: Material,
    E: MaterialExtension,
{
    pub base: B,
    pub extension: E,
}

A material that extends a base Material with additional shaders and data.

The data from both materials will be combined and made available to the shader so that shader functions built for the base material (and referencing the base material bindings) will work as expected, and custom alterations based on custom data can also be used.

If the extension E returns a non-default result from vertex_shader() it will be used in place of the base material’s vertex shader.

If the extension E returns a non-default result from fragment_shader() it will be used in place of the base fragment shader.

When used with StandardMaterial as the base, all the standard material fields are present, so the pbr_fragment shader functions can be called from the extension shader (see the extended_material example).

Fields

base: B

extension: E

Trait Implementations

impl<B, E> AsBindGroup for ExtendedMaterial<B, E>

where B: Material, E: MaterialExtension,

type Data = (<B as AsBindGroup>::Data, <E as AsBindGroup>::Data)

Data that will be stored alongside the “prepared” bind group.

fn unprepared_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, images: &RenderAssets<GpuImage>, fallback_image: &FallbackImage ) -> Result<UnpreparedBindGroup<<ExtendedMaterial<B, E> as AsBindGroup>::Data>, AsBindGroupError>

Returns a vec of (binding index, OwnedBindingResource). In cases where OwnedBindingResource is not available (as for bindless texture arrays currently), an implementor may define as_bind_group directly. This may prevent certain features from working correctly.

fn bind_group_layout_entries( render_device: &RenderDevice ) -> Vec<BindGroupLayoutEntry>

where ExtendedMaterial<B, E>: Sized,

Returns a vec of bind group layout entries

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

label

fn as_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, images: &RenderAssets<GpuImage>, fallback_image: &FallbackImage ) -> Result<PreparedBindGroup<Self::Data>, AsBindGroupError>

Creates a bind group for self matching the layout defined in AsBindGroup::bind_group_layout.

fn bind_group_layout(render_device: &RenderDevice) -> BindGroupLayout

where Self: Sized,

Creates the bind group layout matching all bind groups returned by AsBindGroup::as_bind_group

impl<B, E> Clone for ExtendedMaterial<B, E>

where B: Clone + Material, E: Clone + MaterialExtension,

fn clone(&self) -> ExtendedMaterial<B, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B, E> Default for ExtendedMaterial<B, E>

where B: Material + Default, E: MaterialExtension + Default,

fn default() -> ExtendedMaterial<B, E>

Returns the “default value” for a type.

impl<B, E> FromReflect for ExtendedMaterial<B, E>

where B: Material + FromReflect + TypePath + RegisterForReflection, E: MaterialExtension + FromReflect + TypePath + RegisterForReflection, ExtendedMaterial<B, E>: Any + Send + Sync,

fn from_reflect( reflect: &(dyn Reflect + 'static) ) -> Option<ExtendedMaterial<B, E>>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<B, E> GetTypeRegistration for ExtendedMaterial<B, E>

where B: Material + FromReflect + TypePath + RegisterForReflection, E: MaterialExtension + FromReflect + TypePath + RegisterForReflection, ExtendedMaterial<B, E>: Any + Send + Sync,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<B, E> Material for ExtendedMaterial<B, E>

where B: Material, E: MaterialExtension,

fn vertex_shader() -> ShaderRef

Returns this material’s vertex shader. If ShaderRef::Default is returned, the default mesh vertex shader will be used.

fn fragment_shader() -> ShaderRef

Returns this material’s fragment shader. If ShaderRef::Default is returned, the default mesh fragment shader will be used.

fn alpha_mode(&self) -> AlphaMode

Returns this material’s AlphaMode. Defaults to AlphaMode::Opaque.

fn opaque_render_method(&self) -> OpaqueRendererMethod

Returns if this material should be rendered by the deferred or forward renderer. for AlphaMode::Opaque or AlphaMode::Mask materials. If OpaqueRendererMethod::Auto, it will default to what is selected in the DefaultOpaqueRendererMethod resource.

fn depth_bias(&self) -> f32

Add a bias to the view depth of the mesh which can be used to force a specific render order. for meshes with similar depth, to avoid z-fighting. The bias is in depth-texture units so large values may be needed to overcome small depth differences.

fn reads_view_transmission_texture(&self) -> bool

Returns whether the material would like to read from ViewTransmissionTexture.

fn prepass_vertex_shader() -> ShaderRef

Returns this material’s prepass vertex shader. If ShaderRef::Default is returned, the default prepass vertex shader will be used.

fn prepass_fragment_shader() -> ShaderRef

Returns this material’s prepass fragment shader. If ShaderRef::Default is returned, the default prepass fragment shader will be used.

fn deferred_vertex_shader() -> ShaderRef

Returns this material’s deferred vertex shader. If ShaderRef::Default is returned, the default deferred vertex shader will be used.

fn deferred_fragment_shader() -> ShaderRef

Returns this material’s deferred fragment shader. If ShaderRef::Default is returned, the default deferred fragment shader will be used.

fn meshlet_mesh_fragment_shader() -> ShaderRef

Available on crate feature meshlet only.

Returns this material’s crate::meshlet::MeshletMesh fragment shader. If ShaderRef::Default is returned, the default meshlet mesh fragment shader will be used.

fn meshlet_mesh_prepass_fragment_shader() -> ShaderRef

Available on crate feature meshlet only.

Returns this material’s crate::meshlet::MeshletMesh prepass fragment shader. If ShaderRef::Default is returned, the default meshlet mesh prepass fragment shader will be used.

fn meshlet_mesh_deferred_fragment_shader() -> ShaderRef

Available on crate feature meshlet only.

Returns this material’s crate::meshlet::MeshletMesh deferred fragment shader. If ShaderRef::Default is returned, the default meshlet mesh deferred fragment shader will be used.

fn specialize( pipeline: &MaterialPipeline<ExtendedMaterial<B, E>>, descriptor: &mut RenderPipelineDescriptor, layout: &MeshVertexBufferLayoutRef, key: MaterialPipelineKey<ExtendedMaterial<B, E>> ) -> Result<(), SpecializedMeshPipelineError>

Customizes the default RenderPipelineDescriptor for a specific entity using the entity’s MaterialPipelineKey and MeshVertexBufferLayoutRef as input.

impl<B, E> Reflect for ExtendedMaterial<B, E>

where B: Material + FromReflect + TypePath + RegisterForReflection, E: MaterialExtension + FromReflect + TypePath + RegisterForReflection, ExtendedMaterial<B, E>: Any + Send + Sync,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<ExtendedMaterial<B, E>>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<ExtendedMaterial<B, E>>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<ExtendedMaterial<B, E>>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<B, E> Struct for ExtendedMaterial<B, E>

where B: Material + FromReflect + TypePath + RegisterForReflection, E: MaterialExtension + FromReflect + TypePath + RegisterForReflection, ExtendedMaterial<B, E>: Any + Send + Sync,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl<B, E> TypePath for ExtendedMaterial<B, E>

where B: Material + TypePath, E: MaterialExtension + TypePath, ExtendedMaterial<B, E>: 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<B, E> Typed for ExtendedMaterial<B, E>

where B: Material + FromReflect + TypePath + RegisterForReflection, E: MaterialExtension + FromReflect + TypePath + RegisterForReflection, ExtendedMaterial<B, E>: Any + Send + Sync,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<B, E> VisitAssetDependencies for ExtendedMaterial<B, E>

where B: Material, E: MaterialExtension,

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

impl<B, E> Asset for ExtendedMaterial<B, E>

where B: Material, E: MaterialExtension,