vkCreateEvent - Create a new event object

Description

When created, the event object is in the unsignaled state.

Valid Usage

• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::events is FALSE, then the implementation does not support events, and createEvent must not be used

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid EventCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pEvent must be a valid pointer to a Event handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, Event, EventCreateInfo

A convenience wrapper to make a compatible pair of calls to createEvent and destroyEvent

To ensure that destroyEvent is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyEvent - Destroy an event object

Valid Usage

• All submitted commands that refer to event must have completed execution

• If AllocationCallbacks were provided when event was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when event was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If event is not NULL_HANDLE, event must be a valid Event handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If event is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to event must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, Event

vkGetEventStatus - Retrieve the status of an event object

Description

Upon success, getEventStatus returns the state of the event object with the following return codes:

Event Object Status Codes

If a cmdSetEvent or cmdResetEvent command is in a command buffer that is in the pending state, then the value returned by this command may immediately be out of date.

The state of an event can be updated by the host. The state of the event is immediately changed, and subsequent calls to getEventStatus will return the new state. If an event is already in the requested state, then updating it to the same state has no effect.

Return Codes

Success

• EVENT_SET
• EVENT_RESET

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

See Also

VK_VERSION_1_0, Device, Event

vkSetEvent - Set an event to signaled state

Description

When setEvent is executed on the host, it defines an /event signal operation/ which sets the event to the signaled state.

If event is already in the signaled state when setEvent is executed, then setEvent has no effect, and no event signal operation occurs.

Note

If a command buffer is waiting for an event to be signaled from the host, the application must signal the event before submitting the command buffer, as described in the queue forward progress section.

Valid Usage

• event must not have been created with EVENT_CREATE_DEVICE_ONLY_BIT

Valid Usage (Implicit)

• device must be a valid Device handle

• event must be a valid Event handle
• event must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to event must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_VERSION_1_0, Device, Event

vkResetEvent - Reset an event to non-signaled state

Description

When resetEvent is executed on the host, it defines an /event unsignal operation/ which resets the event to the unsignaled state.

If event is already in the unsignaled state when resetEvent is executed, then resetEvent has no effect, and no event unsignal operation occurs.

Valid Usage

• There must be an execution dependency between resetEvent and the execution of any cmdWaitEvents that includes event in its pEvents parameter

• There must be an execution dependency between resetEvent and the execution of any cmdWaitEvents2 that includes event in its pEvents parameter
• event must not have been created with EVENT_CREATE_DEVICE_ONLY_BIT

Valid Usage (Implicit)

• device must be a valid Device handle

• event must be a valid Event handle
• event must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to event must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_VERSION_1_0, Device, Event

VkEventCreateInfo - Structure specifying parameters of a newly created event

Valid Usage

• If the pNext chain includes a ExportMetalObjectCreateInfoEXT structure, its exportObjectType member must be EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EVENT_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of ExportMetalObjectCreateInfoEXT or ImportMetalSharedEventInfoEXT
• The sType value of each struct in the pNext chain must be unique, with the exception of structures of type ExportMetalObjectCreateInfoEXT
• flags must be a valid combination of EventCreateFlagBits values

See Also

VK_VERSION_1_0, EventCreateFlags, StructureType, createEvent

VkEvent - Opaque handle to an event object

See Also

VK_VERSION_1_0, ExportMetalSharedEventInfoEXT, cmdResetEvent, cmdResetEvent2, cmdResetEvent2KHR, cmdSetEvent, cmdSetEvent2, cmdSetEvent2KHR, cmdWaitEvents, cmdWaitEvents2, cmdWaitEvents2KHR, createEvent, destroyEvent, getEventStatus, resetEvent, setEvent

VkEventCreateFlagBits - Event creation flag bits

See Also

VK_VERSION_1_0, EventCreateFlags