Struct CommandRecording 

pub struct CommandRecording<'a> { /* private fields */ }

An in-progress command buffer recording, outside of a render pass.

Implementations

impl<'a> CommandRecording<'a>

pub fn fill_buffer( &mut self, dst: &Arc<Buffer>, offset: u64, size: Option<u64>, data: u32, ) -> Result<()>

The reference count of dst is incremented. Offset and size are rounded down to the nearest multiple of 4. Returns Error::OutOfBounds if they are out of bounds. (see vkCmdFillBuffer)

pub fn copy_buffer( &mut self, src: &Arc<Buffer>, dst: &Arc<Buffer>, regions: &[BufferCopy], ) -> Result<()>

The reference counts of src and dst are incremented. Returns Error::OutOfBounds if a region is out of bounds. (see vkCmdCopyBuffer)

pub fn copy_buffer_to_image( &mut self, src: &Arc<Buffer>, dst: &Arc<Image>, dst_layout: ImageLayout, regions: &[BufferImageCopy], ) -> Result<()>

The reference counts of src and dst are incremented. Returns Error::OutOfBounds if a region is out of bounds. Returns Error::InvalidArgument if regions is empty. (see vkCmdCopyBufferToImage)

pub fn blit_image( &mut self, src: &Arc<Image>, src_layout: ImageLayout, dst: &Arc<Image>, dst_layout: ImageLayout, regions: &[ImageBlit], filter: Filter, ) -> Result<()>

The reference counts of src and dst are incremented. Returns Error::OutOfBounds if a region is out of bounds. Returns Error::InvalidArgument if regions is empty. (see vkCmdBlitImage)

pub fn clear_color_image( &mut self, image: &Arc<Image>, layout: ImageLayout, color: ClearColorValue, ranges: &[ImageSubresourceRange], ) -> Result<()>

The reference count of image is incremented. Returns Error::InvalidArgument if ranges is empty. (see vkCmdClearColorImage)

impl<'a> CommandRecording<'a>

pub fn pipeline_barrier( &mut self, src_stage_mask: PipelineStageFlags, dst_stage_mask: PipelineStageFlags, dependency_flags: DependencyFlags, memory_barriers: &[MemoryBarrier], buffer_memory_barriers: &[BufferMemoryBarrier<'_>], image_memory_barriers: &[ImageMemoryBarrier<'_>], )

(see vkCmdPipelineBarrier)

pub fn memory_barrier( &mut self, src_stage_mask: PipelineStageFlags, dst_stage_mask: PipelineStageFlags, src_access_mask: AccessFlags, dst_access_mask: AccessFlags, )

A shortcut for simple memory barriers. (see vkCmdPipelineBarrier)

pub fn image_barrier( &mut self, image: &Arc<Image>, src_stage_mask: PipelineStageFlags, dst_stage_mask: PipelineStageFlags, src_access_mask: AccessFlags, dst_access_mask: AccessFlags, old_layout: ImageLayout, new_layout: ImageLayout, )

A shortcut for simple image barriers. (see vkCmdPipelineBarrier)

impl<'a> CommandRecording<'a>

pub fn bind_pipeline(&mut self, pipeline: &Arc<Pipeline>)

Binds the pipeline to the appropriate bind point. The reference count of pipeline is incremented. (see vkCmdBindPipeline)

impl<'a> CommandRecording<'a>

pub fn bind_vertex_buffers( &mut self, first_binding: u32, buffers_offsets: &[(&Arc<Buffer>, u64)], ) -> Result<()>

Reference counts of buffers are incremented. Returns Error::InvalidArgument if buffers_offsets is empty or the buffer usage flags don’t include VERTEX_BUFFER. (see vkCmdBindVertexBuffers)

pub fn bind_index_buffer( &mut self, buffer: &Arc<Buffer>, offset: u64, index_type: IndexType, ) -> Result<()>

Reference count of buffer is incremented. Returns Error::InvalidArgument if buffer does not have the INDEX_BUFFER usage flag. (see vkCmdBindIndexBuffer)

impl<'a> CommandRecording<'a>

pub fn bind_descriptor_sets( &mut self, pipeline_bind_point: PipelineBindPoint, layout: &PipelineLayout, first_set: u32, sets: &[&Arc<DescriptorSet>], dynamic_offsets: &[u32], ) -> Result<()>

Returns Error::InvalidArgument if a member of sets is not compatible with the corresponding member of layout, if the length of dynamic_offsets is not correct for layout, or if any binding in any of sets is not initialized.

If the value of the binding will not be used, create a dummy object of the appropriate type and bind it.

The reference count of each member of sets is incremented.

(see vkCmdBindDescriptorSets)

impl<'a> CommandRecording<'a>

pub fn push_constants( &mut self, layout: &PipelineLayout, stage_flags: ShaderStageFlags, offset: u32, data: &[u8], ) -> Result<()>

Sets push constants. Returns Error::OutOfBounds if the data is out of bounds for push contants in layout or if stage_flags is incorrect. Returns Error::InvalidArgument if data is empty. (see vkCmdPushConstants)

impl<'a> CommandRecording<'a>

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

(see vkCmdSetViewport)

impl<'a> CommandRecording<'a>

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

(see vkCmdSetScissor)

impl<'a> CommandRecording<'a>

pub fn dispatch( &mut self, group_count_x: u32, group_count_y: u32, group_count_z: u32, ) -> Result<()>

(see vkCmdDispatch)

pub fn dispatch_indirect( &mut self, buffer: &Arc<Buffer>, offset: u64, ) -> Result<()>

(see vkCmdDispatchIndirect)

impl<'a> CommandRecording<'a>

pub fn end(self) -> Result<CommandBuffer>

A failed call to vkEndCommandBuffer leaves the buffer in the invalid state, so it is dropped in that case. (see vkEndCommandBuffer)

impl<'a> CommandRecording<'a>

pub fn begin_render_pass( self, render_pass: &Arc<RenderPass>, framebuffer: &Arc<Framebuffer>, render_area: &Rect2D, clear_values: &[ClearValue], ) -> Result<RenderPassRecording<'a>>

Begins a render pass recorded inline. Returns Error::InvalidArgument if framebuffer and render_pass are not compatible. (see vkCmdBeginRenderPass)

pub fn begin_render_pass_secondary( self, render_pass: &Arc<RenderPass>, framebuffer: &Arc<Framebuffer>, render_area: &Rect2D, clear_values: &[ClearValue], ) -> Result<ExternalRenderPassRecording<'a>>

Begins a render pass recorded in secondary command buffers. Returns Error::InvalidArgument if framebuffer and render_pass are not compatible. (see vkCmdBeginRenderPass)