Graphics.Vulkan.Core10.Event

Documentation

createEvent :: Device -> EventCreateInfo -> ("allocator" ::: Maybe AllocationCallbacks) -> IO Event

vkCreateEvent - Create a new event object

Parameters

• Device is the logical device that creates the event.

• pCreateInfo is a pointer to a EventCreateInfo structure containing information about how the event is to be created.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pEvent is a pointer to a handle in which the resulting event object is returned.

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

withEvent :: Device -> EventCreateInfo -> Maybe AllocationCallbacks -> (Event -> IO r) -> IO r

A safe wrapper for createEvent and destroyEvent using bracket

The allocated value must not be returned from the provided computation

destroyEvent :: Device -> Event -> ("allocator" ::: Maybe AllocationCallbacks) -> IO ()

vkDestroyEvent - Destroy an event object

Parameters

• Device is the logical device that destroys the event.

• Event is the handle of the event to destroy.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.

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

getEventStatus :: Device -> Event -> IO Result

vkGetEventStatus - Retrieve the status of an event object

Parameters

• Device is the logical device that owns the event.

• Event is the handle of the event to query.

Description

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

Status	Meaning
EVENT_SET	The event specified by Event is signaled.
EVENT_RESET	The event specified by Event is unsignaled.

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

setEvent :: Device -> Event -> IO ()

vkSetEvent - Set an event to signaled state

Parameters

• Device is the logical device that owns the event.

• Event is the event to set.

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

resetEvent :: Device -> Event -> IO ()

vkResetEvent - Reset an event to non-signaled state

Parameters

• Device is the logical device that owns the event.

• Event is the event to reset.

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

data EventCreateInfo

VkEventCreateInfo - Structure specifying parameters of a newly created event

Valid Usage (Implicit)

See Also

EventCreateFlags, StructureType, createEvent

Constructors

EventCreateInfo

Fields

• flags :: EventCreateFlags

  Flags must be 0

Instances

Show EventCreateInfo

Defined in Graphics.Vulkan.Core10.Event

Methods

showsPrec :: Int -> EventCreateInfo -> ShowS

show :: EventCreateInfo -> String

showList :: [EventCreateInfo] -> ShowS

Storable EventCreateInfo

Defined in Graphics.Vulkan.Core10.Event

Methods

sizeOf :: EventCreateInfo -> Int

alignment :: EventCreateInfo -> Int

peekElemOff :: Ptr EventCreateInfo -> Int -> IO EventCreateInfo

pokeElemOff :: Ptr EventCreateInfo -> Int -> EventCreateInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO EventCreateInfo

pokeByteOff :: Ptr b -> Int -> EventCreateInfo -> IO ()

peek :: Ptr EventCreateInfo -> IO EventCreateInfo

poke :: Ptr EventCreateInfo -> EventCreateInfo -> IO ()

FromCStruct EventCreateInfo

Defined in Graphics.Vulkan.Core10.Event

Methods

peekCStruct :: Ptr EventCreateInfo -> IO EventCreateInfo

ToCStruct EventCreateInfo

Defined in Graphics.Vulkan.Core10.Event

Methods

withCStruct :: EventCreateInfo -> (Ptr EventCreateInfo -> IO b) -> IO b

pokeCStruct :: Ptr EventCreateInfo -> EventCreateInfo -> IO b -> IO b

withZeroCStruct :: (Ptr EventCreateInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr EventCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero EventCreateInfo

Defined in Graphics.Vulkan.Core10.Event

Methods

zero :: EventCreateInfo