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

Fence creation info.

Wraps a VkFenceCreateInfo. See Fence creation for usage information.

Public types

enum class Flag: UnsignedInt { Signaled = VK_FENCE_CREATE_SIGNALED_BIT }
Fence creation flag.
using Flags = Containers::EnumSet<Flag>
Fence creation flags.

Constructors, destructors, conversion operators

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

Public functions

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

Enum documentation

enum class Magnum::Vk::FenceCreateInfo::Flag: UnsignedInt

Fence creation flag.

Wraps VkFenceCreateFlagBits.

Enumerators
Signaled

Create the fence in a signaled state.

Fence::status(), Fence::reset()

Typedef documentation

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

Fence creation flags.

Type-safe wrapper for VkFenceCreateFlags.

Function documentation

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

Constructor.

Parameters
flags Fence creation flags

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

  • flags

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

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

const VkFenceCreateInfo& Magnum::Vk::FenceCreateInfo::operator*() const

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

VkFenceCreateInfo* Magnum::Vk::FenceCreateInfo::operator->()

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

const VkFenceCreateInfo* Magnum::Vk::FenceCreateInfo::operator->() const

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