Struct gooey::Recorder

source · [−]

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

Expand description

An easy-to-use,offscreen animation recorder.

Implementations

source

impl<'a> Recorder<'a>

source

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.

source

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

Simulates event in the application.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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>>>

source

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.

source

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

Process an event. Only supported with a rasterizer frontend.

source

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.

source

pub fn left_click(&mut self)

Simulates a left click at the current cursor location.

source

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.

source

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

source

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

type Target = Headless<Rasterizer<Kludgine>>

The resulting type after dereferencing.

source

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

Dereferences the value.

source

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

source

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

Mutably dereferences the value.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Recorder<'a>

impl<'a> Send for Recorder<'a>

impl<'a> Sync for Recorder<'a>

impl<'a> Unpin for Recorder<'a>

impl<'a> !UnwindSafe for Recorder<'a>

Blanket Implementations

source

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
 T: FloatComponent,
 Swp: WhitePoint,
 Dwp: WhitePoint,
 D: AdaptFrom<S, Swp, Dwp, T>,

source

fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,

Convert the source color to the destination color using the specified method Read more

source

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default Read more

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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, U> IntoColor for T where
U: FromColor<T>,

source

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

source

impl<T, U> IntoColorUnclamped for T where
U: FromColorUnclamped<T>,

source

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryIntoColor for T where
U: TryFromColor<T>,

source

fn try_into_color(self) -> Result<U, OutOfBounds>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

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

Struct gooey::Recorder

Implementations

impl<'a> Recorder<'a>

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

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

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

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

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

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

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

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

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>

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

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

pub fn left_click(&mut self)

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

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

Trait Implementations

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

type Target = Headless<Rasterizer<Kludgine>>

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

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

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

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Recorder<'a>

impl<'a> Send for Recorder<'a>

impl<'a> Sync for Recorder<'a>

impl<'a> Unpin for Recorder<'a>

impl<'a> !UnwindSafe for Recorder<'a>

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where T: FloatComponent, Swp: WhitePoint, Dwp: WhitePoint, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,

fn adapt_into(self) -> D

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T, U> IntoColor<U> for T where U: FromColor<T>,

fn into_color(self) -> U

impl<T, U> IntoColorUnclamped<U> for T where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

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

impl<T, U> TryIntoColor<U> for T where U: TryFromColor<T>,

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: FloatComponent,
Swp: WhitePoint,
Dwp: WhitePoint,
D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,

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

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

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

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

impl<T, U> IntoColor<U> for T where
U: FromColor<T>,

impl<T, U> IntoColorUnclamped<U> for T where
U: FromColorUnclamped<T>,

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

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

impl<T, U> TryIntoColor<U> for T where
U: TryFromColor<T>,

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