Struct cushy::window::VirtualRecorder

pub struct VirtualRecorder<Format = Rgb8> {
    pub window: VirtualWindow,
    /* private fields */
}

A recorder of a VirtualWindow.

Fields

window: VirtualWindow

The virtual window being recorded.

Implementations

impl<Format> VirtualRecorder<Format>

where Format: CaptureFormat,

pub fn new( size: Size<UPx>, scale: f32, resize_to_fit: bool, contents: impl MakeWidget, ) -> Result<Self, VirtualRecorderError>

Returns a new virtual recorder that renders contents into a graphic of size.

scale adjusts the default DPI scaling to perform. It does not affect the size.

pub fn bytes(&self) -> &[u8]

Returns the tightly-packed captured bytes.

The layout of this data is determined by the Format generic.

pub fn pixel_color<Unit>(&self, location: Point<Unit>) -> Color

where Unit: Into<UPx>,

Returns the color of the pixel at location.

Panics

This function will panic if location is outside of the bounds of the captured image. When the window’s size has been changed, this function operates on the size of the window when the last call to Self::refresh() was made.

pub fn assert_pixel_color<Unit>( &self, location: Point<Unit>, expected: Color, component: &str, )

where Unit: Into<UPx>,

Asserts that the color of the pixel at location is expected.

This function allows for slight color variations. This is because of how colorspace corrections can lead to rounding errors.

Panics

This function panics if the color is not the expected color.

pub fn image(&self) -> DynamicImage

Returns the current contents as an image.

pub fn refresh(&mut self) -> Result<(), BufferAsyncError>

Redraws the contents.

pub fn set_cursor_position(&self, position: Point<Px>)

Sets the cursor position immediately.

pub fn set_cursor_visible(&mut self, visible: bool)

Enables or disables drawing of the virtual cursor.

pub fn record_animated_png( &mut self, target_fps: u8, ) -> AnimationRecorder<'_, Format>

Begins recording an animated png.

pub fn simulate_animation(&mut self) -> AnimationRecorder<'_, Format>

Returns a recorder that does not store any rendered frames.