Struct FrameOutput 

#[non_exhaustive]
pub struct FrameOutput<'a, V> {
    pub buffer: &'a GlyphBuffer,
    pub quit: bool,
    pub audio: &'a [AudioRequest<V>],
    pub music: &'a [MusicCommand],
    pub music_volume: f32,
    pub sound_volume: f32,
    pub fullscreen: bool,
    pub voice_volume: f32,
    pub frame_cap: FrameCap,
    pub frame_cap_serial: u32,
}

The result of one frame. V is the game’s voice clip variant. Only Game::frame builds one, so a field may come without breaking a game (ADR-0039).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

buffer: &'a GlyphBuffer

What to show.

quit: bool

Whether the game has asked to quit (it then ignores further input).

audio: &'a [AudioRequest<V>]

Every audio request screens made this frame, in order. The platform plays the sounds; the music requests are already turned into music.

music: &'a [MusicCommand]

What to do to the music this frame.

music_volume: f32

The player’s music volume, 0–1: the platform multiplies the music’s own volume by it, also for a track already playing.

sound_volume: f32

The player’s sound volume, 0–1: the platform multiplies every sound’s own volume by it.

fullscreen: bool

Whether the game should fill the screen (the Fullscreen setting); the platform switches when this changes.

voice_volume: f32

How loud voice clips play, 0–1 (Settings::voice_volume). The platform applies it to the voice that is playing too.

frame_cap: FrameCap

The most frames a second to show (the player’s frame cap): the platform paces its frames to it from the next.

frame_cap_serial: u32

The serial of the cap’s latest change (Ctx::frame_cap_serial): the platform reports it back once it has applied the cap (Game::set_pacing).

Trait Implementations

impl<'a, V: Clone> Clone for FrameOutput<'a, V>

fn clone(&self) -> FrameOutput<'a, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, V: Copy> Copy for FrameOutput<'a, V>

impl<'a, V: Debug> Debug for FrameOutput<'a, V>

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

Formats the value using the given formatter.