Struct SceneManager 

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

The scene manager is the main entry point when it comes to writing a renderer for livesplit-core. When provided with a LayoutState, it places Entities into a Scene and updates it accordingly as the LayoutState changes. It is up to a specific renderer to then take the Scene and render out the Entities. There is a ResourceAllocator trait that defines the types of resources an Entity consists of. A specific renderer can then provide an implementation that provides the resources it can render out. Those resources are images, paths, i.e. lines, quadratic and cubic bezier curves, fonts and labels.

Implementations

impl<P: SharedOwnership, I: SharedOwnership, F, L: SharedOwnership> SceneManager<P, I, F, L>

pub fn new( allocator: impl ResourceAllocator<Path = P, Image = I, Font = F, Label = L>, ) -> Self

Creates a new scene manager.

pub const fn scene(&self) -> &Scene<P, I, L>

Accesses the Scene in order to render the Entities.

pub fn update_scene<A: ResourceAllocator<Path = P, Image = I, Font = F, Label = L>>( &mut self, allocator: A, resolution: (f32, f32), state: &LayoutState, ) -> Option<(f32, f32)>

Updates the Scene by updating the Entities according to the LayoutState provided. The ResourceAllocator is used to allocate the resources necessary that the Entities use. A resolution needs to be provided as well so that the Entities are positioned and sized correctly for a renderer to then consume. If a change in the layout size is detected, a new more suitable resolution for subsequent updates is being returned. This is however merely a hint and can be completely ignored.