Graphics.Vulkan.Core10.QueueSemaphore

Documentation

newtype VkSemaphoreCreateFlags

VkSemaphoreCreateFlags - Reserved for future use

Description

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

See Also

VkSemaphoreCreateInfo

Constructors

VkSemaphoreCreateFlags VkFlags

Instances

Eq VkSemaphoreCreateFlags

Methods

(==) :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> Bool

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

Ord VkSemaphoreCreateFlags

Methods

compare :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> Ordering

(<) :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> Bool

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

(>) :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> Bool

(>=) :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> Bool

max :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags

min :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags

Read VkSemaphoreCreateFlags

Methods

readsPrec :: Int -> ReadS VkSemaphoreCreateFlags

readList :: ReadS [VkSemaphoreCreateFlags]

readPrec :: ReadPrec VkSemaphoreCreateFlags

readListPrec :: ReadPrec [VkSemaphoreCreateFlags]

Show VkSemaphoreCreateFlags

Methods

showsPrec :: Int -> VkSemaphoreCreateFlags -> ShowS

show :: VkSemaphoreCreateFlags -> String

showList :: [VkSemaphoreCreateFlags] -> ShowS

Storable VkSemaphoreCreateFlags

Methods

sizeOf :: VkSemaphoreCreateFlags -> Int

alignment :: VkSemaphoreCreateFlags -> Int

peekElemOff :: Ptr VkSemaphoreCreateFlags -> Int -> IO VkSemaphoreCreateFlags

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

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

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

peek :: Ptr VkSemaphoreCreateFlags -> IO VkSemaphoreCreateFlags

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

Bits VkSemaphoreCreateFlags

Methods

(.&.) :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags

(.|.) :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags

xor :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags

complement :: VkSemaphoreCreateFlags -> VkSemaphoreCreateFlags

shift :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

rotate :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

zeroBits :: VkSemaphoreCreateFlags

bit :: Int -> VkSemaphoreCreateFlags

setBit :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

clearBit :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

complementBit :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

testBit :: VkSemaphoreCreateFlags -> Int -> Bool

bitSizeMaybe :: VkSemaphoreCreateFlags -> Maybe Int

bitSize :: VkSemaphoreCreateFlags -> Int

isSigned :: VkSemaphoreCreateFlags -> Bool

shiftL :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

unsafeShiftL :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

shiftR :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

unsafeShiftR :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

rotateL :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

rotateR :: VkSemaphoreCreateFlags -> Int -> VkSemaphoreCreateFlags

popCount :: VkSemaphoreCreateFlags -> Int

FiniteBits VkSemaphoreCreateFlags

Methods

finiteBitSize :: VkSemaphoreCreateFlags -> Int

countLeadingZeros :: VkSemaphoreCreateFlags -> Int

countTrailingZeros :: VkSemaphoreCreateFlags -> Int

vkCreateSemaphore :: ("device" ::: VkDevice) -> ("pCreateInfo" ::: Ptr VkSemaphoreCreateInfo) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pSemaphore" ::: Ptr VkSemaphore) -> IO VkResult

vkCreateSemaphore - Create a new queue semaphore object

Parameters

• device is the logical device that creates the semaphore.

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

Description

When created, the semaphore is in the unsignaled state.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• pCreateInfo must be a valid pointer to a valid VkSemaphoreCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pSemaphore must be a valid pointer to a VkSemaphore handle

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkAllocationCallbacks, VkDevice, VkSemaphore, VkSemaphoreCreateInfo

vkDestroySemaphore :: ("device" ::: VkDevice) -> ("semaphore" ::: VkSemaphore) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> 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.

Description

Valid Usage

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

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

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• If semaphore is not VK_NULL_HANDLE, semaphore must be a valid VkSemaphore handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks 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

VkAllocationCallbacks, VkDevice, VkSemaphore

data VkSemaphoreCreateInfo

VkSemaphoreCreateInfo - Structure specifying parameters of a newly created semaphore

Description

Valid Usage (Implicit)

• sType must be VK_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 VkExportSemaphoreCreateInfo or VkExportSemaphoreWin32HandleInfoKHR
• Each sType member in the pNext chain must be unique
• flags must be 0

See Also

VkSemaphoreCreateFlags, VkStructureType, vkCreateSemaphore

Constructors

VkSemaphoreCreateInfo

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkFlags :: VkSemaphoreCreateFlags

  flags is reserved for future use.

Instances

Eq VkSemaphoreCreateInfo

Methods

(==) :: VkSemaphoreCreateInfo -> VkSemaphoreCreateInfo -> Bool

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

Show VkSemaphoreCreateInfo

Methods

showsPrec :: Int -> VkSemaphoreCreateInfo -> ShowS

show :: VkSemaphoreCreateInfo -> String

showList :: [VkSemaphoreCreateInfo] -> ShowS

Storable VkSemaphoreCreateInfo

Methods

sizeOf :: VkSemaphoreCreateInfo -> Int

alignment :: VkSemaphoreCreateInfo -> Int

peekElemOff :: Ptr VkSemaphoreCreateInfo -> Int -> IO VkSemaphoreCreateInfo

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

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

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

peek :: Ptr VkSemaphoreCreateInfo -> IO VkSemaphoreCreateInfo

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