Magnum::Vk::MemoryAllocateInfo class new in Git master

Memory allocation info.

Wraps a VkMemoryAllocateInfo. See Memory allocation for usage information.

Constructors, destructors, conversion operators

MemoryAllocateInfo(UnsignedLong size, UnsignedInt memory) explicit
Constructor.
MemoryAllocateInfo(NoInitT) explicit noexcept
Construct without initializing the contents.
MemoryAllocateInfo(const VkMemoryAllocateInfo& info) explicit
Construct from existing data.
operator const VkMemoryAllocateInfo*() const

Public functions

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

Function documentation

Magnum::Vk::MemoryAllocateInfo::MemoryAllocateInfo(UnsignedLong size, UnsignedInt memory) explicit

Constructor.

Parameters
size Allocation size in bytes
memory Memory index, smaller than DeviceProperties::memoryCount()

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

  • allocationSize to size
  • memoryTypeIndex to memory

Magnum::Vk::MemoryAllocateInfo::MemoryAllocateInfo(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::MemoryAllocateInfo::MemoryAllocateInfo(const VkMemoryAllocateInfo& 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::MemoryAllocateInfo::operator const VkMemoryAllocateInfo*() const

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

const VkMemoryAllocateInfo& Magnum::Vk::MemoryAllocateInfo::operator*() const

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

VkMemoryAllocateInfo* Magnum::Vk::MemoryAllocateInfo::operator->()

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

const VkMemoryAllocateInfo* Magnum::Vk::MemoryAllocateInfo::operator->() const

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