VV::V3::Event class
#include <VaultedVulkan/VV_SyncAndCacheControl.hpp>

Events are a synchronization primitive that can be used to insert a fine-grained dependency between commands submitted to the same queue, or between the host and a queue. Events must not be used to insert a dependency between commands submitted to different queues. Events have two states - signaled and unsignaled.

Reference

This object represents a device created object on the host. As such ownership is tied to this host object. Due to this design, the object has no copy-construction allowed. Instead, default move constructor and assignment has been defined.

Base classes

struct VV::V2::Event: Events are a synchronization primitive that can be used to insert a fine-grained dependency between commands submitted to the same queue, or between the host and a queue. Events must not be used to insert a dependency between commands submitted to different queues. Events have two states - signaled and unsignaled.

Public types

using Parent = V2::Event

Constructors, destructors, conversion operators

Event(): Default constructor.
Event(const LogicalDevice& _device): Logical device specified.
Event(const LogicalDevice& _device, const Memory::AllocationCallbacks& _allocator): Logical device and allocator specified.
Event(Event&& _other) noexcept: Performs a move operation to transfer ownership of the device object to this host object.
~Event(): Destroy the event if the handle is not null.
operator Handle&(): Implicit conversion to give a reference to its handle.
operator const Handle&() const: Implicit conversion to give a readonly reference to its handle.
operator const Handle*() const: Implicit conversion to give a pointer to its handle.

Public functions

auto Create(const CreateInfo& _info) -> EResult: Create an event.
auto Create(const LogicalDevice& _device, const CreateInfo& _info) -> EResult: Create an event (logical device specified).
auto Create(const LogicalDevice& _device, const CreateInfo& _info, const Memory::AllocationCallbacks& _allocator) -> EResult: Create an event (logical device and allocator specified).
void Destroy(): Destroy an event.
auto GetStatus() -> EResult: Query the state of an event from the host.
auto Reset() -> EResult: Set the state of an event to unsignaled from the host.
auto Set() -> EResult: Set the state of an event to signaled from the host.
auto operator==(const Event& _other) const -> bool: Checks to see if its the same object by checking to see if its the same handle.
auto operator=(Event&& _other) -> Event& noexcept: Performs a move assignment operation to transfer ownership of the device object to this host object.

Protected variables

Handle handle
const Memory::AllocationCallbacks* allocator
const LogicalDevice* device