Vulkan.Core10.Event

Documentation

createEvent

Arguments

:: forall a io. (Extendss EventCreateInfo a, PokeChain a, MonadIO io)

=> Device

device is the logical device that creates the event.

-> EventCreateInfo a

pCreateInfo is a pointer to a EventCreateInfo structure containing information about how the event is to be created.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io Event

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

withEvent :: forall a io r. (Extendss EventCreateInfo a, PokeChain a, MonadIO io) => Device -> EventCreateInfo a -> Maybe AllocationCallbacks -> (io Event -> (Event -> io ()) -> r) -> r

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.

destroyEvent

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the event.

-> Event

event is the handle of the event to destroy.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io ()

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

getEventStatus

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the event.

device must be a valid Device handle

-> Event

event is the handle of the event to query.

event must not have been created with EVENT_CREATE_DEVICE_ONLY_BIT

event must be a valid Event handle

event must have been created, allocated, or retrieved from device

-> io Result

vkGetEventStatus - Retrieve the status of an event object

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

VK_VERSION_1_0, Device, Event

setEvent

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the event.

-> Event

event is the event to set.

-> io ()

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

resetEvent

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the event.

-> Event

event is the event to reset.

-> io ()

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

data EventCreateInfo (es :: [Type])

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

Constructors

EventCreateInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• flags :: EventCreateFlags

  flags is a bitmask of EventCreateFlagBits defining additional creation parameters.

Instances

Extensible EventCreateInfo

Defined in Vulkan.Core10.Event

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). EventCreateInfo es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [TYPE LiftedRep]). EventCreateInfo ds -> Chain es -> EventCreateInfo es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends EventCreateInfo e => b) -> Maybe b

Show (Chain es) => Show (EventCreateInfo es)

Defined in Vulkan.Core10.Event

Methods

showsPrec :: Int -> EventCreateInfo es -> ShowS

show :: EventCreateInfo es -> String

showList :: [EventCreateInfo es] -> ShowS

(Extendss EventCreateInfo es, PeekChain es) => FromCStruct (EventCreateInfo es)

Defined in Vulkan.Core10.Event

Methods

peekCStruct :: Ptr (EventCreateInfo es) -> IO (EventCreateInfo es)

(Extendss EventCreateInfo es, PokeChain es) => ToCStruct (EventCreateInfo es)

Defined in Vulkan.Core10.Event

Methods

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

pokeCStruct :: Ptr (EventCreateInfo es) -> EventCreateInfo es -> IO b -> IO b

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

pokeZeroCStruct :: Ptr (EventCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (EventCreateInfo es)

Defined in Vulkan.Core10.Event

Methods

zero :: EventCreateInfo es

newtype Event

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

Constructors

Event Word64

Instances

Storable Event

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: Event -> Int

alignment :: Event -> Int

peekElemOff :: Ptr Event -> Int -> IO Event

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

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

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

peek :: Ptr Event -> IO Event

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

Show Event

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

Eq Event

Defined in Vulkan.Core10.Handles

Methods

(==) :: Event -> Event -> Bool

(/=) :: Event -> Event -> Bool

Ord Event

Defined in Vulkan.Core10.Handles

Methods

compare :: Event -> Event -> Ordering

(<) :: Event -> Event -> Bool

(<=) :: Event -> Event -> Bool

(>) :: Event -> Event -> Bool

(>=) :: Event -> Event -> Bool

max :: Event -> Event -> Event

min :: Event -> Event -> Event

HasObjectType Event

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: Event -> (ObjectType, Word64)

IsHandle Event

Defined in Vulkan.Core10.Handles

Zero Event

Defined in Vulkan.Core10.Handles

Methods

zero :: Event

newtype EventCreateFlagBits

VkEventCreateFlagBits - Event creation flag bits

See Also

VK_VERSION_1_0, EventCreateFlags

Constructors

EventCreateFlagBits Flags

Bundled Patterns

pattern EVENT_CREATE_DEVICE_ONLY_BIT :: EventCreateFlagBits

EVENT_CREATE_DEVICE_ONLY_BIT specifies that host event commands will not be used with this event.

Instances

Storable EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

sizeOf :: EventCreateFlagBits -> Int

alignment :: EventCreateFlagBits -> Int

peekElemOff :: Ptr EventCreateFlagBits -> Int -> IO EventCreateFlagBits

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

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

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

peek :: Ptr EventCreateFlagBits -> IO EventCreateFlagBits

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

Bits EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

(.&.) :: EventCreateFlagBits -> EventCreateFlagBits -> EventCreateFlagBits

(.|.) :: EventCreateFlagBits -> EventCreateFlagBits -> EventCreateFlagBits

xor :: EventCreateFlagBits -> EventCreateFlagBits -> EventCreateFlagBits

complement :: EventCreateFlagBits -> EventCreateFlagBits

shift :: EventCreateFlagBits -> Int -> EventCreateFlagBits

rotate :: EventCreateFlagBits -> Int -> EventCreateFlagBits

zeroBits :: EventCreateFlagBits

bit :: Int -> EventCreateFlagBits

setBit :: EventCreateFlagBits -> Int -> EventCreateFlagBits

clearBit :: EventCreateFlagBits -> Int -> EventCreateFlagBits

complementBit :: EventCreateFlagBits -> Int -> EventCreateFlagBits

testBit :: EventCreateFlagBits -> Int -> Bool

bitSizeMaybe :: EventCreateFlagBits -> Maybe Int

bitSize :: EventCreateFlagBits -> Int

isSigned :: EventCreateFlagBits -> Bool

shiftL :: EventCreateFlagBits -> Int -> EventCreateFlagBits

unsafeShiftL :: EventCreateFlagBits -> Int -> EventCreateFlagBits

shiftR :: EventCreateFlagBits -> Int -> EventCreateFlagBits

unsafeShiftR :: EventCreateFlagBits -> Int -> EventCreateFlagBits

rotateL :: EventCreateFlagBits -> Int -> EventCreateFlagBits

rotateR :: EventCreateFlagBits -> Int -> EventCreateFlagBits

popCount :: EventCreateFlagBits -> Int

FiniteBits EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

finiteBitSize :: EventCreateFlagBits -> Int

countLeadingZeros :: EventCreateFlagBits -> Int

countTrailingZeros :: EventCreateFlagBits -> Int

Read EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

readsPrec :: Int -> ReadS EventCreateFlagBits

readList :: ReadS [EventCreateFlagBits]

readPrec :: ReadPrec EventCreateFlagBits

readListPrec :: ReadPrec [EventCreateFlagBits]

Show EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

showsPrec :: Int -> EventCreateFlagBits -> ShowS

show :: EventCreateFlagBits -> String

showList :: [EventCreateFlagBits] -> ShowS

Eq EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

(==) :: EventCreateFlagBits -> EventCreateFlagBits -> Bool

(/=) :: EventCreateFlagBits -> EventCreateFlagBits -> Bool

Ord EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

compare :: EventCreateFlagBits -> EventCreateFlagBits -> Ordering

(<) :: EventCreateFlagBits -> EventCreateFlagBits -> Bool

(<=) :: EventCreateFlagBits -> EventCreateFlagBits -> Bool

(>) :: EventCreateFlagBits -> EventCreateFlagBits -> Bool

(>=) :: EventCreateFlagBits -> EventCreateFlagBits -> Bool

max :: EventCreateFlagBits -> EventCreateFlagBits -> EventCreateFlagBits

min :: EventCreateFlagBits -> EventCreateFlagBits -> EventCreateFlagBits

Zero EventCreateFlagBits

Defined in Vulkan.Core10.Enums.EventCreateFlagBits

Methods

zero :: EventCreateFlagBits

type EventCreateFlags = EventCreateFlagBits