Enum SpriteSourceOutput 

pub enum SpriteSourceOutput {
    Texture {
        sprite: Identifier,
        texture: Identifier,
    },
    Pixels {
        sprite: Identifier,
        width: u32,
        height: u32,
        rgba: Vec<u8>,
    },
    Remove {
        sprite: Identifier,
    },
}

One step a mod’s sprite source takes on the atlas it is listed in, as vanilla’s SpriteSource.Output takes them. Hooks::sprite_source pushes them in order, and they apply under the built-in sources’ rule: a sprite of an id listed already replaces the earlier one.

Variants

Texture

add(Identifier, Resource): sprite sprite is the texture texture (assets/<namespace>/textures/<path>.png), with its .mcmeta. A texture the resources lack is logged and skipped.

Fields

sprite: Identifier

The sprite’s id in the atlas (mymod:gem).

texture: Identifier

The texture it is (mymod:item/gem).

Pixels

add(Identifier, DiscardableLoader): sprite sprite is these pixels, width by height, rows top first, four bytes (red, green, blue, alpha) a pixel. Pixels whose length isn’t width * height * 4, or a side over the largest a sprite can have, are logged and skipped.

Fields

sprite: Identifier

The sprite’s id in the atlas.

width: u32

Its width in pixels.

height: u32

Its height in pixels.

rgba: Vec<u8>

Its RGBA bytes.

Remove

removeAll: drops sprite sprite from what the sources before listed, read in the event’s listed. An id not listed changes nothing.

Fields

sprite: Identifier

The sprite to drop.

Trait Implementations

impl Clone for SpriteSourceOutput

fn clone(&self) -> SpriteSourceOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSourceOutput

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

Formats the value using the given formatter.

impl Eq for SpriteSourceOutput

impl PartialEq for SpriteSourceOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SpriteSourceOutput

impl Wire for SpriteSourceOutput

const MIN: usize = 4usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<SpriteSourceOutput, WireError>

Decodes one value, leaving any following bytes for the caller.