vkCreateEvent - Create a new event object

Description

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

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

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 first argument. To just extract the pair pass (,) as the first 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

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

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.

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

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

• event must not be waited on by a cmdWaitEvents command that is currently executing

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

Device, Event

VkEventCreateInfo - Structure specifying parameters of a newly created event

Valid Usage (Implicit)

See Also

EventCreateFlags, StructureType, createEvent

VkEvent - Opaque handle to an event object

See Also

cmdResetEvent, cmdSetEvent, cmdWaitEvents, createEvent, destroyEvent, getEventStatus, resetEvent, setEvent

VkEventCreateFlags - Reserved for future use

Description

EventCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

EventCreateInfo