Crate bevy_capture

bevy_capture

A Bevy plugin for capturing frames from a Bevy application. It comes with some built-in encoders, e.g. for creating gifs or videos, and can be easily extended with custom encoders.

Current Limitations

• Only headless rendering is supported, but windowed rendering should be possible as well. PRs are welcome!
• There isn’t a built-in method to determine when everything is ready (such as assets loaded and pipelines built). The best approach is to wait a few frames before starting the capture.

Built-in Encoders

Name	Description	Required Features
FramesEncoder	Encodes frames into individual images.
GifEncoder	Encodes frames into a gif.	gif
Mp4Openh264Encoder*⚠️	Encodes frames into an mp4 using openh264.	mp4_openh264
Mp4FfmpegCliEncoder	Encodes frames into an mp4 using the ffmpeg CLI (ffmpeg must be in PATH).	mp4_ffmpeg_cli

*⚠️ The Mp4Openh264Encoder is incomplete and does not work properly yet. PRs are welcome!

Usage

For a complete example, see the simple example.

// Add plugins
app.add_plugins((
    // Disable the WinitPlugin to prevent the creation of a window
    DefaultPlugins.build().disable::<WinitPlugin>(),
    // Add the ScheduleRunnerPlugin to run the app in loop mode
    ScheduleRunnerPlugin {
        run_mode: RunMode::Loop { wait: None },
    },
    // Add the CapturePlugin
    bevy_capture::CapturePlugin,
));

// Spawn a camera with the CaptureBundle
fn setup(mut commands: Commands, mut images: ResMut<Assets<Image>>) {
  commands.spawn((
      Camera2dBundle::default().target_headless(512, 512, &mut images),
      CaptureBundle::default(),
  ));
}

// Start capturing
fn update(mut capture: Query<&mut Capture>) {
  let mut capture = capture.single_mut();
  if !capture.is_capturing() {
    capture.start(
      GifEncoder::new(File::create("my_capture.gif").unwrap())
        .with_repeat(gif::Repeat::Infinite)
    );
  }
}

Implementing a Custom Encoder

struct MyCustomEncoder;

impl Encoder for MyCustomEncoder {
    fn encode(&mut self, image: &Image) -> Result<()> {
        // Called for each frame.
        todo!("Encode the image into your custom format.")
    }

    fn finish(self: Box<Self>) {
      // Called when the encoder is stopped.
      todo!("Finish encoding the frames, if necessary.")
    }
}

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE-2.0 or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Modules

• encoder
  Encoders for different formats.

Structs

• Capture
  The capture component.
• CaptureBundle
  Bundle for the capture plugin. This is usually attached to a camera.
• CapturePlugin
  A Bevy plugin for capturing frames.

Enums

• CaptureSource
  The source of the capture.

Traits

• CameraTargetHeadless
  Extension trait for the camera to set the target to a headless image. This is implemented for Camera, Camera2dBundle, and Camera3dBundle.
• Encoder
  An encoder that encodes a sequence of images into a custom format.
• IntoEncoders
  Convert a value into a sequence of encoders.