Magnum::Vk::CommandPoolCreateInfo class new in Git master
#include <Magnum/Vk/CommandPoolCreateInfo.h>

Command pool creation info.

Wraps a VkCommandPoolCreateInfo. See Command pool creation for usage information.

Public types

enum class Flag: UnsignedInt { Transient = VK_COMMAND_POOL_CREATE_TRANSIENT_BIT, ResetCommandBuffer = VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT }
Command pool creation flag.
using Flags = Containers::EnumSet<Flag>
Command pool creation flags.

Constructors, destructors, conversion operators

CommandPoolCreateInfo(UnsignedInt queueFamilyIndex, Flags flags = {}) explicit
Constructor.
CommandPoolCreateInfo(NoInitT) explicit noexcept
Construct without initializing the contents.
CommandPoolCreateInfo(const VkCommandPoolCreateInfo& info) explicit
Construct from existing data.
operator const VkCommandPoolCreateInfo*() const

Public functions

auto operator*() -> VkCommandPoolCreateInfo&
Underlying VkCommandPoolCreateInfo structure.
auto operator*() const -> const VkCommandPoolCreateInfo&
auto operator->() -> VkCommandPoolCreateInfo*
auto operator->() const -> const VkCommandPoolCreateInfo*

Enum documentation

enum class Magnum::Vk::CommandPoolCreateInfo::Flag: UnsignedInt

Command pool creation flag.

Wraps VkCommandPoolCreateFlagBits.

Enumerators
Transient

Command buffers allocated from this pool will be short-lived
ResetCommandBuffer

Allow individual command buffers to be reset to initial state using CommandBuffer::reset() instead of just the whole pool using CommandPool::reset().

Typedef documentation

typedef Containers::EnumSet<Flag> Magnum::Vk::CommandPoolCreateInfo::Flags

Command pool creation flags.

Type-safe wrapper for VkCommandPoolCreateFlags.

Function documentation

Magnum::Vk::CommandPoolCreateInfo::CommandPoolCreateInfo(UnsignedInt queueFamilyIndex, Flags flags = {}) explicit

Constructor.

Parameters
queueFamilyIndex Queue family index
flags Command pool creation flags

The following VkCommandPoolCreateInfo fields are pre-filled in addition to sType, everything else is zero-filled:

  • flags
  • queueFamilyIndex

Magnum::Vk::CommandPoolCreateInfo::CommandPoolCreateInfo(NoInitT) explicit noexcept

Construct without initializing the contents.

Note that not even the sType field is set — the structure has to be fully initialized afterwards in order to be usable.

Magnum::Vk::CommandPoolCreateInfo::CommandPoolCreateInfo(const VkCommandPoolCreateInfo& info) explicit

Construct from existing data.

Copies the existing values verbatim, pointers are kept unchanged without taking over the ownership. Modifying the newly created instance will not modify the original data nor the pointed-to data.

Magnum::Vk::CommandPoolCreateInfo::operator const VkCommandPoolCreateInfo*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const VkCommandPoolCreateInfo& Magnum::Vk::CommandPoolCreateInfo::operator*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

VkCommandPoolCreateInfo* Magnum::Vk::CommandPoolCreateInfo::operator->()

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const VkCommandPoolCreateInfo* Magnum::Vk::CommandPoolCreateInfo::operator->() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.