Graphics.Vulkan.Core10.Device

Documentation

newtype VkDeviceCreateFlags

VkDeviceCreateFlags - Reserved for future use

Description

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

See Also

VkDeviceCreateInfo

Constructors

VkDeviceCreateFlags VkFlags

Instances

Eq VkDeviceCreateFlags

Methods

(==) :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> Bool

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

Ord VkDeviceCreateFlags

Methods

compare :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> Ordering

(<) :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> Bool

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

(>) :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> Bool

(>=) :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> Bool

max :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> VkDeviceCreateFlags

min :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> VkDeviceCreateFlags

Read VkDeviceCreateFlags

Methods

readsPrec :: Int -> ReadS VkDeviceCreateFlags

readList :: ReadS [VkDeviceCreateFlags]

readPrec :: ReadPrec VkDeviceCreateFlags

readListPrec :: ReadPrec [VkDeviceCreateFlags]

Show VkDeviceCreateFlags

Methods

showsPrec :: Int -> VkDeviceCreateFlags -> ShowS

show :: VkDeviceCreateFlags -> String

showList :: [VkDeviceCreateFlags] -> ShowS

Storable VkDeviceCreateFlags

Methods

sizeOf :: VkDeviceCreateFlags -> Int

alignment :: VkDeviceCreateFlags -> Int

peekElemOff :: Ptr VkDeviceCreateFlags -> Int -> IO VkDeviceCreateFlags

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

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

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

peek :: Ptr VkDeviceCreateFlags -> IO VkDeviceCreateFlags

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

Bits VkDeviceCreateFlags

Methods

(.&.) :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> VkDeviceCreateFlags

(.|.) :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> VkDeviceCreateFlags

xor :: VkDeviceCreateFlags -> VkDeviceCreateFlags -> VkDeviceCreateFlags

complement :: VkDeviceCreateFlags -> VkDeviceCreateFlags

shift :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

rotate :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

zeroBits :: VkDeviceCreateFlags

bit :: Int -> VkDeviceCreateFlags

setBit :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

clearBit :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

complementBit :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

testBit :: VkDeviceCreateFlags -> Int -> Bool

bitSizeMaybe :: VkDeviceCreateFlags -> Maybe Int

bitSize :: VkDeviceCreateFlags -> Int

isSigned :: VkDeviceCreateFlags -> Bool

shiftL :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

unsafeShiftL :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

shiftR :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

unsafeShiftR :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

rotateL :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

rotateR :: VkDeviceCreateFlags -> Int -> VkDeviceCreateFlags

popCount :: VkDeviceCreateFlags -> Int

FiniteBits VkDeviceCreateFlags

Methods

finiteBitSize :: VkDeviceCreateFlags -> Int

countLeadingZeros :: VkDeviceCreateFlags -> Int

countTrailingZeros :: VkDeviceCreateFlags -> Int

newtype VkDeviceQueueCreateFlagBits

VkDeviceQueueCreateFlagBits - Bitmask specifying behavior of the queue

See Also

VkDeviceQueueCreateFlags

Constructors

VkDeviceQueueCreateFlagBits VkFlags

Instances

Eq VkDeviceQueueCreateFlagBits

Methods

(==) :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> Bool

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

Ord VkDeviceQueueCreateFlagBits

Methods

compare :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> Ordering

(<) :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> Bool

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

(>) :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> Bool

(>=) :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> Bool

max :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits

min :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits

Read VkDeviceQueueCreateFlagBits

Methods

readsPrec :: Int -> ReadS VkDeviceQueueCreateFlagBits

readList :: ReadS [VkDeviceQueueCreateFlagBits]

readPrec :: ReadPrec VkDeviceQueueCreateFlagBits

readListPrec :: ReadPrec [VkDeviceQueueCreateFlagBits]

Show VkDeviceQueueCreateFlagBits

Methods

showsPrec :: Int -> VkDeviceQueueCreateFlagBits -> ShowS

show :: VkDeviceQueueCreateFlagBits -> String

showList :: [VkDeviceQueueCreateFlagBits] -> ShowS

Storable VkDeviceQueueCreateFlagBits

Methods

sizeOf :: VkDeviceQueueCreateFlagBits -> Int

alignment :: VkDeviceQueueCreateFlagBits -> Int

peekElemOff :: Ptr VkDeviceQueueCreateFlagBits -> Int -> IO VkDeviceQueueCreateFlagBits

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

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

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

peek :: Ptr VkDeviceQueueCreateFlagBits -> IO VkDeviceQueueCreateFlagBits

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

Bits VkDeviceQueueCreateFlagBits

Methods

(.&.) :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits

(.|.) :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits

xor :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits

complement :: VkDeviceQueueCreateFlagBits -> VkDeviceQueueCreateFlagBits

shift :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

rotate :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

zeroBits :: VkDeviceQueueCreateFlagBits

bit :: Int -> VkDeviceQueueCreateFlagBits

setBit :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

clearBit :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

complementBit :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

testBit :: VkDeviceQueueCreateFlagBits -> Int -> Bool

bitSizeMaybe :: VkDeviceQueueCreateFlagBits -> Maybe Int

bitSize :: VkDeviceQueueCreateFlagBits -> Int

isSigned :: VkDeviceQueueCreateFlagBits -> Bool

shiftL :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

unsafeShiftL :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

shiftR :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

unsafeShiftR :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

rotateL :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

rotateR :: VkDeviceQueueCreateFlagBits -> Int -> VkDeviceQueueCreateFlagBits

popCount :: VkDeviceQueueCreateFlagBits -> Int

FiniteBits VkDeviceQueueCreateFlagBits

Methods

finiteBitSize :: VkDeviceQueueCreateFlagBits -> Int

countLeadingZeros :: VkDeviceQueueCreateFlagBits -> Int

countTrailingZeros :: VkDeviceQueueCreateFlagBits -> Int

vkCreateDevice :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pCreateInfo" ::: Ptr VkDeviceCreateInfo) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pDevice" ::: Ptr VkDevice) -> IO VkResult

vkCreateDevice - Create a new device instance

Parameters

• physicalDevice must be one of the device handles returned from a call to vkEnumeratePhysicalDevices (see Physical Device Enumeration).

• pCreateInfo is a pointer to a VkDeviceCreateInfo structure containing information about how to create the device.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pDevice points to a handle in which the created VkDevice is returned.

Description

vkCreateDevice verifies that extensions and features requested in the ppEnabledExtensionNames and pEnabledFeatures members of pCreateInfo, respectively, are supported by the implementation. If any requested extension is not supported, vkCreateDevice must return VK_ERROR_EXTENSION_NOT_PRESENT. If any requested feature is not supported, vkCreateDevice must return VK_ERROR_FEATURE_NOT_PRESENT. Support for extensions can be checked before creating a device by querying vkEnumerateDeviceExtensionProperties. Support for features can similarly be checked by querying vkGetPhysicalDeviceFeatures.

After verifying and enabling the extensions the VkDevice object is created and returned to the application. If a requested extension is only supported by a layer, both the layer and the extension need to be specified at vkCreateInstance time for the creation to succeed.

Multiple logical devices can be created from the same physical device. Logical device creation may fail due to lack of device-specific resources (in addition to the other errors). If that occurs, vkCreateDevice will return VK_ERROR_TOO_MANY_OBJECTS.

Valid Usage

• All required extensions for each extension in the VkDeviceCreateInfo::ppEnabledExtensionNames list must also be present in that list.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle

• pCreateInfo must be a valid pointer to a valid VkDeviceCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pDevice must be a valid pointer to a VkDevice handle

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

• VK_ERROR_INITIALIZATION_FAILED

• VK_ERROR_EXTENSION_NOT_PRESENT

• VK_ERROR_FEATURE_NOT_PRESENT

• VK_ERROR_TOO_MANY_OBJECTS

• VK_ERROR_DEVICE_LOST

See Also

VkAllocationCallbacks, VkDevice, VkDeviceCreateInfo, VkPhysicalDevice

vkDestroyDevice :: ("device" ::: VkDevice) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> IO ()

vkDestroyDevice - Destroy a logical device

Parameters

• device is the logical device to destroy.

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

Description

To ensure that no work is active on the device, vkDeviceWaitIdle can be used to gate the destruction of the device. Prior to destroying a device, an application is responsible for destroying/freeing any Vulkan objects that were created using that device as the first parameter of the corresponding vkCreate* or vkAllocate* command.

Note

The lifetime of each of these objects is bound by the lifetime of the VkDevice object. Therefore, to avoid resource leaks, it is critical that an application explicitly free all of these resources prior to calling vkDestroyDevice.

Valid Usage

• All child objects created on device must have been destroyed prior to destroying device

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

Valid Usage (Implicit)

• If device is not NULL, device must be a valid VkDevice handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure

Host Synchronization

• Host access to device must be externally synchronized

See Also

VkAllocationCallbacks, VkDevice

data VkDeviceQueueCreateInfo

VkDeviceQueueCreateInfo - Structure specifying parameters of a newly created device queue

Description

Valid Usage

• queueFamilyIndex must be less than pQueueFamilyPropertyCount returned by vkGetPhysicalDeviceQueueFamilyProperties

• queueCount must be less than or equal to the queueCount member of the VkQueueFamilyProperties structure, as returned by vkGetPhysicalDeviceQueueFamilyProperties in the pQueueFamilyProperties[queueFamilyIndex]
• Each element of pQueuePriorities must be between 0.0 and 1.0 inclusive

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of VkDeviceQueueGlobalPriorityCreateInfoEXT
• flags must be a valid combination of VkDeviceQueueCreateFlagBits values
• pQueuePriorities must be a valid pointer to an array of queueCount float values
• queueCount must be greater than 0

See Also

VkDeviceCreateInfo, VkDeviceQueueCreateFlags, VkStructureType

Constructors

VkDeviceQueueCreateInfo

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkFlags :: VkDeviceQueueCreateFlags

  flags is reserved for future use.

• vkQueueFamilyIndex :: Word32

  queueFamilyIndex is an unsigned integer indicating the index of the queue family to create on this device. This index corresponds to the index of an element of the pQueueFamilyProperties array that was returned by vkGetPhysicalDeviceQueueFamilyProperties.

• vkQueueCount :: Word32

  queueCount is an unsigned integer specifying the number of queues to create in the queue family indicated by queueFamilyIndex.

• vkPQueuePriorities :: Ptr CFloat

  pQueuePriorities is an array of queueCount normalized floating point values, specifying priorities of work that will be submitted to each created queue. See Queue Priority for more information.

Instances

Eq VkDeviceQueueCreateInfo

Methods

(==) :: VkDeviceQueueCreateInfo -> VkDeviceQueueCreateInfo -> Bool

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

Show VkDeviceQueueCreateInfo

Methods

showsPrec :: Int -> VkDeviceQueueCreateInfo -> ShowS

show :: VkDeviceQueueCreateInfo -> String

showList :: [VkDeviceQueueCreateInfo] -> ShowS

Storable VkDeviceQueueCreateInfo

Methods

sizeOf :: VkDeviceQueueCreateInfo -> Int

alignment :: VkDeviceQueueCreateInfo -> Int

peekElemOff :: Ptr VkDeviceQueueCreateInfo -> Int -> IO VkDeviceQueueCreateInfo

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

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

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

peek :: Ptr VkDeviceQueueCreateInfo -> IO VkDeviceQueueCreateInfo

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

data VkDeviceCreateInfo

VkDeviceCreateInfo - Structure specifying parameters of a newly created device

Description

Valid Usage

• The queueFamilyIndex member of each element of pQueueCreateInfos must be unique within pQueueCreateInfos

• If the pNext chain includes a VkPhysicalDeviceFeatures2 structure, then pEnabledFeatures must be NULL
• ppEnabledExtensionNames must not contain both {html_spec_relative}#VK_KHR_maintenance1 and {html_spec_relative}#VK_AMD_negative_viewport_height

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DEVICE_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 VkDeviceGroupDeviceCreateInfo, VkPhysicalDevice16BitStorageFeatures, VkPhysicalDeviceDescriptorIndexingFeaturesEXT, VkPhysicalDeviceFeatures2, VkPhysicalDeviceMultiviewFeatures, VkPhysicalDeviceProtectedMemoryFeatures, VkPhysicalDeviceSamplerYcbcrConversionFeatures, or VkPhysicalDeviceVariablePointerFeatures
• Each sType member in the pNext chain must be unique
• flags must be 0
• pQueueCreateInfos must be a valid pointer to an array of queueCreateInfoCount valid VkDeviceQueueCreateInfo structures
• If enabledLayerCount is not 0, ppEnabledLayerNames must be a valid pointer to an array of enabledLayerCount null-terminated UTF-8 strings
• If enabledExtensionCount is not 0, ppEnabledExtensionNames must be a valid pointer to an array of enabledExtensionCount null-terminated UTF-8 strings
• If pEnabledFeatures is not NULL, pEnabledFeatures must be a valid pointer to a valid VkPhysicalDeviceFeatures structure
• queueCreateInfoCount must be greater than 0

See Also

VkDeviceCreateFlags, VkDeviceQueueCreateInfo, VkPhysicalDeviceFeatures, VkStructureType, vkCreateDevice

Constructors

VkDeviceCreateInfo

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkFlags :: VkDeviceCreateFlags

  flags is reserved for future use.

• vkQueueCreateInfoCount :: Word32

  queueCreateInfoCount is the unsigned integer size of the pQueueCreateInfos array. Refer to the Queue Creation section below for further details.

• vkPQueueCreateInfos :: Ptr VkDeviceQueueCreateInfo

  pQueueCreateInfos is a pointer to an array of VkDeviceQueueCreateInfo structures describing the queues that are requested to be created along with the logical device. Refer to the Queue Creation section below for further details.

• vkEnabledLayerCount :: Word32

  enabledLayerCount is deprecated and ignored.

• vkPPEnabledLayerNames :: Ptr (Ptr CChar)

  ppEnabledLayerNames is deprecated and ignored. See Device Layer Deprecation.

• vkEnabledExtensionCount :: Word32

  enabledExtensionCount is the number of device extensions to enable.

• vkPPEnabledExtensionNames :: Ptr (Ptr CChar)

  ppEnabledExtensionNames is a pointer to an array of enabledExtensionCount null-terminated UTF-8 strings containing the names of extensions to enable for the created device. See the Extensions section for further details.

• vkPEnabledFeatures :: Ptr VkPhysicalDeviceFeatures

  pEnabledFeatures is NULL or a pointer to a VkPhysicalDeviceFeatures structure that contains boolean indicators of all the features to be enabled. Refer to the Features section for further details.

Instances

Eq VkDeviceCreateInfo

Methods

(==) :: VkDeviceCreateInfo -> VkDeviceCreateInfo -> Bool

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

Show VkDeviceCreateInfo

Methods

showsPrec :: Int -> VkDeviceCreateInfo -> ShowS

show :: VkDeviceCreateInfo -> String

showList :: [VkDeviceCreateInfo] -> ShowS

Storable VkDeviceCreateInfo

Methods

sizeOf :: VkDeviceCreateInfo -> Int

alignment :: VkDeviceCreateInfo -> Int

peekElemOff :: Ptr VkDeviceCreateInfo -> Int -> IO VkDeviceCreateInfo

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

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

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

peek :: Ptr VkDeviceCreateInfo -> IO VkDeviceCreateInfo

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

type VkDeviceQueueCreateFlags = VkDeviceQueueCreateFlagBits

VkDeviceQueueCreateFlags - Bitmask of VkDeviceQueueCreateFlagBits

Description

VkDeviceQueueCreateFlags is a bitmask type for setting a mask of zero or more VkDeviceQueueCreateFlagBits.

See Also

VkDeviceQueueCreateFlagBits, VkDeviceQueueCreateInfo, VkDeviceQueueInfo2