Struct rendy_command::Encoder

pub struct Encoder<'a, B: Backend, C, L> { /* fields omitted */ }

Trait to encode commands outside render pass.

Methods

impl<'a, B, C> Encoder<'a, B, C, PrimaryLevel> where
    B: Backend, 

pub fn begin_render_pass_inline(
    &mut self,
    render_pass: &B::RenderPass,
    framebuffer: &B::Framebuffer,
    render_area: Rect,
    clear_values: &[ClearValueRaw]
) -> RenderPassInlineEncoder<B> where
    C: Supports<Graphics>, 

Beging recording render pass inline.

pub fn begin_render_pass_secondary(
    &mut self,
    render_pass: &B::RenderPass,
    framebuffer: &B::Framebuffer,
    render_area: Rect,
    clear_values: &[ClearValueRaw]
) -> RenderPassSecondaryEncoder<B> where
    C: Supports<Graphics>, 

Beging recording render pass secondary.

pub fn execute_commands(
    &mut self,
    submittables: impl IntoIterator<Item = impl Submittable<B, SecondaryLevel>>
)

Execute commands from secondary buffers.

impl<'a, B, C, L> Encoder<'a, B, C, L> where
    B: Backend, 

pub fn level(&self) -> L where
    L: Level, 

Get encoder level.

pub unsafe fn copy_buffer(
    &mut self,
    src: &B::Buffer,
    dst: &B::Buffer,
    regions: impl IntoIterator<Item = BufferCopy>
) where
    C: Supports<Transfer>, 

Copy buffer regions. src and dst can be the same buffer or alias in memory. But regions must not overlap. Otherwise resulting values are undefined.

Safety

The size of the copy region in any regions must not exceed the length of the corresponding buffer.

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdCopyBuffer.html

pub unsafe fn copy_buffer_to_image(
    &mut self,
    src: &B::Buffer,
    dst: &B::Image,
    dst_layout: Layout,
    regions: impl IntoIterator<Item = BufferImageCopy>
) where
    C: Supports<Transfer>, 

Copy buffer region to image subresource range.

Safety

Same as copy_buffer()

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdCopyBufferToImage.html

pub unsafe fn copy_image(
    &mut self,
    src: &B::Image,
    src_layout: Layout,
    dst: &B::Image,
    dst_layout: Layout,
    regions: impl IntoIterator<Item = ImageCopy>
) where
    C: Supports<Transfer>, 

Copy image regions.

Safety

Same as copy_buffer()

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdCopyImage.html

pub unsafe fn blit_image(
    &mut self,
    src: &B::Image,
    src_layout: Layout,
    dst: &B::Image,
    dst_layout: Layout,
    filter: Filter,
    regions: impl IntoIterator<Item = ImageBlit>
) where
    C: Supports<Graphics>, 

Blit image regions, potentially using specified filter when resize is necessary.

Safety

Same as copy_buffer()

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdBlitImage.html

pub unsafe fn dispatch(&mut self, x: u32, y: u32, z: u32) where
    C: Supports<Compute>, 

Dispatch compute.

Safety

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdDispatch.html

pub unsafe fn dispatch_indirect(&mut self, buffer: &B::Buffer, offset: u64) where
    C: Supports<Compute>, 

Dispatch indirect. Similar to dispatch except takes vertices and indices from buffer at specified offset. buffer must contain DispatchCommand at offset.

Safety

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdDispatchIndirect.html

Methods from Deref<Target = EncoderCommon<'a, B, C>>

pub unsafe fn bind_index_buffer<'b>(
    &mut self,
    buffer: &'b B::Buffer,
    offset: u64,
    index_type: IndexType
) where
    C: Supports<Graphics>, 

Bind index buffer. Last bound index buffer is used in draw_indexed command.

Note that draw* commands available only inside renderpass.

Safety

offset must not be greater than the size of buffer. Sum of offset and starting address of the buffer must be multiple of index size indicated by index_type.

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdBindIndexBuffer.html

pub unsafe fn bind_vertex_buffers<'b>(
    &mut self,
    first_binding: u32,
    buffers: impl IntoIterator<Item = (&'b B::Buffer, u64)>
) where
    C: Supports<Graphics>, 

Bind vertex buffers. Last bound vertex buffer is used in draw and draw_indexed commands.

Note that draw* commands available only inside renderpass.

Safety

first_binding + buffers.into_iter().count() must less than or equal to the maxVertexInputBindings device limit.

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdBindVertexBuffers.html

pub fn bind_graphics_pipeline(&mut self, pipeline: &B::GraphicsPipeline) where
    C: Supports<Graphics>, 

Bind graphics pipeline.

Last bound vertex buffer is used in [draw], [draw_indexed], draw_indirect and draw_indexed_indirect commands.

pub unsafe fn bind_graphics_descriptor_sets<'b>(
    &mut self,
    layout: &B::PipelineLayout,
    first_set: u32,
    sets: impl IntoIterator<Item = &'b B::DescriptorSet>,
    offsets: impl IntoIterator<Item = u32>
) where
    C: Supports<Graphics>, 

Bind descriptor sets to graphics pipeline.

Safety

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdBindDescriptorSets.html

pub fn bind_compute_pipeline(&mut self, pipeline: &B::ComputePipeline) where
    C: Supports<Compute>, 

Bind compute pipeline.

pub unsafe fn bind_compute_descriptor_sets<'b>(
    &mut self,
    layout: &B::PipelineLayout,
    first_set: u32,
    sets: impl IntoIterator<Item = &'b B::DescriptorSet>,
    offsets: impl IntoIterator<Item = u32>
) where
    C: Supports<Compute>, 

Bind descriptor sets to compute pipeline.

Safety

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdBindDescriptorSets.html

pub unsafe fn pipeline_barrier<'b>(
    &mut self,
    stages: Range<PipelineStage>,
    dependencies: Dependencies,
    barriers: impl IntoIterator<Item = Barrier<'b, B>>
)

Insert pipeline barrier.

Safety

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdPipelineBarrier.html

pub unsafe fn push_constants<'b>(
    &mut self,
    layout: &B::PipelineLayout,
    stages: ShaderStageFlags,
    offset: u32,
    constants: &[u32]
)

Push graphics constants.

Safety

offset must be multiple of 4. constants.len() + offset, must be less than or equal to the maxPushConstantsSize device limit.

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdPushConstants.html

pub unsafe fn set_scissors<'b>(
    &mut self,
    first_scissor: u32,
    rects: impl IntoIterator<Item = &'b Rect>
) where
    C: Supports<Graphics>, 

Set scissors

Safety

first_scissor + rects.count() must be less than the maxViewports device limit.

See: https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/vkCmdSetScissor.html

pub fn reborrow<K>(&mut self) -> EncoderCommon<B, K> where
    C: Supports<K>, 

Reborrow encoder.

Trait Implementations

impl<'a, B: Debug + Backend, C: Debug, L: Debug> Debug for Encoder<'a, B, C, L>

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

Formats the value using the given formatter.

impl<'a, B, C, L> Deref for Encoder<'a, B, C, L> where
    B: Backend, 

type Target = EncoderCommon<'a, B, C>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, B, C, L> DerefMut for Encoder<'a, B, C, L> where
    B: Backend, 

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

Mutably dereferences the value.