Struct sierra::Encoder

pub struct Encoder<'a> { /* fields omitted */ }

Command encoder that can encode commands outside render pass.

Implementations

impl<'a> Encoder<'a>

pub fn with_render_pass(
    &mut self,
    pass: &'a RenderPass,
    framebuffer: &'a Framebuffer,
    clears: &'a [ClearValue]
) -> RenderPassEncoder<'_, 'a>

Begins render pass and returns RenderPassEncoder to encode commands of the render pass. RenderPassEncoder borrows Encoder. To continue use this Encoder returned RenderPassEncoder must be dropped which implicitly ends render pass.

pass - render pass to encode. framebuffer - a framebuffer (set of attachments) for render pass to use. clears - an array of clear values. render pass will clear attachments with load_op == AttachmentLoadOp::Clear using those values. they will be used in order.

pub fn update_buffer<T>(
    &mut self,
    buffer: &'a Buffer,
    offset: u64,
    data: &'a [T]
) where
    T: Pod, 

Updates a buffer’s contents from host memory

pub fn build_acceleration_structure(
    &mut self,
    infos: &'a [AccelerationStructureBuildGeometryInfo<'a>]
)

Builds acceleration structures.

pub fn trace_rays(
    &mut self,
    shader_binding_table: &'a ShaderBindingTable,
    extent: Extent3d
)

pub fn copy_buffer(
    &mut self,
    src_buffer: &'a Buffer,
    dst_buffer: &'a Buffer,
    regions: &'a [BufferCopy]
)

pub fn copy_image(
    &mut self,
    src_image: &'a Image,
    src_layout: Layout,
    dst_image: &'a Image,
    dst_layout: Layout,
    regions: &'a [ImageCopy]
)

pub fn copy_buffer_to_image(
    &mut self,
    src_buffer: &'a Buffer,
    dst_image: &'a Image,
    dst_layout: Layout,
    regions: &'a [BufferImageCopy]
)

pub fn blit_image(
    &mut self,
    src_image: &'a Image,
    src_layout: Layout,
    dst_image: &'a Image,
    dst_layout: Layout,
    regions: &'a [ImageBlit],
    filter: Filter
)

pub fn dispatch(&mut self, x: u32, y: u32, z: u32)

pub fn finish(self) -> CommandBuffer

Flushes commands recorded into this encoder to the underlying command buffer.

Methods from Deref<Target = EncoderCommon<'a>>

pub fn set_viewport(&mut self, viewport: Viewport)

pub fn set_scissor(&mut self, scissor: Rect2d)

pub fn bind_graphics_pipeline(&mut self, pipeline: &'a GraphicsPipeline)

pub fn bind_compute_pipeline(&mut self, pipeline: &'a ComputePipeline)

pub fn bind_ray_tracing_pipeline(&mut self, pipeline: &'a RayTracingPipeline)

pub fn bind_vertex_buffers(&mut self, first: u32, buffers: &'a [(Buffer, u64)])

pub fn bind_index_buffer(
    &mut self,
    buffer: &'a Buffer,
    offset: u64,
    index_type: IndexType
)

pub fn bind_graphics_descriptor_sets(
    &mut self,
    layout: &'a PipelineLayout,
    first_set: u32,
    sets: &'a [DescriptorSet],
    dynamic_offsets: &'a [u32]
)

pub fn bind_compute_descriptor_sets(
    &mut self,
    layout: &'a PipelineLayout,
    first_set: u32,
    sets: &'a [DescriptorSet],
    dynamic_offsets: &'a [u32]
)

pub fn bind_ray_tracing_descriptor_sets(
    &mut self,
    layout: &'a PipelineLayout,
    first_set: u32,
    sets: &'a [DescriptorSet],
    dynamic_offsets: &'a [u32]
)

pub fn memory_barrier(
    &mut self,
    src: PipelineStageFlags,
    src_acc: AccessFlags,
    dst: PipelineStageFlags,
    dst_acc: AccessFlags
)

pub fn image_barriers(
    &mut self,
    src: PipelineStageFlags,
    dst: PipelineStageFlags,
    images: &'a [ImageMemoryBarrier<'a>]
)

pub fn push_constants<T>(
    &mut self,
    layout: &'a PipelineLayout,
    stages: ShaderStageFlags,
    offset: u32,
    data: &'a [T]
) where
    T: Pod, 

Trait Implementations

impl<'a> Debug for Encoder<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Deref for Encoder<'a>

type Target = EncoderCommon<'a>

The resulting type after dereferencing.

fn deref(&self) -> &EncoderCommon<'a>

Dereferences the value.

impl<'a> DerefMut for Encoder<'a>

fn deref_mut(&mut self) -> &mut EncoderCommon<'a>

Mutably dereferences the value.