Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_private_data

Synopsis

createPrivateDataSlotEXT :: forall io. MonadIO io => Device -> PrivateDataSlotCreateInfoEXT -> ("allocator" ::: Maybe AllocationCallbacks) -> io PrivateDataSlotEXT
withPrivateDataSlotEXT :: forall io r. MonadIO io => Device -> PrivateDataSlotCreateInfoEXT -> Maybe AllocationCallbacks -> (io PrivateDataSlotEXT -> (PrivateDataSlotEXT -> io ()) -> r) -> r
destroyPrivateDataSlotEXT :: forall io. MonadIO io => Device -> PrivateDataSlotEXT -> ("allocator" ::: Maybe AllocationCallbacks) -> io ()
setPrivateDataEXT :: forall io. MonadIO io => Device -> ObjectType -> ("objectHandle" ::: Word64) -> PrivateDataSlotEXT -> ("data" ::: Word64) -> io ()
getPrivateDataEXT :: forall io. MonadIO io => Device -> ObjectType -> ("objectHandle" ::: Word64) -> PrivateDataSlotEXT -> io ("data" ::: Word64)
data DevicePrivateDataCreateInfoEXT = DevicePrivateDataCreateInfoEXT {
- privateDataSlotRequestCount :: Word32
}
data PrivateDataSlotCreateInfoEXT = PrivateDataSlotCreateInfoEXT {
- flags :: PrivateDataSlotCreateFlagsEXT
}
data PhysicalDevicePrivateDataFeaturesEXT = PhysicalDevicePrivateDataFeaturesEXT {
- privateData :: Bool
}
newtype PrivateDataSlotCreateFlagBitsEXT = PrivateDataSlotCreateFlagBitsEXT Flags
type PrivateDataSlotCreateFlagsEXT = PrivateDataSlotCreateFlagBitsEXT
type EXT_PRIVATE_DATA_SPEC_VERSION = 1
pattern EXT_PRIVATE_DATA_SPEC_VERSION :: forall a. Integral a => a
type EXT_PRIVATE_DATA_EXTENSION_NAME = "VK_EXT_private_data"
pattern EXT_PRIVATE_DATA_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
newtype PrivateDataSlotEXT = PrivateDataSlotEXT Word64

Documentation

createPrivateDataSlotEXT :: forall io. MonadIO io => Device -> PrivateDataSlotCreateInfoEXT -> ("allocator" ::: Maybe AllocationCallbacks) -> io PrivateDataSlotEXT Source #

vkCreatePrivateDataSlotEXT - Create a slot for private data storage

Parameters

device is the logical device associated with the creation of the object(s) holding the private data slot.

pCreateInfo is a pointer to a PrivateDataSlotCreateInfoEXT
pAllocator controls host memory allocation as described in the Memory Allocation chapter.
pPrivateDataSlot is a pointer to a PrivateDataSlotEXT handle in which the resulting private data slot is returned

Valid Usage (Implicit)

device must be a valid Device handle

pCreateInfo must be a valid pointer to a valid PrivateDataSlotCreateInfoEXT structure
If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
pPrivateDataSlot must be a valid pointer to a PrivateDataSlotEXT handle

Return Codes

Success

SUCCESS

Failure

ERROR_OUT_OF_HOST_MEMORY

Parameters

device is the logical device associated with the creation of the object(s) holding the private data slot.

pAllocator controls host memory allocation as described in the Memory Allocation chapter.
privateDataSlot is the private data slot to destroy.

Parameters

device is the device that created the object.

objectType is a ObjectType specifying the type of object to associate data with.
objectHandle is a handle to the object to associate data with.
privateDataSlot is a handle to a PrivateDataSlotEXT specifying location of private data storage.
data is user defined data to associate the object with. This data will be stored at privateDataSlot.

Return Codes

Success

SUCCESS

Failure

ERROR_OUT_OF_HOST_MEMORY

Parameters

device is the device that created the object

objectType is a ObjectType specifying the type of object data is associated with.
objectHandle is a handle to the object data is associated with.
privateDataSlot is a handle to a PrivateDataSlotEXT specifying location of private data pointer storage.
pData is a pointer to specify where user data is returned. 0 will be written in the absence of a previous call to setPrivateDataEXT using the object specified by objectHandle.

Description

Note

Due to platform details on Android, implementations might not be able to reliably return 0 from calls to getPrivateDataEXT for SwapchainKHR objects on which setPrivateDataEXT has not previously been called. This erratum is exclusive to the Android platform and objects of type SwapchainKHR.

Valid Usage (Implicit)

Members

The members of the PhysicalDevicePrivateDataFeaturesEXT structure describe the following features:

Description

If the PhysicalDevicePrivateDataFeaturesEXT structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDevicePrivateDataFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to enable the features.

Valid Usage (Implicit)

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

type PrivateDataSlotCreateFlagsEXT = PrivateDataSlotCreateFlagBitsEXT Source #

type EXT_PRIVATE_DATA_SPEC_VERSION = 1 Source #

pattern EXT_PRIVATE_DATA_SPEC_VERSION :: forall a. Integral a => a Source #

type EXT_PRIVATE_DATA_EXTENSION_NAME = "VK_EXT_private_data" Source #

pattern EXT_PRIVATE_DATA_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

newtype PrivateDataSlotEXT Source #

VkPrivateDataSlotEXT - Opaque handle to a private data slot object

Show DevicePrivateDataCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods showsPrec :: Int -> DevicePrivateDataCreateInfoEXT -> ShowS # show :: DevicePrivateDataCreateInfoEXT -> String # showList :: [DevicePrivateDataCreateInfoEXT] -> ShowS #
Storable DevicePrivateDataCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods sizeOf :: DevicePrivateDataCreateInfoEXT -> Int # alignment :: DevicePrivateDataCreateInfoEXT -> Int # peekElemOff :: Ptr DevicePrivateDataCreateInfoEXT -> Int -> IO DevicePrivateDataCreateInfoEXT # pokeElemOff :: Ptr DevicePrivateDataCreateInfoEXT -> Int -> DevicePrivateDataCreateInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO DevicePrivateDataCreateInfoEXT # pokeByteOff :: Ptr b -> Int -> DevicePrivateDataCreateInfoEXT -> IO () # peek :: Ptr DevicePrivateDataCreateInfoEXT -> IO DevicePrivateDataCreateInfoEXT # poke :: Ptr DevicePrivateDataCreateInfoEXT -> DevicePrivateDataCreateInfoEXT -> IO () #
FromCStruct DevicePrivateDataCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods peekCStruct :: Ptr DevicePrivateDataCreateInfoEXT -> IO DevicePrivateDataCreateInfoEXT Source #
ToCStruct DevicePrivateDataCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods withCStruct :: DevicePrivateDataCreateInfoEXT -> (Ptr DevicePrivateDataCreateInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr DevicePrivateDataCreateInfoEXT -> DevicePrivateDataCreateInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr DevicePrivateDataCreateInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr DevicePrivateDataCreateInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero DevicePrivateDataCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods zero :: DevicePrivateDataCreateInfoEXT Source #

Show PrivateDataSlotCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods showsPrec :: Int -> PrivateDataSlotCreateInfoEXT -> ShowS # show :: PrivateDataSlotCreateInfoEXT -> String # showList :: [PrivateDataSlotCreateInfoEXT] -> ShowS #
Storable PrivateDataSlotCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods sizeOf :: PrivateDataSlotCreateInfoEXT -> Int # alignment :: PrivateDataSlotCreateInfoEXT -> Int # peekElemOff :: Ptr PrivateDataSlotCreateInfoEXT -> Int -> IO PrivateDataSlotCreateInfoEXT # pokeElemOff :: Ptr PrivateDataSlotCreateInfoEXT -> Int -> PrivateDataSlotCreateInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PrivateDataSlotCreateInfoEXT # pokeByteOff :: Ptr b -> Int -> PrivateDataSlotCreateInfoEXT -> IO () # peek :: Ptr PrivateDataSlotCreateInfoEXT -> IO PrivateDataSlotCreateInfoEXT # poke :: Ptr PrivateDataSlotCreateInfoEXT -> PrivateDataSlotCreateInfoEXT -> IO () #
FromCStruct PrivateDataSlotCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods peekCStruct :: Ptr PrivateDataSlotCreateInfoEXT -> IO PrivateDataSlotCreateInfoEXT Source #
ToCStruct PrivateDataSlotCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods withCStruct :: PrivateDataSlotCreateInfoEXT -> (Ptr PrivateDataSlotCreateInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PrivateDataSlotCreateInfoEXT -> PrivateDataSlotCreateInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PrivateDataSlotCreateInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PrivateDataSlotCreateInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PrivateDataSlotCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods zero :: PrivateDataSlotCreateInfoEXT Source #

Show PhysicalDevicePrivateDataFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods showsPrec :: Int -> PhysicalDevicePrivateDataFeaturesEXT -> ShowS # show :: PhysicalDevicePrivateDataFeaturesEXT -> String # showList :: [PhysicalDevicePrivateDataFeaturesEXT] -> ShowS #
Storable PhysicalDevicePrivateDataFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods sizeOf :: PhysicalDevicePrivateDataFeaturesEXT -> Int # alignment :: PhysicalDevicePrivateDataFeaturesEXT -> Int # peekElemOff :: Ptr PhysicalDevicePrivateDataFeaturesEXT -> Int -> IO PhysicalDevicePrivateDataFeaturesEXT # pokeElemOff :: Ptr PhysicalDevicePrivateDataFeaturesEXT -> Int -> PhysicalDevicePrivateDataFeaturesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDevicePrivateDataFeaturesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDevicePrivateDataFeaturesEXT -> IO () # peek :: Ptr PhysicalDevicePrivateDataFeaturesEXT -> IO PhysicalDevicePrivateDataFeaturesEXT # poke :: Ptr PhysicalDevicePrivateDataFeaturesEXT -> PhysicalDevicePrivateDataFeaturesEXT -> IO () #
FromCStruct PhysicalDevicePrivateDataFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods peekCStruct :: Ptr PhysicalDevicePrivateDataFeaturesEXT -> IO PhysicalDevicePrivateDataFeaturesEXT Source #
ToCStruct PhysicalDevicePrivateDataFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods withCStruct :: PhysicalDevicePrivateDataFeaturesEXT -> (Ptr PhysicalDevicePrivateDataFeaturesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDevicePrivateDataFeaturesEXT -> PhysicalDevicePrivateDataFeaturesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDevicePrivateDataFeaturesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDevicePrivateDataFeaturesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDevicePrivateDataFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_private_data Methods zero :: PhysicalDevicePrivateDataFeaturesEXT Source #

Eq PrivateDataSlotEXT Source #
Instance details Defined in Vulkan.Extensions.Handles Methods (==) :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> Bool # (/=) :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> Bool #
Ord PrivateDataSlotEXT Source #
Instance details Defined in Vulkan.Extensions.Handles Methods compare :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> Ordering # (<) :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> Bool # (<=) :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> Bool # (>) :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> Bool # (>=) :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> Bool # max :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> PrivateDataSlotEXT # min :: PrivateDataSlotEXT -> PrivateDataSlotEXT -> PrivateDataSlotEXT #
Show PrivateDataSlotEXT Source #
Instance details Defined in Vulkan.Extensions.Handles Methods showsPrec :: Int -> PrivateDataSlotEXT -> ShowS # show :: PrivateDataSlotEXT -> String # showList :: [PrivateDataSlotEXT] -> ShowS #
Storable PrivateDataSlotEXT Source #
Instance details Defined in Vulkan.Extensions.Handles Methods sizeOf :: PrivateDataSlotEXT -> Int # alignment :: PrivateDataSlotEXT -> Int # peekElemOff :: Ptr PrivateDataSlotEXT -> Int -> IO PrivateDataSlotEXT # pokeElemOff :: Ptr PrivateDataSlotEXT -> Int -> PrivateDataSlotEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PrivateDataSlotEXT # pokeByteOff :: Ptr b -> Int -> PrivateDataSlotEXT -> IO () # peek :: Ptr PrivateDataSlotEXT -> IO PrivateDataSlotEXT # poke :: Ptr PrivateDataSlotEXT -> PrivateDataSlotEXT -> IO () #
Zero PrivateDataSlotEXT Source #
Instance details Defined in Vulkan.Extensions.Handles Methods zero :: PrivateDataSlotEXT Source #
HasObjectType PrivateDataSlotEXT Source #
Instance details Defined in Vulkan.Extensions.Handles Methods objectTypeAndHandle :: PrivateDataSlotEXT -> (ObjectType, Word64) Source #
IsHandle PrivateDataSlotEXT Source #
Instance details Defined in Vulkan.Extensions.Handles

Documentation

Parameters

Valid Usage (Implicit)

Return Codes

See Also

Parameters

See Also

Parameters

Return Codes

See Also

Parameters

Description

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

See Also

Instances

DevicePrivateDataCreateInfoEXT
Fields privateDataSlotRequestCount :: Word32 `privateDataSlotRequestCount` is the amount of slots to reserve.

PrivateDataSlotCreateInfoEXT
Fields flags :: PrivateDataSlotCreateFlagsEXT `flags` must be `0`

PhysicalDevicePrivateDataFeaturesEXT
Fields privateData :: Bool `privateData` indicates whether the implementation supports private data. See Private Data.