Skip to main content

ScenePackage

Struct ScenePackage 

Source
pub struct ScenePackage {
    pub recipe: SceneRecipe,
    pub width: u32,
    pub height: u32,
    pub generator_version: u32,
    /* private fields */
}
Expand description

A frozen scene: plays without the generator.

Fields§

§recipe: SceneRecipe§width: u32§height: u32§generator_version: u32

The generator that made it (for information; playback ignores it).

Implementations§

Source§

impl ScenePackage

Source

pub fn capture( recipe: &SceneRecipe, width: u32, height: u32, ) -> Result<Self, BuildError>

Builds the scene in every theme it supports and freezes the result.

Source

pub fn capture_with( recipe: &SceneRecipe, width: u32, height: u32, catalog: &Catalog, character: &dyn Character, ) -> Result<Self, BuildError>

capture with another activity catalog and character (the developer preview loads both from disk).

Source

pub fn themes(&self) -> Vec<Theme>

Themes this scene has, dark first.

Source

pub fn hero_ms(&self, theme: Theme) -> Option<u64>

The still-frame time in a theme.

Source

pub fn frame( &self, theme: Theme, buddy: bool, t_ms: u64, clock: Clock, ) -> Option<(IndexedImage, &IndexedPalette)>

One frame, or None if the scene has no such theme.

Source

pub fn incremental(&self, theme: Theme) -> Option<IncrementalFrame>

A frame to play the scene live, starting from the bare background; move it with ScenePackage::advance.

Source

pub fn advance( &self, frame: &mut IncrementalFrame, theme: Theme, buddy: bool, t_ms: u64, clock: Clock, ) -> Option<Vec<PixelRect>>

Moves a live frame to t_ms and returns the rectangles that changed; the frame then equals ScenePackage::frame at that time.

Source

pub fn still( &self, theme: Theme, buddy: bool, ) -> Option<(IndexedImage, &IndexedPalette)>

The still (hero) frame in a theme.

Source

pub fn palette(&self, theme: Theme) -> Option<&IndexedPalette>

The palette in a theme.

Source

pub fn graph(&self, theme: Theme) -> Option<&SceneGraph>

The scene graph in a theme (layout, emitters, loop length).

Source

pub fn save(&self, dir: &Path) -> Result<(), PackageError>

Writes the package into dir (created if needed).

Source

pub fn load(dir: &Path) -> Result<Self, PackageError>

Reads a package written by this or an older version.

Trait Implementations§

Source§

impl Clone for ScenePackage

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScenePackage

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more