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

Command buffer begin info.

Wraps a VkCommandBufferBeginInfo. See Command buffer usage for more information.

Public types

enum class Flag: UnsignedInt { OneTimeSubmit = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT, RenderPassContinue = VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, SimultaneousUse = VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT }
Command buffer begin flag.
using Flags = Containers::EnumSet<Flag>
Command buffer begin flags.

Constructors, destructors, conversion operators

CommandBufferBeginInfo(Flags flags = {}) explicit
Constructor.
CommandBufferBeginInfo(NoInitT) explicit noexcept
Construct without initializing the contents.
CommandBufferBeginInfo(const VkCommandBufferBeginInfo& info) explicit
Construct from existing data.
operator const VkCommandBufferBeginInfo*() const

Public functions

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

Enum documentation

enum class Magnum::Vk::CommandBufferBeginInfo::Flag: UnsignedInt

Command buffer begin flag.

Wraps VkCommandBufferUsageFlagBits.

Enumerators
OneTimeSubmit

Each recording will be submitted only once and the command buffer will be reset and recorded again between each submission.
RenderPassContinue

Specifies that a CommandBufferLevel::Secondary buffer is entirely inside a render pass. Ignored for CommandBufferLevel::Primary command buffers (the default).
SimultaneousUse

A command buffer can be resubmitted to a queue while it is in the pending state, and recorded into multiple primary command buffers.

Typedef documentation

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

Command buffer begin flags.

Type-safe wrapper for VkCommandBufferUsageFlags.

Function documentation

Magnum::Vk::CommandBufferBeginInfo::CommandBufferBeginInfo(Flags flags = {}) explicit

Constructor.

Parameters
flags Command buffer begin flags

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

  • flags

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

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

const VkCommandBufferBeginInfo& Magnum::Vk::CommandBufferBeginInfo::operator*() const

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

VkCommandBufferBeginInfo* Magnum::Vk::CommandBufferBeginInfo::operator->()

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

const VkCommandBufferBeginInfo* Magnum::Vk::CommandBufferBeginInfo::operator->() const

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