Struct amethyst_rendy::sprite_visibility::SpriteVisibilitySortingSystem

pub struct SpriteVisibilitySortingSystem { /* fields omitted */ }

Determines what entities to be drawn. Will also sort transparent entities back to front based on position on the Z axis.

The sprite render pass should draw all sprites without semi-transparent pixels, then draw the sprites with semi-transparent pixels from far to near.

Note that this should run after Transform has been updated for the current frame, and before rendering occurs.

Methods

impl SpriteVisibilitySortingSystem

pub fn new() -> Self

Returns a new sprite visibility sorting system

Trait Implementations

impl Default for SpriteVisibilitySortingSystem

fn default() -> Self

Returns the "default value" for a type.

impl Debug for SpriteVisibilitySortingSystem

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

Formats the value using the given formatter.

impl<'a> System<'a> for SpriteVisibilitySortingSystem

type SystemData = (Entities<'a>, Write<'a, SpriteVisibility>, ReadStorage<'a, Hidden>, ReadStorage<'a, HiddenPropagate>, Read<'a, ActiveCamera>, ReadStorage<'a, Camera>, ReadStorage<'a, Transparent>, ReadStorage<'a, Transform>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (entities, visibility, hidden, hidden_prop, active, camera, transparent, transform): Self::SystemData
)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the [SystemData].

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.