Graphics.Vulkan.Core11.Promoted_from_VK_KHR_external_fence_capabilities

Documentation

newtype VkExternalFenceHandleTypeFlagBits

VkExternalFenceHandleTypeFlagBits - Bitmask of valid external fence handle types

Description

• VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BIT specifies a POSIX file descriptor handle that has only limited valid usage outside of Vulkan and other compatible APIs. It must be compatible with the POSIX system calls dup, dup2, close, and the non-standard system call dup3. Additionally, it must be transportable over a socket using an SCM_RIGHTS control message. It owns a reference to the underlying synchronization primitive represented by its Vulkan fence object.

• VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT specifies an NT handle that has only limited valid usage outside of Vulkan and other compatible APIs. It must be compatible with the functions DuplicateHandle, CloseHandle, CompareObjectHandles, GetHandleInformation, and SetHandleInformation. It owns a reference to the underlying synchronization primitive represented by its Vulkan fence object.
• VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT specifies a global share handle that has only limited valid usage outside of Vulkan and other compatible APIs. It is not compatible with any native APIs. It does not own a reference to the underlying synchronization primitive represented by its Vulkan fence object, and will therefore become invalid when all Vulkan fence objects associated with it are destroyed.
• VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT specifies a POSIX file descriptor handle to a Linux Sync File or Android Fence. It can be used with any native API accepting a valid sync file or fence as input. It owns a reference to the underlying synchronization primitive associated with the file descriptor. Implementations which support importing this handle type must accept any type of sync or fence FD supported by the native system they are running on.

Some external fence handle types can only be shared within the same underlying physical device and/or the same driver version, as defined in the following table:

Handle type	VkPhysicalDeviceIDProperties::driverUUID	VkPhysicalDeviceIDProperties::deviceUUID
VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BIT	Must match	Must match
VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT	Must match	Must match
VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT	Must match	Must match
VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT	No restriction	No restriction

External fence handle types compatibility

See Also

VkExternalFenceHandleTypeFlags, VkFenceGetFdInfoKHR, VkFenceGetWin32HandleInfoKHR, VkImportFenceFdInfoKHR, VkImportFenceWin32HandleInfoKHR, VkPhysicalDeviceExternalFenceInfo

Constructors

VkExternalFenceHandleTypeFlagBits VkFlags

Instances

Eq VkExternalFenceHandleTypeFlagBits

Methods

(==) :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> Bool

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

Ord VkExternalFenceHandleTypeFlagBits

Methods

compare :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> Ordering

(<) :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> Bool

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

(>) :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> Bool

(>=) :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> Bool

max :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits

min :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits

Read VkExternalFenceHandleTypeFlagBits

Methods

readsPrec :: Int -> ReadS VkExternalFenceHandleTypeFlagBits

readList :: ReadS [VkExternalFenceHandleTypeFlagBits]

readPrec :: ReadPrec VkExternalFenceHandleTypeFlagBits

readListPrec :: ReadPrec [VkExternalFenceHandleTypeFlagBits]

Show VkExternalFenceHandleTypeFlagBits

Methods

showsPrec :: Int -> VkExternalFenceHandleTypeFlagBits -> ShowS

show :: VkExternalFenceHandleTypeFlagBits -> String

showList :: [VkExternalFenceHandleTypeFlagBits] -> ShowS

Storable VkExternalFenceHandleTypeFlagBits

Methods

sizeOf :: VkExternalFenceHandleTypeFlagBits -> Int

alignment :: VkExternalFenceHandleTypeFlagBits -> Int

peekElemOff :: Ptr VkExternalFenceHandleTypeFlagBits -> Int -> IO VkExternalFenceHandleTypeFlagBits

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

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

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

peek :: Ptr VkExternalFenceHandleTypeFlagBits -> IO VkExternalFenceHandleTypeFlagBits

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

Bits VkExternalFenceHandleTypeFlagBits

Methods

(.&.) :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits

(.|.) :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits

xor :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits

complement :: VkExternalFenceHandleTypeFlagBits -> VkExternalFenceHandleTypeFlagBits

shift :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

rotate :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

zeroBits :: VkExternalFenceHandleTypeFlagBits

bit :: Int -> VkExternalFenceHandleTypeFlagBits

setBit :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

clearBit :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

complementBit :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

testBit :: VkExternalFenceHandleTypeFlagBits -> Int -> Bool

bitSizeMaybe :: VkExternalFenceHandleTypeFlagBits -> Maybe Int

bitSize :: VkExternalFenceHandleTypeFlagBits -> Int

isSigned :: VkExternalFenceHandleTypeFlagBits -> Bool

shiftL :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

unsafeShiftL :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

shiftR :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

unsafeShiftR :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

rotateL :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

rotateR :: VkExternalFenceHandleTypeFlagBits -> Int -> VkExternalFenceHandleTypeFlagBits

popCount :: VkExternalFenceHandleTypeFlagBits -> Int

FiniteBits VkExternalFenceHandleTypeFlagBits

Methods

finiteBitSize :: VkExternalFenceHandleTypeFlagBits -> Int

countLeadingZeros :: VkExternalFenceHandleTypeFlagBits -> Int

countTrailingZeros :: VkExternalFenceHandleTypeFlagBits -> Int

pattern VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BIT :: VkExternalFenceHandleTypeFlagBits

pattern VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT :: VkExternalFenceHandleTypeFlagBits

pattern VK_EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT :: VkExternalFenceHandleTypeFlagBits

pattern VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT :: VkExternalFenceHandleTypeFlagBits

newtype VkExternalFenceFeatureFlagBits

VkExternalFenceFeatureFlagBits - Bitfield describing features of an external fence handle type

See Also

VkExternalFenceFeatureFlags

Constructors

VkExternalFenceFeatureFlagBits VkFlags

Instances

Eq VkExternalFenceFeatureFlagBits

Methods

(==) :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> Bool

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

Ord VkExternalFenceFeatureFlagBits

Methods

compare :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> Ordering

(<) :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> Bool

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

(>) :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> Bool

(>=) :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> Bool

max :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits

min :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits

Read VkExternalFenceFeatureFlagBits

Methods

readsPrec :: Int -> ReadS VkExternalFenceFeatureFlagBits

readList :: ReadS [VkExternalFenceFeatureFlagBits]

readPrec :: ReadPrec VkExternalFenceFeatureFlagBits

readListPrec :: ReadPrec [VkExternalFenceFeatureFlagBits]

Show VkExternalFenceFeatureFlagBits

Methods

showsPrec :: Int -> VkExternalFenceFeatureFlagBits -> ShowS

show :: VkExternalFenceFeatureFlagBits -> String

showList :: [VkExternalFenceFeatureFlagBits] -> ShowS

Storable VkExternalFenceFeatureFlagBits

Methods

sizeOf :: VkExternalFenceFeatureFlagBits -> Int

alignment :: VkExternalFenceFeatureFlagBits -> Int

peekElemOff :: Ptr VkExternalFenceFeatureFlagBits -> Int -> IO VkExternalFenceFeatureFlagBits

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

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

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

peek :: Ptr VkExternalFenceFeatureFlagBits -> IO VkExternalFenceFeatureFlagBits

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

Bits VkExternalFenceFeatureFlagBits

Methods

(.&.) :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits

(.|.) :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits

xor :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits

complement :: VkExternalFenceFeatureFlagBits -> VkExternalFenceFeatureFlagBits

shift :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

rotate :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

zeroBits :: VkExternalFenceFeatureFlagBits

bit :: Int -> VkExternalFenceFeatureFlagBits

setBit :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

clearBit :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

complementBit :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

testBit :: VkExternalFenceFeatureFlagBits -> Int -> Bool

bitSizeMaybe :: VkExternalFenceFeatureFlagBits -> Maybe Int

bitSize :: VkExternalFenceFeatureFlagBits -> Int

isSigned :: VkExternalFenceFeatureFlagBits -> Bool

shiftL :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

unsafeShiftL :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

shiftR :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

unsafeShiftR :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

rotateL :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

rotateR :: VkExternalFenceFeatureFlagBits -> Int -> VkExternalFenceFeatureFlagBits

popCount :: VkExternalFenceFeatureFlagBits -> Int

FiniteBits VkExternalFenceFeatureFlagBits

Methods

finiteBitSize :: VkExternalFenceFeatureFlagBits -> Int

countLeadingZeros :: VkExternalFenceFeatureFlagBits -> Int

countTrailingZeros :: VkExternalFenceFeatureFlagBits -> Int

pattern VK_EXTERNAL_FENCE_FEATURE_EXPORTABLE_BIT :: VkExternalFenceFeatureFlagBits

VK_EXTERNAL_FENCE_FEATURE_EXPORTABLE_BIT specifies handles of this type can be exported from Vulkan fence objects.

pattern VK_EXTERNAL_FENCE_FEATURE_IMPORTABLE_BIT :: VkExternalFenceFeatureFlagBits

VK_EXTERNAL_FENCE_FEATURE_IMPORTABLE_BIT specifies handles of this type can be imported to Vulkan fence objects.

pattern VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO :: VkStructureType

pattern VK_STRUCTURE_TYPE_EXTERNAL_FENCE_PROPERTIES :: VkStructureType

vkGetPhysicalDeviceExternalFenceProperties :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pExternalFenceInfo" ::: Ptr VkPhysicalDeviceExternalFenceInfo) -> ("pExternalFenceProperties" ::: Ptr VkExternalFenceProperties) -> IO ()

vkGetPhysicalDeviceExternalFenceProperties - Function for querying external fence handle capabilities.

Parameters

• physicalDevice is the physical device from which to query the fence capabilities.

• pExternalFenceInfo points to an instance of the VkPhysicalDeviceExternalFenceInfo structure, describing the parameters that would be consumed by vkCreateFence.
• pExternalFenceProperties points to an instance of the VkExternalFenceProperties structure in which capabilities are returned.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle

• pExternalFenceInfo must be a valid pointer to a valid VkPhysicalDeviceExternalFenceInfo structure
• pExternalFenceProperties must be a valid pointer to a VkExternalFenceProperties structure

See Also

VkExternalFenceProperties, VkPhysicalDevice, VkPhysicalDeviceExternalFenceInfo

data VkPhysicalDeviceExternalFenceInfo

VkPhysicalDeviceExternalFenceInfo - Structure specifying fence creation parameters.

Description

Note

Handles of type VK_EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT generated by the implementation may represent either Linux Sync Files or Android Fences at the implementation’s discretion. Applications should only use operations defined for both types of file descriptors, unless they know via means external to Vulkan the type of the file descriptor, or are prepared to deal with the system-defined operation failures resulting from using the wrong type.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_FENCE_INFO

• pNext must be NULL
• handleType must be a valid VkExternalFenceHandleTypeFlagBits value

See Also

VkExternalFenceHandleTypeFlagBits, VkStructureType, vkGetPhysicalDeviceExternalFenceProperties, vkGetPhysicalDeviceExternalFencePropertiesKHR

Constructors

VkPhysicalDeviceExternalFenceInfo

Fields

• vkSType :: VkStructureType

  sType is the type of this structure

• vkPNext :: Ptr ()

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

• vkHandleType :: VkExternalFenceHandleTypeFlagBits

  handleType is a VkExternalFenceHandleTypeFlagBits value indicating an external fence handle type for which capabilities will be returned.

Instances

Eq VkPhysicalDeviceExternalFenceInfo

Methods

(==) :: VkPhysicalDeviceExternalFenceInfo -> VkPhysicalDeviceExternalFenceInfo -> Bool

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

Show VkPhysicalDeviceExternalFenceInfo

Methods

showsPrec :: Int -> VkPhysicalDeviceExternalFenceInfo -> ShowS

show :: VkPhysicalDeviceExternalFenceInfo -> String

showList :: [VkPhysicalDeviceExternalFenceInfo] -> ShowS

Storable VkPhysicalDeviceExternalFenceInfo

Methods

sizeOf :: VkPhysicalDeviceExternalFenceInfo -> Int

alignment :: VkPhysicalDeviceExternalFenceInfo -> Int

peekElemOff :: Ptr VkPhysicalDeviceExternalFenceInfo -> Int -> IO VkPhysicalDeviceExternalFenceInfo

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

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

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

peek :: Ptr VkPhysicalDeviceExternalFenceInfo -> IO VkPhysicalDeviceExternalFenceInfo

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

data VkExternalFenceProperties

VkExternalFenceProperties - Structure describing supported external fence handle features

Description

If handleType is not supported by the implementation, then VkExternalFenceProperties::externalFenceFeatures will be set to zero.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_EXTERNAL_FENCE_PROPERTIES

• pNext must be NULL

See Also

VkExternalFenceFeatureFlags, VkExternalFenceHandleTypeFlags, VkStructureType, vkGetPhysicalDeviceExternalFenceProperties, vkGetPhysicalDeviceExternalFencePropertiesKHR

Constructors

VkExternalFenceProperties

Fields

• vkSType :: VkStructureType
• vkPNext :: Ptr ()
• vkExportFromImportedHandleTypes :: VkExternalFenceHandleTypeFlags

  exportFromImportedHandleTypes is a bitmask of VkExternalFenceHandleTypeFlagBits indicating which types of imported handle handleType can be exported from.

• vkCompatibleHandleTypes :: VkExternalFenceHandleTypeFlags

  compatibleHandleTypes is a bitmask of VkExternalFenceHandleTypeFlagBits specifying handle types which can be specified at the same time as handleType when creating a fence.

• vkExternalFenceFeatures :: VkExternalFenceFeatureFlags

  externalFenceFeatures is a bitmask of VkExternalFenceFeatureFlagBits indicating the features of handleType.

Instances

Eq VkExternalFenceProperties

Methods

(==) :: VkExternalFenceProperties -> VkExternalFenceProperties -> Bool

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

Show VkExternalFenceProperties

Methods

showsPrec :: Int -> VkExternalFenceProperties -> ShowS

show :: VkExternalFenceProperties -> String

showList :: [VkExternalFenceProperties] -> ShowS

Storable VkExternalFenceProperties

Methods

sizeOf :: VkExternalFenceProperties -> Int

alignment :: VkExternalFenceProperties -> Int

peekElemOff :: Ptr VkExternalFenceProperties -> Int -> IO VkExternalFenceProperties

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

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

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

peek :: Ptr VkExternalFenceProperties -> IO VkExternalFenceProperties

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

type VkExternalFenceHandleTypeFlags = VkExternalFenceHandleTypeFlagBits

VkExternalFenceHandleTypeFlags - Bitmask of VkExternalFenceHandleTypeFlagBits

Description

VkExternalFenceHandleTypeFlags is a bitmask type for setting a mask of zero or more VkExternalFenceHandleTypeFlagBits.

See Also

VkExportFenceCreateInfo, VkExternalFenceHandleTypeFlagBits, VkExternalFenceProperties

type VkExternalFenceFeatureFlags = VkExternalFenceFeatureFlagBits

VkExternalFenceFeatureFlags - Bitmask of VkExternalFenceFeatureFlagBits

Description

VkExternalFenceFeatureFlags is a bitmask type for setting a mask of zero or more VkExternalFenceFeatureFlagBits.

See Also

VkExternalFenceFeatureFlagBits, VkExternalFenceProperties