Struct vulkano::command_buffer::pool::UnsafeCommandPool
source · pub struct UnsafeCommandPool { /* private fields */ }
Expand description
Low-level implementation of a command pool.
A command pool is always tied to a specific queue family. Command buffers allocated from a pool can only be executed on the corresponding queue family.
This struct doesn’t implement the Sync
trait because Vulkan command pools are not thread
safe. In other words, you can only use a pool from one thread at a time.
Implementations
sourceimpl UnsafeCommandPool
impl UnsafeCommandPool
sourcepub fn new(
device: Arc<Device>,
queue_family: QueueFamily<'_>,
transient: bool,
reset_cb: bool
) -> Result<UnsafeCommandPool, OomError>
pub fn new(
device: Arc<Device>,
queue_family: QueueFamily<'_>,
transient: bool,
reset_cb: bool
) -> Result<UnsafeCommandPool, OomError>
Creates a new pool.
The command buffers created with this pool can only be executed on queues of the given family.
Setting transient
to true is a hint to the implementation that the command buffers will
be short-lived.
Setting reset_cb
to true means that command buffers can be reset individually.
Panic
- Panics if the queue family doesn’t belong to the same physical device as
device
.
sourcepub unsafe fn reset(&self, release_resources: bool) -> Result<(), OomError>
pub unsafe fn reset(&self, release_resources: bool) -> Result<(), OomError>
Resets the pool, which resets all the command buffers that were allocated from it.
If release_resources
is true, it is a hint to the implementation that it should free all
the memory internally allocated for this pool.
Safety
The command buffers allocated from this pool jump to the initial state.
sourcepub fn trim(&self) -> Result<(), CommandPoolTrimError>
pub fn trim(&self) -> Result<(), CommandPoolTrimError>
Trims a command pool, which recycles unused internal memory from the command pool back to the system.
Command buffers allocated from the pool are not affected by trimming.
This function is supported only if the VK_KHR_maintenance1
extension was enabled at
device creation. Otherwise an error is returned.
Since this operation is purely an optimization it is legitimate to call this function and
simply ignore any possible error.
sourcepub fn alloc_command_buffers(
&self,
secondary: bool,
count: usize
) -> Result<UnsafeCommandPoolAllocIter, OomError>
pub fn alloc_command_buffers(
&self,
secondary: bool,
count: usize
) -> Result<UnsafeCommandPoolAllocIter, OomError>
Allocates count
command buffers.
If secondary
is true, allocates secondary command buffers. Otherwise, allocates primary
command buffers.
sourcepub unsafe fn free_command_buffers<I>(&self, command_buffers: I)where
I: Iterator<Item = UnsafeCommandPoolAlloc>,
pub unsafe fn free_command_buffers<I>(&self, command_buffers: I)where
I: Iterator<Item = UnsafeCommandPoolAlloc>,
Frees individual command buffers.
Safety
The command buffers must have been allocated from this pool. They must not be in use.
sourcepub fn queue_family(&self) -> QueueFamily<'_>
pub fn queue_family(&self) -> QueueFamily<'_>
Returns the queue family on which command buffers of this pool can be executed.
Trait Implementations
sourceimpl Debug for UnsafeCommandPool
impl Debug for UnsafeCommandPool
sourceimpl DeviceOwned for UnsafeCommandPool
impl DeviceOwned for UnsafeCommandPool
sourceimpl Drop for UnsafeCommandPool
impl Drop for UnsafeCommandPool
sourceimpl VulkanObject for UnsafeCommandPool
impl VulkanObject for UnsafeCommandPool
sourceconst TYPE: DebugReportObjectTypeEXT = 25u32
const TYPE: DebugReportObjectTypeEXT = 25u32
DebugReportObjectTypeEXT
of the internal Vulkan handle.