Struct Scene 

pub struct Scene<P, I, L> { /* private fields */ }

A scene describes all the Entities to visualize. It consists of two Layers that are supposed to be composited on top of each other. The bottom Layer changes infrequently and doesn’t need to be rerendered for most frames. The top Layer contains all the per frame changes and needs to be rerendered for every frame. If however it is empty and both the bottom layer didn’t change, then no new frame needs to be rendered. While the top Layer is inherently transparent, the bottom Layer has a background that needs to be considered.

Implementations

impl<P: SharedOwnership, I: SharedOwnership, L: SharedOwnership> Scene<P, I, L>

pub fn new(rectangle: Handle<P>) -> Self

Creates a new scene with the rectangle provided to use for placing rectangle entities.

pub const fn background(&self) -> &Option<FillShader>

Get a reference to the bottom Layer's background. While the top Layer is inherently transparent, the bottom Layer has a background that needs to be considered.

pub const fn bottom_layer_changed(&self) -> bool

Check if the scene’s bottom Layer changed. Use this method to check if the bottom Layer needs to be rerendered. If the background of the bottom Layer changes this also returns true, so the background doesn’t need to manually be compared.

pub fn bottom_layer(&self) -> &[Entity<P, I, L>]

Get a reference to the scene’s bottom Layer. This Layer is intended to infrequently change, so it doesn’t need to be rerendered every frame.

pub fn top_layer(&self) -> &[Entity<P, I, L>]

Get a reference to the scene’s top Layer.

pub fn rectangle(&self) -> Handle<P>

Get access to the rectangle resource the scene stores.

pub fn set_background(&mut self, background: Option<FillShader>)

Set the bottom Layer's background.

pub fn bottom_layer_mut(&mut self) -> &mut Vec<Entity<P, I, L>>

Get a mutable reference to the scene’s bottom Layer.

pub fn top_layer_mut(&mut self) -> &mut Vec<Entity<P, I, L>>

Get a mutable reference to the scene’s top Layer.

pub fn clear(&mut self)

Clears all the Layers such that no Entities are left.

pub fn recalculate_if_bottom_layer_changed(&mut self)

Recalculates the hash of the bottom Layer and checks if it changed. The bottom Layer is intended to infrequently change, such that it doesn’t need to be rerendered all the time.

pub fn layer_mut(&mut self, layer: Layer) -> &mut Vec<Entity<P, I, L>>

Accesses the Layer specified mutably.