Safe Haskell	None
Language	Haskell2010

Graphics.Vulkan.Core10.Fence

Synopsis

newtype VkFenceCreateFlagBits = VkFenceCreateFlagBits VkFlags
pattern VK_FENCE_CREATE_SIGNALED_BIT :: VkFenceCreateFlagBits
vkCreateFence :: ("device" ::: VkDevice) -> ("pCreateInfo" ::: Ptr VkFenceCreateInfo) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pFence" ::: Ptr VkFence) -> IO VkResult
vkDestroyFence :: ("device" ::: VkDevice) -> ("fence" ::: VkFence) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> IO ()
vkResetFences :: ("device" ::: VkDevice) -> ("fenceCount" ::: Word32) -> ("pFences" ::: Ptr VkFence) -> IO VkResult
vkGetFenceStatus :: ("device" ::: VkDevice) -> ("fence" ::: VkFence) -> IO VkResult
vkWaitForFences :: ("device" ::: VkDevice) -> ("fenceCount" ::: Word32) -> ("pFences" ::: Ptr VkFence) -> ("waitAll" ::: VkBool32) -> ("timeout" ::: Word64) -> IO VkResult
data VkFenceCreateInfo = VkFenceCreateInfo {
- vkSType :: VkStructureType
- vkPNext :: Ptr ()
- vkFlags :: VkFenceCreateFlags
}
type VkFenceCreateFlags = VkFenceCreateFlagBits

Documentation

newtype VkFenceCreateFlagBits Source #

VkFenceCreateFlagBits - Bitmask specifying initial state and behavior of a fence

Eq VkFenceCreateFlagBits Source #
Instance details Methods (==) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> Bool # (/=) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> Bool #
Ord VkFenceCreateFlagBits Source #
Instance details Methods compare :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> Ordering # (<) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> Bool # (<=) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> Bool # (>) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> Bool # (>=) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> Bool # max :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> VkFenceCreateFlagBits # min :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> VkFenceCreateFlagBits #
Read VkFenceCreateFlagBits Source #
Instance details Methods readsPrec :: Int -> ReadS VkFenceCreateFlagBits # readList :: ReadS [VkFenceCreateFlagBits] # readPrec :: ReadPrec VkFenceCreateFlagBits # readListPrec :: ReadPrec [VkFenceCreateFlagBits] #
Show VkFenceCreateFlagBits Source #
Instance details Methods showsPrec :: Int -> VkFenceCreateFlagBits -> ShowS # show :: VkFenceCreateFlagBits -> String # showList :: [VkFenceCreateFlagBits] -> ShowS #
Storable VkFenceCreateFlagBits Source #
Instance details Methods sizeOf :: VkFenceCreateFlagBits -> Int # alignment :: VkFenceCreateFlagBits -> Int # peekElemOff :: Ptr VkFenceCreateFlagBits -> Int -> IO VkFenceCreateFlagBits # pokeElemOff :: Ptr VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits -> IO () # peekByteOff :: Ptr b -> Int -> IO VkFenceCreateFlagBits # pokeByteOff :: Ptr b -> Int -> VkFenceCreateFlagBits -> IO () # peek :: Ptr VkFenceCreateFlagBits -> IO VkFenceCreateFlagBits # poke :: Ptr VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> IO () #
Bits VkFenceCreateFlagBits Source #
Instance details Methods (.&.) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> VkFenceCreateFlagBits # (.\|.) :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> VkFenceCreateFlagBits # xor :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits -> VkFenceCreateFlagBits # complement :: VkFenceCreateFlagBits -> VkFenceCreateFlagBits # shift :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # rotate :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # zeroBits :: VkFenceCreateFlagBits # bit :: Int -> VkFenceCreateFlagBits # setBit :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # clearBit :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # complementBit :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # testBit :: VkFenceCreateFlagBits -> Int -> Bool # bitSizeMaybe :: VkFenceCreateFlagBits -> Maybe Int # bitSize :: VkFenceCreateFlagBits -> Int # isSigned :: VkFenceCreateFlagBits -> Bool # shiftL :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # unsafeShiftL :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # shiftR :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # unsafeShiftR :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # rotateL :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # rotateR :: VkFenceCreateFlagBits -> Int -> VkFenceCreateFlagBits # popCount :: VkFenceCreateFlagBits -> Int #
FiniteBits VkFenceCreateFlagBits Source #
Instance details Methods finiteBitSize :: VkFenceCreateFlagBits -> Int # countLeadingZeros :: VkFenceCreateFlagBits -> Int # countTrailingZeros :: VkFenceCreateFlagBits -> Int #

pattern VK_FENCE_CREATE_SIGNALED_BIT :: VkFenceCreateFlagBits Source #

VK_FENCE_CREATE_SIGNALED_BIT specifies that the fence object is created in the signaled state. Otherwise, it is created in the unsignaled state.

vkCreateFence :: ("device" ::: VkDevice) -> ("pCreateInfo" ::: Ptr VkFenceCreateInfo) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pFence" ::: Ptr VkFence) -> IO VkResult Source #

vkCreateFence - Create a new fence object

Parameters

device is the logical device that creates the fence.

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

Valid Usage (Implicit)

device must be a valid VkDevice handle

pCreateInfo must be a valid pointer to a valid VkFenceCreateInfo structure
If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
pFence must be a valid pointer to a VkFence handle

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

Parameters

device is the logical device that destroys the fence.

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

Valid Usage

All queue submission commands that refer to fence must have completed execution

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

Valid Usage (Implicit)

device must be a valid VkDevice handle

If fence is not VK_NULL_HANDLE, fence must be a valid VkFence handle
If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
If fence is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

Host access to fence must be externally synchronized

Parameters

device is the logical device that owns the fences.

fenceCount is the number of fences to reset.
pFences is a pointer to an array of fence handles to reset.

Description

If any member of pFences currently has its payload imported with temporary permanence, that fence’s prior permanent payload is first restored. The remaining operations described therefore operate on the restored payload.

When vkResetFences is executed on the host, it defines a /fence unsignal operation/ for each fence, which resets the fence to the unsignaled state.

If any member of pFences is already in the unsignaled state when vkResetFences is executed, then vkResetFences has no effect on that fence.

Valid Usage

Each element of pFences must not be currently associated with any queue command that has not yet completed execution on that queue

Valid Usage (Implicit)

device must be a valid VkDevice handle

pFences must be a valid pointer to an array of fenceCount valid VkFence handles
fenceCount must be greater than 0
Each element of pFences must have been created, allocated, or retrieved from device

Host Synchronization

Host access to each member of pFences must be externally synchronized

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```

Parameters

device is the logical device that owns the fence.

fence is the handle of the fence to query.

Description

Upon success, vkGetFenceStatus returns the status of the fence object, with the following return codes:

Status	Meaning
`VK_SUCCESS`	The fence specified by `fence` is signaled.
`VK_NOT_READY`	The fence specified by `fence` is unsignaled.
`VK_ERROR_DEVICE_LOST`	The device has been lost. See Lost Device.

Fence Object Status Codes

If a queue submission command is pending execution, then the value returned by this command may immediately be out of date.

If the device has been lost (see Lost Device), vkGetFenceStatus may return any of the above status codes. If the device has been lost and vkGetFenceStatus is called repeatedly, it will eventually return either VK_SUCCESS or VK_ERROR_DEVICE_LOST.

Valid Usage (Implicit)

device must be a valid VkDevice handle

fence must be a valid VkFence handle
fence must have been created, allocated, or retrieved from device

Return Codes

[Success] - VK_SUCCESS

```
VK_NOT_READY
```

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

Parameters

device is the logical device that owns the fences.

fenceCount is the number of fences to wait on.
pFences is a pointer to an array of fenceCount fence handles.
waitAll is the condition that must be satisfied to successfully unblock the wait. If waitAll is VK_TRUE, then the condition is that all fences in pFences are signaled. Otherwise, the condition is that at least one fence in pFences is signaled.
timeout is the timeout period in units of nanoseconds. timeout is adjusted to the closest value allowed by the implementation-dependent timeout accuracy, which may be substantially longer than one nanosecond, and may be longer than the requested period.

Description

If the condition is satisfied when vkWaitForFences is called, then vkWaitForFences returns immediately. If the condition is not satisfied at the time vkWaitForFences is called, then vkWaitForFences will block and wait up to timeout nanoseconds for the condition to become satisfied.

If timeout is zero, then vkWaitForFences does not wait, but simply returns the current state of the fences. VK_TIMEOUT will be returned in this case if the condition is not satisfied, even though no actual wait was performed.

If the specified timeout period expires before the condition is satisfied, vkWaitForFences returns VK_TIMEOUT. If the condition is satisfied before timeout nanoseconds has expired, vkWaitForFences returns VK_SUCCESS.

If device loss occurs (see Lost Device) before the timeout has expired, vkWaitForFences must return in finite time with either VK_SUCCESS or VK_ERROR_DEVICE_LOST.

Note

While we guarantee that vkWaitForFences must return in finite time, no guarantees are made that it returns immediately upon device loss. However, the client can reasonably expect that the delay will be on the order of seconds and that calling vkWaitForFences will not result in a permanently (or seemingly permanently) dead process.

Valid Usage (Implicit)

device must be a valid VkDevice handle

pFences must be a valid pointer to an array of fenceCount valid VkFence handles
fenceCount must be greater than 0
Each element of pFences must have been created, allocated, or retrieved from device

Return Codes

[Success] - VK_SUCCESS

```
VK_TIMEOUT
```

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_DEVICE_LOST
```

Description

VkFenceCreateFlags is a bitmask type for setting a mask of zero or more VkFenceCreateFlagBits.

Eq VkFenceCreateInfo Source #
Instance details Methods (==) :: VkFenceCreateInfo -> VkFenceCreateInfo -> Bool # (/=) :: VkFenceCreateInfo -> VkFenceCreateInfo -> Bool #
Show VkFenceCreateInfo Source #
Instance details Methods showsPrec :: Int -> VkFenceCreateInfo -> ShowS # show :: VkFenceCreateInfo -> String # showList :: [VkFenceCreateInfo] -> ShowS #
Storable VkFenceCreateInfo Source #
Instance details Methods sizeOf :: VkFenceCreateInfo -> Int # alignment :: VkFenceCreateInfo -> Int # peekElemOff :: Ptr VkFenceCreateInfo -> Int -> IO VkFenceCreateInfo # pokeElemOff :: Ptr VkFenceCreateInfo -> Int -> VkFenceCreateInfo -> IO () # peekByteOff :: Ptr b -> Int -> IO VkFenceCreateInfo # pokeByteOff :: Ptr b -> Int -> VkFenceCreateInfo -> IO () # peek :: Ptr VkFenceCreateInfo -> IO VkFenceCreateInfo # poke :: Ptr VkFenceCreateInfo -> VkFenceCreateInfo -> IO () #

Documentation

See Also

Parameters

Valid Usage (Implicit)

Return Codes

See Also

Parameters

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Parameters

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Return Codes

See Also

Parameters

Description

Valid Usage (Implicit)

Return Codes

See Also

Parameters

Description

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage (Implicit)

See Also

Description

See Also

VkFenceCreateInfo
Fields vkSType :: VkStructureType `sType` is the type of this structure. vkPNext :: Ptr () `pNext` is `NULL` or a pointer to an extension-specific structure. vkFlags :: VkFenceCreateFlags `flags` is a bitmask of `VkFenceCreateFlagBits` specifying the initial state and behavior of the fence.