Vulkan.Core10.QueueSemaphore

Documentation

createSemaphore

Arguments

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

=> Device

device is the logical device that creates the semaphore.

-> SemaphoreCreateInfo a

pCreateInfo is a pointer to a SemaphoreCreateInfo structure containing information about how the semaphore is to be created.

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

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

-> io Semaphore

vkCreateSemaphore - Create a new queue semaphore object

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. (Extendss SemaphoreCreateInfo a, PokeChain a, MonadIO io) => Device -> SemaphoreCreateInfo a -> Maybe AllocationCallbacks -> (io Semaphore -> (Semaphore -> io ()) -> r) -> 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

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the semaphore.

-> Semaphore

semaphore is the handle of the semaphore to destroy.

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

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

-> io ()

vkDestroySemaphore - Destroy a semaphore object

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 a structure extending this structure.

• flags :: SemaphoreCreateFlags

  flags is reserved for future use.

Instances

Extensible SemaphoreCreateInfo

Defined in Vulkan.Core10.QueueSemaphore

Methods

extensibleType :: StructureType

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

setNext :: forall (ds :: [Type]) (es :: [Type]). SemaphoreCreateInfo ds -> Chain es -> SemaphoreCreateInfo es

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

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

Defined in Vulkan.Core10.QueueSemaphore

Methods

showsPrec :: Int -> SemaphoreCreateInfo es -> ShowS

show :: SemaphoreCreateInfo es -> String

showList :: [SemaphoreCreateInfo es] -> ShowS

Generic (SemaphoreCreateInfo es)

Defined in Vulkan.Core10.QueueSemaphore

Associated Types

type Rep (SemaphoreCreateInfo es) :: Type -> Type

Methods

from :: SemaphoreCreateInfo es -> Rep (SemaphoreCreateInfo es) x

to :: Rep (SemaphoreCreateInfo es) x -> SemaphoreCreateInfo es

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

Defined in Vulkan.Core10.QueueSemaphore

Methods

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

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

Defined in 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 Vulkan.Core10.QueueSemaphore

Methods

zero :: SemaphoreCreateInfo es

type Rep (SemaphoreCreateInfo es)

Defined in Vulkan.Core10.QueueSemaphore

type Rep (SemaphoreCreateInfo es) = D1 ('MetaData "SemaphoreCreateInfo" "Vulkan.Core10.QueueSemaphore" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "SemaphoreCreateInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SemaphoreCreateFlags)))

newtype Semaphore

VkSemaphore - Opaque handle to a semaphore object

See Also

AcquireNextImageInfoKHR, BindSparseInfo, ImportSemaphoreFdInfoKHR, ImportSemaphoreWin32HandleInfoKHR, PresentInfoKHR, SemaphoreGetFdInfoKHR, SemaphoreGetWin32HandleInfoKHR, SemaphoreSignalInfo, SemaphoreWaitInfo, SubmitInfo, acquireNextImageKHR, createSemaphore, destroySemaphore, getSemaphoreCounterValue, getSemaphoreCounterValueKHR

Constructors

Semaphore Word64

Instances

Eq Semaphore

Defined in Vulkan.Core10.Handles

Methods

(==) :: Semaphore -> Semaphore -> Bool

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

Ord Semaphore

Defined in Vulkan.Core10.Handles

Methods

compare :: Semaphore -> Semaphore -> Ordering

(<) :: Semaphore -> Semaphore -> Bool

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

(>) :: Semaphore -> Semaphore -> Bool

(>=) :: Semaphore -> Semaphore -> Bool

max :: Semaphore -> Semaphore -> Semaphore

min :: Semaphore -> Semaphore -> Semaphore

Show Semaphore

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> Semaphore -> ShowS

show :: Semaphore -> String

showList :: [Semaphore] -> ShowS

Storable Semaphore

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: Semaphore -> Int

alignment :: Semaphore -> Int

peekElemOff :: Ptr Semaphore -> Int -> IO Semaphore

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

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

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

peek :: Ptr Semaphore -> IO Semaphore

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

Zero Semaphore

Defined in Vulkan.Core10.Handles

Methods

zero :: Semaphore

HasObjectType Semaphore

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: Semaphore -> (ObjectType, Word64)

IsHandle Semaphore

Defined in Vulkan.Core10.Handles

newtype SemaphoreCreateFlags

VkSemaphoreCreateFlags - Reserved for future use

Description

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

See Also

SemaphoreCreateInfo

Constructors

SemaphoreCreateFlags Flags

Instances

Eq SemaphoreCreateFlags

Defined in Vulkan.Core10.Enums.SemaphoreCreateFlags

Methods

(==) :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> Bool

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

Ord SemaphoreCreateFlags

Defined in Vulkan.Core10.Enums.SemaphoreCreateFlags

Methods

compare :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> Ordering

(<) :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> Bool

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

(>) :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> Bool

(>=) :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> Bool

max :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> SemaphoreCreateFlags

min :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> SemaphoreCreateFlags

Read SemaphoreCreateFlags

Defined in Vulkan.Core10.Enums.SemaphoreCreateFlags

Methods

readsPrec :: Int -> ReadS SemaphoreCreateFlags

readList :: ReadS [SemaphoreCreateFlags]

readPrec :: ReadPrec SemaphoreCreateFlags

readListPrec :: ReadPrec [SemaphoreCreateFlags]

Show SemaphoreCreateFlags

Defined in Vulkan.Core10.Enums.SemaphoreCreateFlags

Methods

showsPrec :: Int -> SemaphoreCreateFlags -> ShowS

show :: SemaphoreCreateFlags -> String

showList :: [SemaphoreCreateFlags] -> ShowS

Storable SemaphoreCreateFlags

Defined in Vulkan.Core10.Enums.SemaphoreCreateFlags

Methods

sizeOf :: SemaphoreCreateFlags -> Int

alignment :: SemaphoreCreateFlags -> Int

peekElemOff :: Ptr SemaphoreCreateFlags -> Int -> IO SemaphoreCreateFlags

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

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

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

peek :: Ptr SemaphoreCreateFlags -> IO SemaphoreCreateFlags

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

Bits SemaphoreCreateFlags

Defined in Vulkan.Core10.Enums.SemaphoreCreateFlags

Methods

(.&.) :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> SemaphoreCreateFlags

(.|.) :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> SemaphoreCreateFlags

xor :: SemaphoreCreateFlags -> SemaphoreCreateFlags -> SemaphoreCreateFlags

complement :: SemaphoreCreateFlags -> SemaphoreCreateFlags

shift :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

rotate :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

zeroBits :: SemaphoreCreateFlags

bit :: Int -> SemaphoreCreateFlags

setBit :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

clearBit :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

complementBit :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

testBit :: SemaphoreCreateFlags -> Int -> Bool

bitSizeMaybe :: SemaphoreCreateFlags -> Maybe Int

bitSize :: SemaphoreCreateFlags -> Int

isSigned :: SemaphoreCreateFlags -> Bool

shiftL :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

unsafeShiftL :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

shiftR :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

unsafeShiftR :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

rotateL :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

rotateR :: SemaphoreCreateFlags -> Int -> SemaphoreCreateFlags

popCount :: SemaphoreCreateFlags -> Int

Zero SemaphoreCreateFlags

Defined in Vulkan.Core10.Enums.SemaphoreCreateFlags

Methods

zero :: SemaphoreCreateFlags