Trait CommandBufferMut

pub trait CommandBufferMut: CommandBuffer + VkHandleMut {
    // Provided methods
    unsafe fn begin<'d, ExtFnProvider: 'd + ?Sized>(
        &'d mut self,
        info: &CommandBufferBeginInfo<'_>,
        ext_fn_provider: &'d ExtFnProvider,
    ) -> Result<CmdRecord<'d, ExtFnProvider>> { ... }
    unsafe fn reset(&mut self, flags: VkCommandBufferResetFlags) -> Result<()> { ... }
    unsafe fn synchronize_with<'p, 'b: 'p>(
        &'b mut self,
        pool: &'p mut (impl VkHandleMut<Handle = VkCommandPool> + ?Sized),
    ) -> SynchronizedCommandBuffer<'p, 'b> { ... }
}

Provided Methods

unsafe fn begin<'d, ExtFnProvider: 'd + ?Sized>( &'d mut self, info: &CommandBufferBeginInfo<'_>, ext_fn_provider: &'d ExtFnProvider, ) -> Result<CmdRecord<'d, ExtFnProvider>>

Available on crate feature Implements only.

Start recording a command buffer

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

Safety

The CommandPool that this commandBuffer was allocated from must be externally synchronized.

unsafe fn reset(&mut self, flags: VkCommandBufferResetFlags) -> Result<()>

Available on crate feature Implements only.

Reset a command buffer to the initial state

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_DEVICE_MEMORY

Safety

The CommandPool that this commandBuffer was allocated from must be externally synchronized.

unsafe fn synchronize_with<'p, 'b: 'p>( &'b mut self, pool: &'p mut (impl VkHandleMut<Handle = VkCommandPool> + ?Sized), ) -> SynchronizedCommandBuffer<'p, 'b>

Locking CommandBuffer with CommandPool to satisfy externally synchronization restriction.

Safety

This command buffer must be allocated from pool.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'s, T> CommandBufferMut for &'s mut T

where T: CommandBufferMut + ?Sized,

impl<T> CommandBufferMut for Box<T>

where T: CommandBufferMut + ?Sized,

impl<T> CommandBufferMut for RefMut<'_, T>

where T: CommandBufferMut + ?Sized,

impl<T> CommandBufferMut for ManuallyDrop<T>

where T: CommandBufferMut,

impl<T> CommandBufferMut for MutexGuard<'_, T>

where T: CommandBufferMut + ?Sized,

impl<T> CommandBufferMut for RwLockWriteGuard<'_, T>

where T: CommandBufferMut + ?Sized,

impl<T> CommandBufferMut for MutexGuard<'_, T>

where T: CommandBufferMut + ?Sized,

impl<T> CommandBufferMut for RwLockWriteGuard<'_, T>

where T: CommandBufferMut + ?Sized,

Implementors

impl<Device> CommandBufferMut for CommandBufferObject<Device>