Struct RenderWorker 

pub struct RenderWorker {

    ctx: WgpuContext,
    renderer: Renderer,
    render_textures: Vec<RenderTextures>,
    clear_color: Color,
    video_writer: Option<FileWriter>,
    video_writer_builder: Option<FileWriterBuilder>,
    video_path: PathBuf,
    save_frames: bool,
    output_dir: PathBuf,
    scene_name: String,
    width: u32,
    height: u32,
    fps: u32,
}

Available on crate feature render and non-target_family=wasm only.

Background rendering worker that owns the wgpu context, renderer, output textures, and video/image writers.

Fields

ctx: WgpuContext

renderer: Renderer

render_textures: Vec<RenderTextures>

clear_color: Color

video_writer: Option<FileWriter>

video_writer_builder: Option<FileWriterBuilder>

video_path: PathBuf

save_frames: bool

output_dir: PathBuf

scene_name: String

width: u32

height: u32

fps: u32

Implementations

impl RenderWorker

pub fn new( scene_name: String, scene_config: &SceneConfig, output: &Output, buffer_count: usize, ) -> Self

Creates a new RenderWorker.

This checks for or downloads ffmpeg, initializes the wgpu context and renderer, and configures the video writer from Output.

Panics

Panics if buffer_count < 1.

pub fn save_frame_dir(&self) -> PathBuf

Returns the directory path used to save individual frame images.

pub fn video_path(&self) -> &Path

Returns the path of the video file being written.

pub fn finish_video(&mut self)

Finalize the video file: flush the encoder and wait for it to exit.

After this call the file on disk is complete (valid container index) and no further frames can be written.

pub fn yeet(self) -> RenderThreadHandle

Moves this RenderWorker into a newly spawned background thread and returns a RenderThreadHandle.

The background thread loops over incoming RenderFrames, rendering and outputting frames using multi-buffered async readback.

pub fn render_store(&mut self, store: &RenderFrame)

Renders a single frame synchronously on this worker (typically used for captures).

pub fn output_frame_from(&mut self, target_idx: usize, frame_number: u64)

Write and save (if Self::save_frames is true)

pub fn write_frame_from(&mut self, target_idx: usize)

Write frame data from the given target to the video file.

pub fn save_frame_from(&mut self, target_idx: usize, frame_number: u64)

Save frame from the given target as a PNG image.

pub fn capture_frame(&mut self, path: impl AsRef<Path>)

Capture frame to image file (sync path, uses target 0).