Graphics.Vulkan.Core10.QueueSemaphore

Documentation

createSemaphore :: forall a io. (PokeChain a, MonadIO io) => Device -> SemaphoreCreateInfo a -> ("allocator" ::: Maybe AllocationCallbacks) -> io Semaphore

vkCreateSemaphore - Create a new queue semaphore object

Parameters

• device is the logical device that creates the semaphore.

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

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid SemaphoreCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSemaphore must be a valid pointer to a Semaphore handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, Device, Semaphore, SemaphoreCreateInfo

withSemaphore :: forall a io r. (PokeChain a, MonadIO io) => (io Semaphore -> (Semaphore -> io ()) -> r) -> Device -> SemaphoreCreateInfo a -> Maybe AllocationCallbacks -> r

A convenience wrapper to make a compatible pair of calls to createSemaphore and destroySemaphore

To ensure that destroySemaphore 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.

destroySemaphore :: forall io. MonadIO io => Device -> Semaphore -> ("allocator" ::: Maybe AllocationCallbacks) -> io ()

vkDestroySemaphore - Destroy a semaphore object

Parameters

• device is the logical device that destroys the semaphore.

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

Valid Usage

• All submitted batches that refer to semaphore must have completed execution

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

Valid Usage (Implicit)

• device must be a valid Device handle

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

Host Synchronization

• Host access to semaphore must be externally synchronized

See Also

AllocationCallbacks, Device, Semaphore

data SemaphoreCreateInfo (es :: [Type])

VkSemaphoreCreateInfo - Structure specifying parameters of a newly created semaphore

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SEMAPHORE_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 ExportSemaphoreCreateInfo, ExportSemaphoreWin32HandleInfoKHR, or SemaphoreTypeCreateInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be 0

See Also

SemaphoreCreateFlags, StructureType, createSemaphore

Constructors

SemaphoreCreateInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to an extension-specific structure.

• flags :: SemaphoreCreateFlags

  flags is reserved for future use.

Instances

Extensible SemaphoreCreateInfo

Defined in Graphics.Vulkan.Core10.QueueSemaphore

Methods

extensibleType :: StructureType

getNext :: SemaphoreCreateInfo es -> Chain es

setNext :: SemaphoreCreateInfo ds -> Chain es -> SemaphoreCreateInfo es

extends :: Typeable e => proxy e -> (Extends SemaphoreCreateInfo e -> b) -> Maybe b

Show (Chain es) => Show (SemaphoreCreateInfo es)

Defined in Graphics.Vulkan.Core10.QueueSemaphore

Methods

showsPrec :: Int -> SemaphoreCreateInfo es -> ShowS

show :: SemaphoreCreateInfo es -> String

showList :: [SemaphoreCreateInfo es] -> ShowS

PeekChain es => FromCStruct (SemaphoreCreateInfo es)

Defined in Graphics.Vulkan.Core10.QueueSemaphore

Methods

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

PokeChain es => ToCStruct (SemaphoreCreateInfo es)

Defined in Graphics.Vulkan.Core10.QueueSemaphore

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

es ~ ([] :: [Type]) => Zero (SemaphoreCreateInfo es)

Defined in Graphics.Vulkan.Core10.QueueSemaphore

Methods

zero :: SemaphoreCreateInfo es