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

Queue submit info.

Wraps a VkSubmitInfo.

Constructors, destructors, conversion operators

SubmitInfo() explicit
Constructor.
SubmitInfo(NoInitT) explicit noexcept
Construct without initializing the contents.
SubmitInfo(const VkSubmitInfo& info) explicit
Construct from existing data.
SubmitInfo(const SubmitInfo&) deleted
Copying is not allowed.
SubmitInfo(SubmitInfo&& other) noexcept
Move constructor.
operator const VkSubmitInfo*() const
operator const VkSubmitInfo&() const

Public functions

auto operator=(const SubmitInfo&) -> SubmitInfo& deleted
Copying is not allowed.
auto operator=(SubmitInfo&& other) -> SubmitInfo& noexcept
Move assignment.
auto setCommandBuffers(Containers::ArrayView<const VkCommandBuffer> buffers) -> SubmitInfo&
Set command buffers to execute in the batch.
auto setCommandBuffers(std::initializer_list<VkCommandBuffer> buffers) -> SubmitInfo&
auto operator*() -> VkSubmitInfo&
Underlying VkSubmitInfo structure.
auto operator*() const -> const VkSubmitInfo&
auto operator->() -> VkSubmitInfo*
auto operator->() const -> const VkSubmitInfo*

Function documentation

Magnum::Vk::SubmitInfo::SubmitInfo() explicit

Constructor.

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

  • *(none)*

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

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

Magnum::Vk::SubmitInfo::operator const VkSubmitInfo&() const

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

The class is implicitly convertible to a reference in addition to a pointer because the type is commonly used in arrays as well, which would be annoying to do with a pointer conversion.

SubmitInfo& Magnum::Vk::SubmitInfo::setCommandBuffers(Containers::ArrayView<const VkCommandBuffer> buffers)

Set command buffers to execute in the batch.

Returns Reference to self (for method chaining)

SubmitInfo& Magnum::Vk::SubmitInfo::setCommandBuffers(std::initializer_list<VkCommandBuffer> buffers)

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

const VkSubmitInfo& Magnum::Vk::SubmitInfo::operator*() const

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

VkSubmitInfo* Magnum::Vk::SubmitInfo::operator->()

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

const VkSubmitInfo* Magnum::Vk::SubmitInfo::operator->() const

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