Struct amethyst_rendy::sprite::prefab::SpriteRenderPrefab

pub struct SpriteRenderPrefab {
    pub sheet: Option<SpriteSheetReference>,
    pub sprite_number: usize,
    // some fields omitted
}

Prefab used to add a sprite to an Entity.

This prefab is special in that it will lookup the spritesheet in the resource SpriteSheetLoadedSet by index during loading. Just like with SpriteSheetPrefab this means that this prefab should only be used as part of other prefabs or in specialised formats. Look at SpriteScenePrefab for an example.

Fields

sheet: Option<SpriteSheetReference>

Index of the sprite sheet in the prefab

sprite_number: usize

Index of the sprite on the sprite sheet

Trait Implementations

impl Default for SpriteRenderPrefab

fn default() -> Self

Returns the "default value" for a type.

impl Clone for SpriteRenderPrefab

fn clone(&self) -> SpriteRenderPrefab

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteRenderPrefab

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

Formats the value using the given formatter.

impl Serialize for SpriteRenderPrefab

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SpriteRenderPrefab

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> PrefabData<'a> for SpriteRenderPrefab

type SystemData = (WriteStorage<'a, SpriteRender>, Read<'a, SpriteSheetLoadedSet>)

SystemData needed to perform the load

type Result = ()

The result type returned by the load operation

fn add_to_entity(
    &self,
    entity: Entity,
    system_data: &mut Self::SystemData,
    _entities: &[Entity],
    _children: &[Entity]
) -> Result<(), Error>

Add the data for this prefab onto the given Entity

fn load_sub_assets(
    &mut self,
    _: &mut ProgressCounter,
    system_data: &mut Self::SystemData
) -> Result<bool, Error>

Trigger asset loading for any sub assets.