Struct MeshMaterial3d 

pub struct MeshMaterial3d<M>(pub Handle<M>)
where
    M: Material;

A material used for rendering a Mesh3d.

See Material for general information about 3D materials and how to implement your own materials.

Example

// Spawn an entity with a mesh using `StandardMaterial`.
fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
) {
    commands.spawn((
        Mesh3d(meshes.add(Capsule3d::default())),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: RED.into(),
            ..Default::default()
        })),
    ));
}

Tuple Fields

0: Handle<M>

Methods from Deref<Target = Handle<M>>

pub fn id(&self) -> AssetId<A>

Returns the AssetId of this Asset.

pub fn path(&self) -> Option<&AssetPath<'static>>

Returns the path if this is (1) a strong handle and (2) the asset has a path

pub fn is_uuid(&self) -> bool

Returns true if this is a uuid handle.

pub fn is_strong(&self) -> bool

Returns true if this is a strong handle.

Trait Implementations

impl<M> AsAssetId for MeshMaterial3d<M>

where M: Material,

type Asset = M

The underlying asset type.

fn as_asset_id(&self) -> AssetId<<MeshMaterial3d<M> as AsAssetId>::Asset>

Retrieves the asset id from this component.

impl<M> Clone for MeshMaterial3d<M>

where M: Clone + Material,

fn clone(&self) -> MeshMaterial3d<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Component for MeshMaterial3d<M>

where M: Material, MeshMaterial3d<M>: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<M> Debug for MeshMaterial3d<M>

where M: Debug + Material,

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

Formats the value using the given formatter.

impl<M> Default for MeshMaterial3d<M>

where M: Material,

fn default() -> MeshMaterial3d<M>

Returns the “default value” for a type.

impl<M> Deref for MeshMaterial3d<M>

where M: Material,

type Target = Handle<M>

The resulting type after dereferencing.

fn deref(&self) -> &<MeshMaterial3d<M> as Deref>::Target

Dereferences the value.

impl<M> DerefMut for MeshMaterial3d<M>

where M: Material,

fn deref_mut(&mut self) -> &mut <MeshMaterial3d<M> as Deref>::Target

Mutably dereferences the value.

impl<M> ErasedRenderAsset for MeshMaterial3d<M>

where M: Material, <M as AsBindGroup>::Data: PartialEq + Eq + Hash + Clone,

type SourceAsset = M

The representation of the asset in the “main world”.

type ErasedAsset = PreparedMaterial

The target representation of the asset in the “render world”.

type Param = (Res<'static, RenderDevice>, Res<'static, DefaultOpaqueRendererMethod>, ResMut<'static, MaterialBindGroupAllocators>, ResMut<'static, RenderMaterialBindings>, Res<'static, DrawFunctions<Opaque3d>>, Res<'static, DrawFunctions<AlphaMask3d>>, Res<'static, DrawFunctions<Transmissive3d>>, Res<'static, DrawFunctions<Transparent3d>>, Res<'static, DrawFunctions<Opaque3dPrepass>>, Res<'static, DrawFunctions<AlphaMask3dPrepass>>, Res<'static, DrawFunctions<Opaque3dDeferred>>, Res<'static, DrawFunctions<AlphaMask3dDeferred>>, Res<'static, DrawFunctions<Shadow>>, Res<'static, AssetServer>, (Option<Res<'static, ShadowsEnabled<M>>>, Option<Res<'static, PrepassEnabled<M>>>, <M as AsBindGroup>::Param))

Specifies all ECS data required by ErasedRenderAsset::prepare_asset.

fn prepare_asset( material: <MeshMaterial3d<M> as ErasedRenderAsset>::SourceAsset, material_id: AssetId<<MeshMaterial3d<M> as ErasedRenderAsset>::SourceAsset>, _: &mut <<MeshMaterial3d<M> as ErasedRenderAsset>::Param as SystemParam>::Item<'_, '_>, ) -> Result<<MeshMaterial3d<M> as ErasedRenderAsset>::ErasedAsset, PrepareAssetError<<MeshMaterial3d<M> as ErasedRenderAsset>::SourceAsset>>

Prepares the ErasedRenderAsset::SourceAsset for the GPU by transforming it into a ErasedRenderAsset.

fn unload_asset( source_asset: AssetId<<MeshMaterial3d<M> as ErasedRenderAsset>::SourceAsset>, _: &mut <<MeshMaterial3d<M> as ErasedRenderAsset>::Param as SystemParam>::Item<'_, '_>, )

Called whenever the ErasedRenderAsset::SourceAsset has been removed.

fn asset_usage(_source_asset: &Self::SourceAsset) -> RenderAssetUsages

Whether or not to unload the asset after extracting it to the render world.

fn byte_len(erased_asset: &Self::SourceAsset) -> Option<usize>

Size of the data the asset will upload to the gpu. Specifying a return value will allow the asset to be throttled via RenderAssetBytesPerFrameLimiter.

impl<M> From<&MeshMaterial3d<M>> for AssetId<M>

where M: Material,

fn from(material: &MeshMaterial3d<M>) -> AssetId<M>

Converts to this type from the input type.

impl<M> From<Handle<M>> for MeshMaterial3d<M>

where M: Material,

fn from(value: Handle<M>) -> MeshMaterial3d<M>

Converts to this type from the input type.

impl<M> From<MeshMaterial3d<M>> for AssetId<M>

where M: Material,

fn from(material: MeshMaterial3d<M>) -> AssetId<M>

Converts to this type from the input type.

impl<M> FromReflect for MeshMaterial3d<M>

where M: Material + TypePath, MeshMaterial3d<M>: Any + Send + Sync, Handle<M>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<MeshMaterial3d<M>>

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<M> GetTypeRegistration for MeshMaterial3d<M>

where M: Material + TypePath, MeshMaterial3d<M>: Any + Send + Sync, Handle<M>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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<M> PartialEq for MeshMaterial3d<M>

where M: Material,

fn eq(&self, other: &MeshMaterial3d<M>) -> 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<M> PartialReflect for MeshMaterial3d<M>

where M: Material + TypePath, MeshMaterial3d<M>: Any + Send + Sync, Handle<M>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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 + 'static), ) -> 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<MeshMaterial3d<M>>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<MeshMaterial3d<M>>, ) -> 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 + 'static)>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> 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 to_dynamic(&self) -> Box<dyn PartialReflect>

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

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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<M> Reflect for MeshMaterial3d<M>

where M: Material + TypePath, MeshMaterial3d<M>: Any + Send + Sync, Handle<M>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<MeshMaterial3d<M>>) -> 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<MeshMaterial3d<M>>) -> Box<dyn Reflect>

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

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

Casts this type to a fully-reflected value.

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

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<M> TupleStruct for MeshMaterial3d<M>

where M: Material + TypePath, MeshMaterial3d<M>: Any + Send + Sync, Handle<M>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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

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

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

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

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl<M> TypePath for MeshMaterial3d<M>

where M: Material + TypePath, MeshMaterial3d<M>: 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<M> Typed for MeshMaterial3d<M>

where M: Material + TypePath, MeshMaterial3d<M>: Any + Send + Sync, Handle<M>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<M> Eq for MeshMaterial3d<M>

where M: Material,