Struct CommandPoolObject

pub struct CommandPoolObject<Device: VkHandle<Handle = VkDevice>>(/* private fields */);

Implementations

impl<Device: VkHandle<Handle = VkDevice>> CommandPoolObject<Device>

pub const unsafe fn manage(handle: VkCommandPool, parent: Device) -> Self

Constructs from raw values

Safety

the resource must be created from the device and not freed anywhere

pub const fn unmanage(self) -> (VkCommandPool, Device)

Purges the construct (Drop will not be called for this resource)

impl<Device: VkHandle<Handle = VkDevice> + Clone> CommandPoolObject<&Device>

pub fn clone_parent(self) -> CommandPoolObject<Device>

Owning parent object by cloning it.

impl<Device: Device> CommandPoolObject<Device>

pub fn new(device: Device, info: &CommandPoolCreateInfo) -> Result<Self>

Available on crate feature Implements only.

Create a new command pool object

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

Trait Implementations

impl<Device: Device> CommandPoolMut for CommandPoolObject<Device>

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

Available on crate feature Implements only.

Resets a command pool

unsafe fn free(&mut self, buffers: &[VkHandleRefMut<'_, VkCommandBuffer>])

Available on crate feature Implements only.

Free command buffers

fn trim(&mut self)

Available on crate features Implements and VK_KHR_maintenance1 only.

Trim a command pool

impl<Device: Device> DeviceChild for CommandPoolObject<Device>

type ConcreteDevice = Device

A concrete type of the parent device object.

fn device(&self) -> &Self::ConcreteDevice

Retrieve a reference to a device object that creates this object

impl<Device: VkHandle<Handle = VkDevice>> DeviceChildHandle for CommandPoolObject<Device>

fn device_handle(&self) -> VkDevice

Retrieve a reference to a device handle that creates this objecs

impl<Device: VkHandle<Handle = VkDevice>> Drop for CommandPoolObject<Device>

Available on crate feature Implements only.

fn drop(&mut self)

Executes the destructor for this type.

impl<Device: VkHandle<Handle = VkDevice>> VkHandle for CommandPoolObject<Device>

type Handle = VkCommandPool

fn native_ptr(&self) -> Self::Handle

Retrieve an underlying handle

fn as_transparent_ref(&self) -> VkHandleRef<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>> VkHandleMut for CommandPoolObject<Device>

fn native_ptr_mut(&mut self) -> Self::Handle

Retrieve an underlying mutable handle

fn as_transparent_ref_mut(&mut self) -> VkHandleRefMut<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>> VkObject for CommandPoolObject<Device>

const TYPE: VkObjectType = 25i32

fn set_name(&self, name: Option<&CStr>) -> Result<()>

where Self: DeviceChild<ConcreteDevice: InstanceChild<ConcreteInstance: InstanceExtensions>>, Self::Handle: VkRawHandle,

Available on crate features Implements and VK_EXT_debug_utils only.

Give a user-friendly name to this object.

impl<Device: Device> CommandPool for CommandPoolObject<Device>

impl<Device: VkHandle<Handle = VkDevice> + Send> Send for CommandPoolObject<Device>

impl<Device: VkHandle<Handle = VkDevice> + Sync> Sync for CommandPoolObject<Device>