Struct bevy::render::view::window::screenshot::ScreenshotManager

pub struct ScreenshotManager { /* private fields */ }

A resource which allows for taking screenshots of the window.

Implementations

impl ScreenshotManager

pub fn take_screenshot( &mut self, window: Entity, callback: impl FnOnce(Image) + Send + Sync + 'static ) -> Result<(), ScreenshotAlreadyRequestedError>

Signals the renderer to take a screenshot of this frame.

The given callback will eventually be called on one of the AsyncComputeTaskPools threads.

pub fn save_screenshot_to_disk( &mut self, window: Entity, path: impl AsRef<Path> ) -> Result<(), ScreenshotAlreadyRequestedError>

Signals the renderer to take a screenshot of this frame.

The screenshot will eventually be saved to the given path, and the format will be derived from the extension.

Examples found in repository

examples/window/screenshot.rs (line 25)

fn screenshot_on_spacebar(
    input: Res<ButtonInput<KeyCode>>,
    main_window: Query<Entity, With<PrimaryWindow>>,
    mut screenshot_manager: ResMut<ScreenshotManager>,
    mut counter: Local<u32>,
) {
    if input.just_pressed(KeyCode::Space) {
        let path = format!("./screenshot-{}.png", *counter);
        *counter += 1;
        screenshot_manager
            .save_screenshot_to_disk(main_window.single(), path)
            .unwrap();
    }
}

Trait Implementations

impl Default for ScreenshotManager

fn default() -> ScreenshotManager

Returns the “default value” for a type.

impl Resource for ScreenshotManager

where ScreenshotManager: Send + Sync + 'static,