Struct CommandBuffer 

pub struct CommandBuffer {
    pub device: Device,
    pub handle: CommandBuffer,
    pub info: CommandBufferInfo,
    /* private fields */
}

Represents a Vulkan command buffer allocation.

See VkCommandBuffer.

Fields

device: Device

The device which owns this command buffer resource.

Note: This field is read-only.

handle: CommandBuffer

The native Vulkan resource handle of this command buffer.

Note: This field is read-only.

info: CommandBufferInfo

Information used to create this object.

Implementations

impl CommandBuffer

pub fn begin( &self, info: &CommandBufferBeginInfo<'_>, ) -> Result<(), DriverError>

Begins recording this command buffer.

This is a thin wrapper around ash::Device::begin_command_buffer that maps Vulkan errors to DriverError variants.

See vkBeginCommandBuffer.

pub fn create( device: &Device, info: impl Into<CommandBufferInfo>, ) -> Result<Self, DriverError>

Creates a command buffer allocation backed by a transient resettable command pool.

See vkAllocateCommandBuffers.

pub fn end(&self) -> Result<(), DriverError>

Ends recording this command buffer.

This is a thin wrapper around ash::Device::end_command_buffer that maps Vulkan errors to DriverError variants.

See vkEndCommandBuffer.

pub fn end_render_pass(&self)

Ends recording a render pass.

pub fn queue_submit( &self, queue: Queue, fence: &mut Fence, submits: &[SubmitInfo<'_>], ) -> Result<(), DriverError>

Submits command buffers to a queue using fence.

This method does not begin, end, or reset self or fence. Callers are expected to submit only executable command buffers and to manage fence waits and resets as needed.

Typical handling is:

1. Begin recording with Self::begin.
2. Record commands.
3. End recording with Self::end.
4. Submit this command buffer with queue_submit.
5. Later, check or wait for completion with Fence::status or Fence::wait.
6. Before re-submitting this same command buffer, reset the fence with Fence::reset, then begin recording again.

See vkQueueSubmit.

pub fn queue_submit2( &self, queue: Queue, fence: &mut Fence, submits: &[SubmitInfo2<'_>], ) -> Result<(), DriverError>

Submits command buffers to a queue using vkQueueSubmit2 (Vulkan 1.3 core or VK_KHR_synchronization2).

See vkQueueSubmit2 and VK_KHR_synchronization2.

pub fn set_debug_name(&self, name: impl AsRef<str>)

Sets the debugging name assigned to this command buffer.

pub fn with_debug_name(self, name: impl AsRef<str>) -> Self

Sets the debugging name assigned to this command buffer.

Trait Implementations

impl AsRef<CommandBuffer> for CommandBuffer

fn as_ref(&self) -> &CommandBuffer

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for CommandBuffer

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

Formats the value using the given formatter.

impl Drop for CommandBuffer

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Pool<CommandBufferInfo, CommandBuffer> for FifoPool

fn resource( &mut self, info: CommandBufferInfo, ) -> Result<Lease<CommandBuffer>, DriverError>

Request a resource.

impl Pool<CommandBufferInfo, CommandBuffer> for HashPool

fn resource( &mut self, info: CommandBufferInfo, ) -> Result<Lease<CommandBuffer>, DriverError>

Request a resource.

impl Pool<CommandBufferInfo, CommandBuffer> for LazyPool

fn resource( &mut self, info: CommandBufferInfo, ) -> Result<Lease<CommandBuffer>, DriverError>

Request a resource.