Struct gooey::Recorder

pub struct Recorder<'a> { /* fields omitted */ }

An easy-to-use,offscreen animation recorder.

Implementations

impl<'a> Recorder<'a>

pub async fn render_frame(
    &mut self,
    duration: Duration
) -> Result<(), HeadlessError>

Renders the current state of the application and displays it for duration.

Errors

Returns any error that occurs while rendering.

pub fn simulate_event(&mut self, event: WindowEvent)

Simulates event in the application.

pub fn pause(&mut self, duration: Duration)

Extends the last frame to display for an additional duration.

Panics

Panics if no frames have been rendered.

pub async fn move_cursor_to(
    &mut self,
    location: impl Into<Point<f32, Scaled>>,
    duration: Duration
) -> Result<(), HeadlessError>

Moves the cursor from the current location (or -16,-16 if no current location) to location. The animation is performed over duration using the recorder’s framerate.

Errors

Returns any error that occurs while rendering.

pub async fn left_click(&mut self) -> Result<(), HeadlessError>

Simulates a left click at the current cursor location.

Errors

Returns any error that occurs while rendering.

pub async fn press_key(
    &mut self,
    key: VirtualKeyCode,
    modifiers: impl Into<Option<ModifiersState>>
) -> Result<(), HeadlessError>

Simulates a typing a key once.

Errors

Returns any error that occurs while rendering.

pub fn save_apng<P: AsRef<Path>>(&self, path: P) -> Result<(), HeadlessError>

Saves the current frames to path as an animated png.

Errors

Can error from io or png encoding errors.

pub fn save_webm<P: AsRef<Path>>(&self, path: P) -> Result<(), HeadlessError>

Saves the current frames to path as an mp4. Requires the ffmpeg executable in the path.

Errors

Can error from io or png encoding errors or from ffmpeg itself.

Panics

Panics if ffmpeg errors and the output cannot be interpreted as utf8.

Methods from Deref<Target = Headless<Rasterizer<Kludgine>>>

pub fn map_root_widget<W: Widget, Output, F: FnOnce(&mut W, Context<W>) -> Output>(
    &self,
    callback: F
) -> Option<Output>

Looks up the root widget of the frontend and invokes callback with the widget and a context that can be used to interact with it. The result will be returned.

pub fn simulate_event(&mut self, event: WindowEvent) -> EventResult

Process an event. Only supported with a rasterizer frontend.

pub fn set_cursor(&mut self, position: impl Into<Point<f32, Scaled>>)

Sets the location of the cursor to position. Does not render any frames.

pub fn left_click(&mut self)

Simulates a left click at the current cursor location.

pub async fn screenshot(
    &self,
    size: Size<u32, Pixels>,
    theme: SystemTheme,
    cursor: Option<Point<f32, Scaled>>
) -> Result<DynamicImage, HeadlessError>

Captures a screenshot with the size and theme provided.

Panics

Panics if no wgpu adapter can be initialized.

Errors

Returns any errors that arise during the rendering process.

pub fn begin_recording(
    &mut self,
    size: Size<u32, Pixels>,
    theme: SystemTheme,
    render_cursor: bool,
    fps: u16
) -> Recorder<'_>

Begins a recording session that generates an animation.

Trait Implementations

impl<'a> Deref for Recorder<'a>

type Target = Headless<Rasterizer<Kludgine>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for Recorder<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.