Struct ExtendedMaterial

pub struct ExtendedMaterial<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: Material, E: MaterialExtension> AsBindGroup for ExtendedMaterial<B, E>

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

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

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

fn bindless_slot_count() -> Option<BindlessSlabResourceLimit>

The number of slots per bind group, if bindless mode is enabled.

fn unprepared_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, (base_param, extended_param): &mut SystemParamItem<'_, '_, Self::Param>, force_non_bindless: bool, ) -> Result<UnpreparedBindGroup<Self::Data>, AsBindGroupError>

Returns a vec of (binding index, OwnedBindingResource).

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

where Self: Sized,

Returns a vec of bind group layout entries.

fn bindless_descriptor() -> Option<BindlessDescriptor>

fn bindless_supported(_: &RenderDevice) -> bool

True if the hardware actually supports bindless textures for this type, taking the device and driver capabilities into account.

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

label

fn as_bind_group( &self, layout: &BindGroupLayout, render_device: &RenderDevice, param: &mut <Self::Param as SystemParam>::Item<'_, '_>, ) -> 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: Clone + Material, E: Clone + MaterialExtension> Clone for ExtendedMaterial<B, E>

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

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

Formats the value using the given formatter.

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

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

fn default() -> Self

Returns the “default value” for a type.

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

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

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

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

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 ExtendedMaterial<B, E>: Any + Send + Sync, B: FromReflect + TypePath + MaybeTyped + RegisterForReflection + Material, E: FromReflect + TypePath + MaybeTyped + RegisterForReflection + MaterialExtension,

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

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 specialize( pipeline: &MaterialPipeline<Self>, descriptor: &mut RenderPipelineDescriptor, layout: &MeshVertexBufferLayoutRef, key: MaterialPipelineKey<Self>, ) -> Result<(), SpecializedMeshPipelineError>

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

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

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

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

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply 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<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

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 is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

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

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

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

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

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

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

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

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

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

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

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

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

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

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

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

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 to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

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

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

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 ExtendedMaterial<B, E>: Any + Send + Sync, B: FromReflect + TypePath + MaybeTyped + RegisterForReflection + Material, E: FromReflect + TypePath + MaybeTyped + RegisterForReflection + MaterialExtension,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<B: Material, E: MaterialExtension> VisitAssetDependencies for ExtendedMaterial<B, E>

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

impl<B: Material, E: MaterialExtension> Asset for ExtendedMaterial<B, E>