Struct vello::Recording

pub struct Recording {
    pub commands: Vec<Command>,
}

List of Commands for an engine to execute in order.

Fields

commands: Vec<Command>

Implementations

impl Recording

pub fn push(&mut self, cmd: Command)

Appends a Command to the back of the Recording.

pub fn upload( &mut self, name: &'static str, data: impl Into<Vec<u8>> ) -> BufferProxy

Commands to upload the given data to a new buffer with the given name. Returns a BufferProxy to the buffer.

pub fn upload_uniform( &mut self, name: &'static str, data: impl Into<Vec<u8>> ) -> BufferProxy

Commands to upload the given data to a new buffer as a uniform with the given name. Returns a BufferProxy to the buffer.

pub fn upload_image( &mut self, width: u32, height: u32, format: ImageFormat, data: impl Into<Vec<u8>> ) -> ImageProxy

Commands to upload the given data to a new image with the given dimensions and format. Returns an ImageProxy to the buffer.

pub fn write_image( &mut self, image: ImageProxy, x: u32, y: u32, width: u32, height: u32, data: impl Into<Vec<u8>> )

pub fn dispatch<R>( &mut self, shader: ShaderId, wg_size: (u32, u32, u32), resources: R )

where R: IntoIterator, R::Item: Into<ResourceProxy>,

pub fn dispatch_indirect<R>( &mut self, shader: ShaderId, buf: BufferProxy, offset: u64, resources: R )

where R: IntoIterator, R::Item: Into<ResourceProxy>,

Do an indirect dispatch.

Dispatch a compute shader where the size is determined dynamically. The buf argument contains the dispatch size, 3 u32 values beginning at the given byte offset.

pub fn download(&mut self, buf: BufferProxy)

Prepare a buffer for downloading.

Currently this copies to a download buffer. The original buffer can be freed immediately after.

pub fn clear_all(&mut self, buf: BufferProxy)

Commands to clear the whole buffer.

pub fn free_buffer(&mut self, buf: BufferProxy)

Commands to free the given buffer.

pub fn free_image(&mut self, image: ImageProxy)

Commands to free the given image.

pub fn free_resource(&mut self, resource: ResourceProxy)

Commands to free the given resource.

pub fn into_commands(self) -> Vec<Command>

Returns a Vec containing all the Commands in order.

Trait Implementations

impl Default for Recording

fn default() -> Recording

Returns the “default value” for a type.