Enum AssetId 

pub enum AssetId<A>
where
    A: Asset,
{
    Index {
        index: AssetIndex,
        marker: PhantomData<fn() -> A>,
    },
    Uuid {
        uuid: Uuid,
    },
}

Available on crate feature bevy_asset only.

A unique runtime-only identifier for an Asset. This is cheap to Copy/Clone and is not directly tied to the lifetime of the Asset. This means it can point to an Asset that no longer exists.

For an identifier tied to the lifetime of an asset, see Handle.

For an “untyped” / “generic-less” id, see UntypedAssetId.

Variants

Index

A small / efficient runtime identifier that can be used to efficiently look up an asset stored in Assets. This is the “default” identifier used for assets. The alternative(s) (ex: AssetId::Uuid) will only be used if assets are explicitly registered that way.

Fields

index: AssetIndex

The unstable, opaque index of the asset.

marker: PhantomData<fn() -> A>

A marker to store the type information of the asset.

Uuid

A stable-across-runs / const asset identifier. This will only be used if an asset is explicitly registered in Assets with one.

Fields

uuid: Uuid

The UUID provided during asset registration.

Implementations

impl<A> AssetId<A>

where A: Asset,

pub const DEFAULT_UUID: Uuid

The UUID for the default AssetId. It is valid to assign a value to this in Assets and by convention (where appropriate) assets should support this pattern.

pub const INVALID_UUID: Uuid

👎Deprecated since 0.20.0:

Use Option<AssetId> if possible. AssetId::default may also work, but note that the default can map to a valid asset.

This asset id should never be valid. Assigning a value to this in Assets will produce undefined behavior, so don’t do it!

pub const fn invalid() -> AssetId<A>

👎Deprecated since 0.20.0:

Use Option<AssetId> if possible. AssetId::default may also work, but note that the default can map to a valid asset.

Returns an AssetId with Self::INVALID_UUID, which should never be assigned to.

pub fn untyped(self) -> UntypedAssetId

Converts this to an “untyped” / “generic-less” Asset identifier that stores the type information inside the UntypedAssetId.

Examples found in repository

examples/shader_advanced/manual_material.rs (line 262)

fn extract_image_materials(
    mut material_instances: ResMut<RenderMaterialInstances>,
    changed_meshes_query: Extract<
        Query<
            (Entity, &ViewVisibility, &ImageMaterial3d),
            Or<(Changed<ViewVisibility>, Changed<ImageMaterial3d>)>,
        >,
    >,
) {
    let last_change_tick = material_instances.current_change_tick;

    for (entity, view_visibility, material) in &changed_meshes_query {
        if view_visibility.get() {
            material_instances.instances.insert(
                entity.into(),
                RenderMaterialInstance {
                    asset_id: material.0.id().untyped(),
                    last_change_tick,
                },
            );
        } else {
            material_instances
                .instances
                .remove(&MainEntity::from(entity));
        }
    }
}

examples/shader_advanced/custom_phase_item.rs (line 307)

fn queue_custom_phase_item(
    pipeline_cache: Res<PipelineCache>,
    mut pipeline: ResMut<CustomPhasePipeline>,
    mut opaque_render_phases: ResMut<ViewBinnedRenderPhases<Opaque3d>>,
    opaque_draw_functions: Res<DrawFunctions<Opaque3d>>,
    views: Query<(&ExtractedView, &RenderVisibleEntities, &Msaa)>,
    dirty_specializations: Res<DirtySpecializations>,
    mut pending_custom_phase_item_queues: ResMut<PendingCustomPhaseItemQueues>,
    mut mesh_instances_queued_this_iteration_scratch_space: Local<MainEntityHashSet>,
) {
    let draw_custom_phase_item = opaque_draw_functions
        .read()
        .id::<DrawCustomPhaseItemCommands>();

    // Render phases are per-view, so we need to iterate over all views so that
    // the entity appears in them. (In this example, we have only one view, but
    // it's good practice to loop over all views anyway.)
    for (view, view_visible_entities, msaa) in views.iter() {
        let Some(opaque_phase) = opaque_render_phases.get_mut(&view.retained_view_entity) else {
            continue;
        };

        // Fetch the list of visible entities in the `CustomRenderedEntity`
        // class. If there are no such entities, then we have no entities to
        // render, and we're done.
        let Some(render_visible_mesh_entities) =
            view_visible_entities.get::<CustomRenderedEntity>()
        else {
            continue;
        };

        let view_pending_custom_phase_item_queues =
            pending_custom_phase_item_queues.prepare_for_new_frame(view.retained_view_entity);

        // First, remove meshes that need to be respecialized, and those that
        // were removed, from the bins.
        for &main_entity in dirty_specializations
            .iter_to_dequeue(view.retained_view_entity, render_visible_mesh_entities)
        {
            opaque_phase.remove(main_entity);
        }

        // Find all the custom rendered entities that are visible from this
        // view.
        for (render_entity, main_entity) in dirty_specializations.iter_to_queue(
            view.retained_view_entity,
            render_visible_mesh_entities,
            &view_pending_custom_phase_item_queues.prev_frame,
            &mut mesh_instances_queued_this_iteration_scratch_space,
        ) {
            // Ordinarily, the [`SpecializedRenderPipeline::Key`] would contain
            // some per-view settings, such as whether the view is HDR, but for
            // simplicity's sake we simply hard-code the view's characteristics,
            // with the exception of number of MSAA samples.
            let Ok(pipeline_id) = pipeline
                .variants
                .specialize(&pipeline_cache, CustomPhaseKey(*msaa))
            else {
                continue;
            };

            // Add the custom render item. We use the
            // [`BinnedRenderPhaseType::NonMesh`] type to skip the special
            // handling that Bevy has for meshes (preprocessing, indirect
            // draws, etc.)
            //
            // The asset ID is arbitrary; we simply use [`AssetId::default`],
            // but you can use anything you like. Note that the asset ID need
            // not be the ID of a [`Mesh`].
            opaque_phase.add(
                Opaque3dBatchSetKey {
                    draw_function: draw_custom_phase_item,
                    pipeline: pipeline_id,
                    material_bind_group_index: None,
                    lightmap_slab: None,
                    slabs: MeshSlabs::default(),
                },
                Opaque3dBinKey {
                    asset_id: AssetId::<Mesh>::default().untyped(),
                },
                (*render_entity, *main_entity),
                InputUniformIndex::default(),
                BinnedRenderPhaseType::NonMesh,
            );
        }
    }
}

Trait Implementations

impl<A> Clone for AssetId<A>

where A: Asset,

fn clone(&self) -> AssetId<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A> Copy for AssetId<A>

where A: Asset,

impl<A> Debug for AssetId<A>

where A: Asset,

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

Formats the value using the given formatter.

impl<A> Default for AssetId<A>

where A: Asset,

fn default() -> AssetId<A>

Returns the “default value” for a type.

impl<'de, A> Deserialize<'de> for AssetId<A>

where A: Asset,

fn deserialize<__D>( __deserializer: __D, ) -> Result<AssetId<A>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A> Display for AssetId<A>

where A: Asset,

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

Formats the value using the given formatter.

impl<A> Enum for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

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

Returns a reference to the value of the field (in the current variant) with the given name.

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

Returns a reference to the value of the field (in the current variant) at the given index.

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

Returns a mutable reference to the value of the field (in the current variant) with the given name.

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

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

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

Returns the name of the field (in the current variant) with the given index.

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

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn to_dynamic_enum(&self) -> Result<DynamicEnum, ReflectCloneError>

Creates a new DynamicEnum from this enum.

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

Will return None if TypeInfo is not available.

impl<A> Eq for AssetId<A>

where A: Asset,

impl<T> Equivalent<Handle<T>> for AssetId<T>

where T: Asset,

fn equivalent(&self, key: &Handle<T>) -> bool

Compare self to key and return true if they are equal.

impl From<&AnimationGraphHandle> for AssetId<AnimationGraph>

fn from(handle: &AnimationGraphHandle) -> AssetId<AnimationGraph>

Converts to this type from the input type.

impl<A> From<&Handle<A>> for AssetId<A>

where A: Asset,

fn from(value: &Handle<A>) -> AssetId<A>

Converts to this type from the input type.

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

where M: UiMaterial,

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

Converts to this type from the input type.

impl From<&Mesh2d> for AssetId<Mesh>

fn from(mesh: &Mesh2d) -> AssetId<Mesh>

Converts to this type from the input type.

impl From<&Mesh3d> for AssetId<Mesh>

fn from(mesh: &Mesh3d) -> AssetId<Mesh>

Converts to this type from the input type.

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

where M: Material2d,

fn from(material: &MeshMaterial2d<M>) -> AssetId<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 From<&MeshletMesh3d> for AssetId<MeshletMesh>

fn from(mesh: &MeshletMesh3d) -> AssetId<MeshletMesh>

Converts to this type from the input type.

impl<A> From<&mut Handle<A>> for AssetId<A>

where A: Asset,

fn from(value: &mut Handle<A>) -> AssetId<A>

Converts to this type from the input type.

impl<A> From<(AssetIndex, PhantomData<fn() -> A>)> for AssetId<A>

where A: Asset,

fn from(value: (AssetIndex, PhantomData<fn() -> A>)) -> AssetId<A>

Converts to this type from the input type.

impl From<AnimationGraphHandle> for AssetId<AnimationGraph>

fn from(handle: AnimationGraphHandle) -> AssetId<AnimationGraph>

Converts to this type from the input type.

impl<A> From<AssetId<A>> for UntypedAssetId

where A: Asset,

fn from(value: AssetId<A>) -> UntypedAssetId

Converts to this type from the input type.

impl<A> From<AssetIndex> for AssetId<A>

where A: Asset,

fn from(value: AssetIndex) -> AssetId<A>

Converts to this type from the input type.

impl<M> From<MaterialNode<M>> for AssetId<M>

where M: UiMaterial,

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

Converts to this type from the input type.

impl From<Mesh2d> for AssetId<Mesh>

fn from(mesh: Mesh2d) -> AssetId<Mesh>

Converts to this type from the input type.

impl From<Mesh3d> for AssetId<Mesh>

fn from(mesh: Mesh3d) -> AssetId<Mesh>

Converts to this type from the input type.

impl From<MeshAssetIdFlat> for AssetId<Mesh>

fn from(value: MeshAssetIdFlat) -> AssetId<Mesh>

Converts to this type from the input type.

impl<M> From<MeshMaterial2d<M>> for AssetId<M>

where M: Material2d,

fn from(material: MeshMaterial2d<M>) -> AssetId<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 From<MeshletMesh3d> for AssetId<MeshletMesh>

fn from(mesh: MeshletMesh3d) -> AssetId<MeshletMesh>

Converts to this type from the input type.

impl<A> From<Uuid> for AssetId<A>

where A: Asset,

fn from(value: Uuid) -> AssetId<A>

Converts to this type from the input type.

impl<A> FromArg for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

type This<'from_arg> = AssetId<A>

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<AssetId<A> as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl<A> FromReflect for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

fn from_reflect(__param0: &(dyn PartialReflect + 'static)) -> Option<AssetId<A>>

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<A> GetOwnership for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

fn ownership() -> Ownership

Returns the ownership of Self.

impl<A> GetTypeRegistration for AssetId<A>

where A: Asset + TypePath, AssetId<A>: 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<A> Hash for AssetId<A>

where A: Asset,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A> IntoReturn for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

fn into_return<'into_return>(self) -> Return<'into_return>

where AssetId<A>: 'into_return,

Converts Self into a Return value.

impl<A> Ord for AssetId<A>

where A: Asset,

fn cmp(&self, other: &AssetId<A>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<A> PartialEq for AssetId<A>

where A: Asset,

fn eq(&self, other: &AssetId<A>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<A> PartialEq<AssetId<A>> for UntypedAssetId

where A: Asset,

fn eq(&self, other: &AssetId<A>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<A> PartialEq<UntypedAssetId> for AssetId<A>

where A: Asset,

fn eq(&self, other: &UntypedAssetId) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<A> PartialOrd for AssetId<A>

where A: Asset,

fn partial_cmp(&self, other: &AssetId<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> PartialOrd<AssetId<A>> for UntypedAssetId

where A: Asset,

fn partial_cmp(&self, other: &AssetId<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> PartialOrd<UntypedAssetId> for AssetId<A>

where A: Asset,

fn partial_cmp(&self, other: &UntypedAssetId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> PartialReflect for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

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_param: &(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<AssetId<A>>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<AssetId<A>>, ) -> 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<AssetId<A>>) -> 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_hash(&self) -> Option<u64>

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

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

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

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

Debug formatter for the value.

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) -> Result<Box<dyn PartialReflect>, ReflectCloneError>

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

Indicates whether or not this type is a dynamic type.

impl<A> Reflect for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

fn into_any(self: Box<AssetId<A>>) -> 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<AssetId<A>>) -> 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<A> Serialize for AssetId<A>

where A: Asset,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A> TryFrom<UntypedAssetId> for AssetId<A>

where A: Asset,

type Error = UntypedAssetIdConversionError

The type returned in the event of a conversion error.

fn try_from( value: UntypedAssetId, ) -> Result<AssetId<A>, <AssetId<A> as TryFrom<UntypedAssetId>>::Error>

Performs the conversion.

impl<A> TypePath for AssetId<A>

where A: Asset + TypePath, AssetId<A>: 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<A> Typed for AssetId<A>

where A: Asset + TypePath, AssetId<A>: Any + Send + Sync,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.