Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- createInstance :: PokeChain a => InstanceCreateInfo a -> ("allocator" ::: Maybe AllocationCallbacks) -> IO Instance
- withInstance :: PokeChain a => InstanceCreateInfo a -> Maybe AllocationCallbacks -> (Instance -> IO r) -> IO r
- destroyInstance :: Instance -> ("allocator" ::: Maybe AllocationCallbacks) -> IO ()
- enumeratePhysicalDevices :: Instance -> IO (Result, "physicalDevices" ::: Vector PhysicalDevice)
- getDeviceProcAddr :: Device -> ("name" ::: ByteString) -> IO PFN_vkVoidFunction
- getInstanceProcAddr :: Instance -> ("name" ::: ByteString) -> IO PFN_vkVoidFunction
- getPhysicalDeviceProperties :: PhysicalDevice -> IO PhysicalDeviceProperties
- getPhysicalDeviceQueueFamilyProperties :: PhysicalDevice -> IO ("queueFamilyProperties" ::: Vector QueueFamilyProperties)
- getPhysicalDeviceMemoryProperties :: PhysicalDevice -> IO PhysicalDeviceMemoryProperties
- getPhysicalDeviceFeatures :: PhysicalDevice -> IO PhysicalDeviceFeatures
- getPhysicalDeviceFormatProperties :: PhysicalDevice -> Format -> IO FormatProperties
- getPhysicalDeviceImageFormatProperties :: PhysicalDevice -> Format -> ImageType -> ImageTiling -> ImageUsageFlags -> ImageCreateFlags -> IO ImageFormatProperties
- data PhysicalDeviceProperties = PhysicalDeviceProperties {}
- data ApplicationInfo = ApplicationInfo {}
- data InstanceCreateInfo (es :: [Type]) = InstanceCreateInfo {}
- data QueueFamilyProperties = QueueFamilyProperties {}
- data PhysicalDeviceMemoryProperties = PhysicalDeviceMemoryProperties {}
- data MemoryType = MemoryType {}
- data MemoryHeap = MemoryHeap {}
- data FormatProperties = FormatProperties {}
- data ImageFormatProperties = ImageFormatProperties {}
- data PhysicalDeviceFeatures = PhysicalDeviceFeatures {
- robustBufferAccess :: Bool
- fullDrawIndexUint32 :: Bool
- imageCubeArray :: Bool
- independentBlend :: Bool
- geometryShader :: Bool
- tessellationShader :: Bool
- sampleRateShading :: Bool
- dualSrcBlend :: Bool
- logicOp :: Bool
- multiDrawIndirect :: Bool
- drawIndirectFirstInstance :: Bool
- depthClamp :: Bool
- depthBiasClamp :: Bool
- fillModeNonSolid :: Bool
- depthBounds :: Bool
- wideLines :: Bool
- largePoints :: Bool
- alphaToOne :: Bool
- multiViewport :: Bool
- samplerAnisotropy :: Bool
- textureCompressionETC2 :: Bool
- textureCompressionASTC_LDR :: Bool
- textureCompressionBC :: Bool
- occlusionQueryPrecise :: Bool
- pipelineStatisticsQuery :: Bool
- vertexPipelineStoresAndAtomics :: Bool
- fragmentStoresAndAtomics :: Bool
- shaderTessellationAndGeometryPointSize :: Bool
- shaderImageGatherExtended :: Bool
- shaderStorageImageExtendedFormats :: Bool
- shaderStorageImageMultisample :: Bool
- shaderStorageImageReadWithoutFormat :: Bool
- shaderStorageImageWriteWithoutFormat :: Bool
- shaderUniformBufferArrayDynamicIndexing :: Bool
- shaderSampledImageArrayDynamicIndexing :: Bool
- shaderStorageBufferArrayDynamicIndexing :: Bool
- shaderStorageImageArrayDynamicIndexing :: Bool
- shaderClipDistance :: Bool
- shaderCullDistance :: Bool
- shaderFloat64 :: Bool
- shaderInt64 :: Bool
- shaderInt16 :: Bool
- shaderResourceResidency :: Bool
- shaderResourceMinLod :: Bool
- sparseBinding :: Bool
- sparseResidencyBuffer :: Bool
- sparseResidencyImage2D :: Bool
- sparseResidencyImage3D :: Bool
- sparseResidency2Samples :: Bool
- sparseResidency4Samples :: Bool
- sparseResidency8Samples :: Bool
- sparseResidency16Samples :: Bool
- sparseResidencyAliased :: Bool
- variableMultisampleRate :: Bool
- inheritedQueries :: Bool
- data PhysicalDeviceSparseProperties = PhysicalDeviceSparseProperties {}
- data PhysicalDeviceLimits = PhysicalDeviceLimits {
- maxImageDimension1D :: Word32
- maxImageDimension2D :: Word32
- maxImageDimension3D :: Word32
- maxImageDimensionCube :: Word32
- maxImageArrayLayers :: Word32
- maxTexelBufferElements :: Word32
- maxUniformBufferRange :: Word32
- maxStorageBufferRange :: Word32
- maxPushConstantsSize :: Word32
- maxMemoryAllocationCount :: Word32
- maxSamplerAllocationCount :: Word32
- bufferImageGranularity :: DeviceSize
- sparseAddressSpaceSize :: DeviceSize
- maxBoundDescriptorSets :: Word32
- maxPerStageDescriptorSamplers :: Word32
- maxPerStageDescriptorUniformBuffers :: Word32
- maxPerStageDescriptorStorageBuffers :: Word32
- maxPerStageDescriptorSampledImages :: Word32
- maxPerStageDescriptorStorageImages :: Word32
- maxPerStageDescriptorInputAttachments :: Word32
- maxPerStageResources :: Word32
- maxDescriptorSetSamplers :: Word32
- maxDescriptorSetUniformBuffers :: Word32
- maxDescriptorSetUniformBuffersDynamic :: Word32
- maxDescriptorSetStorageBuffers :: Word32
- maxDescriptorSetStorageBuffersDynamic :: Word32
- maxDescriptorSetSampledImages :: Word32
- maxDescriptorSetStorageImages :: Word32
- maxDescriptorSetInputAttachments :: Word32
- maxVertexInputAttributes :: Word32
- maxVertexInputBindings :: Word32
- maxVertexInputAttributeOffset :: Word32
- maxVertexInputBindingStride :: Word32
- maxVertexOutputComponents :: Word32
- maxTessellationGenerationLevel :: Word32
- maxTessellationPatchSize :: Word32
- maxTessellationControlPerVertexInputComponents :: Word32
- maxTessellationControlPerVertexOutputComponents :: Word32
- maxTessellationControlPerPatchOutputComponents :: Word32
- maxTessellationControlTotalOutputComponents :: Word32
- maxTessellationEvaluationInputComponents :: Word32
- maxTessellationEvaluationOutputComponents :: Word32
- maxGeometryShaderInvocations :: Word32
- maxGeometryInputComponents :: Word32
- maxGeometryOutputComponents :: Word32
- maxGeometryOutputVertices :: Word32
- maxGeometryTotalOutputComponents :: Word32
- maxFragmentInputComponents :: Word32
- maxFragmentOutputAttachments :: Word32
- maxFragmentDualSrcAttachments :: Word32
- maxFragmentCombinedOutputResources :: Word32
- maxComputeSharedMemorySize :: Word32
- maxComputeWorkGroupCount :: (Word32, Word32, Word32)
- maxComputeWorkGroupInvocations :: Word32
- maxComputeWorkGroupSize :: (Word32, Word32, Word32)
- subPixelPrecisionBits :: Word32
- subTexelPrecisionBits :: Word32
- mipmapPrecisionBits :: Word32
- maxDrawIndexedIndexValue :: Word32
- maxDrawIndirectCount :: Word32
- maxSamplerLodBias :: Float
- maxSamplerAnisotropy :: Float
- maxViewports :: Word32
- maxViewportDimensions :: (Word32, Word32)
- viewportBoundsRange :: (Float, Float)
- viewportSubPixelBits :: Word32
- minMemoryMapAlignment :: Word64
- minTexelBufferOffsetAlignment :: DeviceSize
- minUniformBufferOffsetAlignment :: DeviceSize
- minStorageBufferOffsetAlignment :: DeviceSize
- minTexelOffset :: Int32
- maxTexelOffset :: Word32
- minTexelGatherOffset :: Int32
- maxTexelGatherOffset :: Word32
- minInterpolationOffset :: Float
- maxInterpolationOffset :: Float
- subPixelInterpolationOffsetBits :: Word32
- maxFramebufferWidth :: Word32
- maxFramebufferHeight :: Word32
- maxFramebufferLayers :: Word32
- framebufferColorSampleCounts :: SampleCountFlags
- framebufferDepthSampleCounts :: SampleCountFlags
- framebufferStencilSampleCounts :: SampleCountFlags
- framebufferNoAttachmentsSampleCounts :: SampleCountFlags
- maxColorAttachments :: Word32
- sampledImageColorSampleCounts :: SampleCountFlags
- sampledImageIntegerSampleCounts :: SampleCountFlags
- sampledImageDepthSampleCounts :: SampleCountFlags
- sampledImageStencilSampleCounts :: SampleCountFlags
- storageImageSampleCounts :: SampleCountFlags
- maxSampleMaskWords :: Word32
- timestampComputeAndGraphics :: Bool
- timestampPeriod :: Float
- maxClipDistances :: Word32
- maxCullDistances :: Word32
- maxCombinedClipAndCullDistances :: Word32
- discreteQueuePriorities :: Word32
- pointSizeRange :: (Float, Float)
- lineWidthRange :: (Float, Float)
- pointSizeGranularity :: Float
- lineWidthGranularity :: Float
- strictLines :: Bool
- standardSampleLocations :: Bool
- optimalBufferCopyOffsetAlignment :: DeviceSize
- optimalBufferCopyRowPitchAlignment :: DeviceSize
- nonCoherentAtomSize :: DeviceSize
Documentation
createInstance :: PokeChain a => InstanceCreateInfo a -> ("allocator" ::: Maybe AllocationCallbacks) -> IO Instance Source #
vkCreateInstance - Create a new Vulkan instance
Parameters
pCreateInfo
is a pointer to aInstanceCreateInfo
structure controlling creation of the instance.
pAllocator
controls host memory allocation as described in the Memory Allocation chapter.pInstance
points aInstance
handle in which the resulting instance is returned.
Description
createInstance
verifies that the requested layers exist. If not,
createInstance
will return
ERROR_LAYER_NOT_PRESENT
. Next
createInstance
verifies that the requested extensions are supported
(e.g. in the implementation or in any enabled instance layer) and if any
requested extension is not supported, createInstance
must return
ERROR_EXTENSION_NOT_PRESENT
. After
verifying and enabling the instance layers and extensions the
Instance
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
createInstance
time for the creation to succeed.
Valid Usage
- All
required extensions
for each extension in the
InstanceCreateInfo
::ppEnabledExtensionNames
list must also be present in that list.
Valid Usage (Implicit)
pCreateInfo
must be a valid pointer to a validInstanceCreateInfo
structure
- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validAllocationCallbacks
structure pInstance
must be a valid pointer to aInstance
handle
Return Codes
See Also
withInstance :: PokeChain a => InstanceCreateInfo a -> Maybe AllocationCallbacks -> (Instance -> IO r) -> IO r Source #
A safe wrapper for createInstance
and destroyInstance
using
bracket
The allocated value must not be returned from the provided computation
destroyInstance :: Instance -> ("allocator" ::: Maybe AllocationCallbacks) -> IO () Source #
vkDestroyInstance - Destroy an instance of Vulkan
Parameters
Instance
is the handle of the instance to destroy.
pAllocator
controls host memory allocation as described in the Memory Allocation chapter.
Valid Usage
- If
AllocationCallbacks
were provided whenInstance
was created, a compatible set of callbacks must be provided here - If no
AllocationCallbacks
were provided whenInstance
was created,pAllocator
must beNULL
Valid Usage (Implicit)
- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validAllocationCallbacks
structure
Host Synchronization
- Host access to
Instance
must be externally synchronized
See Also
enumeratePhysicalDevices :: Instance -> IO (Result, "physicalDevices" ::: Vector PhysicalDevice) Source #
vkEnumeratePhysicalDevices - Enumerates the physical devices accessible to a Vulkan instance
Parameters
Instance
is a handle to a Vulkan instance previously created withcreateInstance
.
pPhysicalDeviceCount
is a pointer to an integer related to the number of physical devices available or queried, as described below.pPhysicalDevices
is eitherNULL
or a pointer to an array ofPhysicalDevice
handles.
Description
If pPhysicalDevices
is NULL
, then the number of physical devices
available is returned in pPhysicalDeviceCount
. Otherwise,
pPhysicalDeviceCount
must point to a variable set by the user to the
number of elements in the pPhysicalDevices
array, and on return the
variable is overwritten with the number of handles actually written to
pPhysicalDevices
. If pPhysicalDeviceCount
is less than the number of
physical devices available, at most pPhysicalDeviceCount
structures
will be written. If pPhysicalDeviceCount
is smaller than the number of
physical devices available,
INCOMPLETE
will be returned
instead of SUCCESS
, to indicate
that not all the available physical devices were returned.
Valid Usage (Implicit)
pPhysicalDeviceCount
must be a valid pointer to auint32_t
value- If the value referenced by
pPhysicalDeviceCount
is not0
, andpPhysicalDevices
is notNULL
,pPhysicalDevices
must be a valid pointer to an array ofpPhysicalDeviceCount
PhysicalDevice
handles
Return Codes
See Also
getDeviceProcAddr :: Device -> ("name" ::: ByteString) -> IO PFN_vkVoidFunction Source #
vkGetDeviceProcAddr - Return a function pointer for a command
Parameters
The table below defines the various use cases for getDeviceProcAddr
and expected return value for each case.
Description
The returned function pointer is of type
PFN_vkVoidFunction
, and must be
cast to the type of the command being queried. The function pointer
must only be called with a dispatchable object (the first parameter)
that is Device
or a child of
Device
.
Device | pName | return value |
---|---|---|
NULL | *1 | undefined |
invalid device | *1 | undefined |
device | NULL | undefined |
device | core device-level Vulkan command | fp2 |
device | enabled extension device-level commands | fp2 |
any other case, not covered above | NULL |
vkGetDeviceProcAddr behavior
- 1
- "*" means any representable value for the parameter (including
valid values, invalid values, and
NULL
). - 2
- The returned function pointer must only be called with a
dispatchable object (the first parameter) that is
Device
or a child ofDevice
e.g.Device
,Queue
, orCommandBuffer
.
Valid Usage (Implicit)
See Also
getInstanceProcAddr :: Instance -> ("name" ::: ByteString) -> IO PFN_vkVoidFunction Source #
vkGetInstanceProcAddr - Return a function pointer for a command
Parameters
Instance
is the instance that the function pointer will be compatible with, orNULL
for commands not dependent on any instance.
pName
is the name of the command to obtain.
Description
getInstanceProcAddr
itself is obtained in a platform- and loader-
specific manner. Typically, the loader library will export this command
as a function symbol, so applications can link against the loader
library, or load it dynamically and look up the symbol using
platform-specific APIs.
The table below defines the various use cases for getInstanceProcAddr
and expected return value (“fp” is “function pointer”) for each case.
The returned function pointer is of type
PFN_vkVoidFunction
, and must be
cast to the type of the command being queried.
Instance | pName | return value |
---|---|---|
*1 | NULL | undefined |
invalid non-NULL instance | *1 | undefined |
NULL | enumerateInstanceVersion | fp |
NULL | enumerateInstanceExtensionProperties | fp |
NULL | enumerateInstanceLayerProperties | fp |
NULL | createInstance | fp |
instance | core Vulkan command | fp2 |
instance | enabled instance extension commands for
Instance | fp2 |
instance | available device extension3 commands for
Instance | fp2 |
any other case, not covered above | NULL |
vkGetInstanceProcAddr behavior
- 1
- "*" means any representable value for the parameter (including
valid values, invalid values, and
NULL
). - 2
- The returned function pointer must only be called with a
dispatchable object (the first parameter) that is
Instance
or a child ofInstance
, e.g.Instance
,PhysicalDevice
,Device
,Queue
, orCommandBuffer
. - 3
- An “available device extension” is a device extension supported by
any physical device enumerated by
Instance
.
Valid Usage (Implicit)
pName
must be a null-terminated UTF-8 string
See Also
getPhysicalDeviceProperties :: PhysicalDevice -> IO PhysicalDeviceProperties Source #
vkGetPhysicalDeviceProperties - Returns properties of a physical device
Parameters
PhysicalDevice
is the handle to the physical device whose properties will be queried.
pProperties
is a pointer to aPhysicalDeviceProperties
structure in which properties are returned.
Valid Usage (Implicit)
See Also
getPhysicalDeviceQueueFamilyProperties :: PhysicalDevice -> IO ("queueFamilyProperties" ::: Vector QueueFamilyProperties) Source #
vkGetPhysicalDeviceQueueFamilyProperties - Reports properties of the queues of the specified physical device
Parameters
PhysicalDevice
is the handle to the physical device whose properties will be queried.
pQueueFamilyPropertyCount
is a pointer to an integer related to the number of queue families available or queried, as described below.pQueueFamilyProperties
is eitherNULL
or a pointer to an array ofQueueFamilyProperties
structures.
Description
If pQueueFamilyProperties
is NULL
, then the number of queue families
available is returned in pQueueFamilyPropertyCount
. Implementations
must support at least one queue family. Otherwise,
pQueueFamilyPropertyCount
must point to a variable set by the user
to the number of elements in the pQueueFamilyProperties
array, and on
return the variable is overwritten with the number of structures
actually written to pQueueFamilyProperties
. If
pQueueFamilyPropertyCount
is less than the number of queue families
available, at most pQueueFamilyPropertyCount
structures will be
written.
Valid Usage (Implicit)
PhysicalDevice
must be a validPhysicalDevice
handle
pQueueFamilyPropertyCount
must be a valid pointer to auint32_t
value- If the value referenced by
pQueueFamilyPropertyCount
is not0
, andpQueueFamilyProperties
is notNULL
,pQueueFamilyProperties
must be a valid pointer to an array ofpQueueFamilyPropertyCount
QueueFamilyProperties
structures
See Also
getPhysicalDeviceMemoryProperties :: PhysicalDevice -> IO PhysicalDeviceMemoryProperties Source #
vkGetPhysicalDeviceMemoryProperties - Reports memory information for the specified physical device
Parameters
PhysicalDevice
is the handle to the device to query.
pMemoryProperties
is a pointer to aPhysicalDeviceMemoryProperties
structure in which the properties are returned.
Valid Usage (Implicit)
See Also
getPhysicalDeviceFeatures :: PhysicalDevice -> IO PhysicalDeviceFeatures Source #
vkGetPhysicalDeviceFeatures - Reports capabilities of a physical device
Parameters
PhysicalDevice
is the physical device from which to query the supported features.
pFeatures
is a pointer to aPhysicalDeviceFeatures
structure in which the physical device features are returned. For each feature, a value ofTRUE
specifies that the feature is supported on this physical device, andFALSE
specifies that the feature is not supported.
Valid Usage (Implicit)
See Also
getPhysicalDeviceFormatProperties :: PhysicalDevice -> Format -> IO FormatProperties Source #
vkGetPhysicalDeviceFormatProperties - Lists physical device’s format capabilities
Parameters
PhysicalDevice
is the physical device from which to query the format properties.
Format
is the format whose properties are queried.pFormatProperties
is a pointer to aFormatProperties
structure in which physical device properties forFormat
are returned.
Valid Usage (Implicit)
See Also
getPhysicalDeviceImageFormatProperties :: PhysicalDevice -> Format -> ImageType -> ImageTiling -> ImageUsageFlags -> ImageCreateFlags -> IO ImageFormatProperties Source #
vkGetPhysicalDeviceImageFormatProperties - Lists physical device’s image format capabilities
Parameters
PhysicalDevice
is the physical device from which to query the image capabilities.
Format
is aFormat
value specifying the image format, corresponding to 'Graphics.Vulkan.Core10.Image.ImageCreateInfo'::'Graphics.Vulkan.Core10.Enums.Format.Format'.type
is aImageType
value specifying the image type, corresponding to 'Graphics.Vulkan.Core10.Image.ImageCreateInfo'::'Graphics.Vulkan.Core10.Enums.ImageType.ImageType'.tiling
is aImageTiling
value specifying the image tiling, corresponding toImageCreateInfo
::tiling
.usage
is a bitmask ofImageUsageFlagBits
specifying the intended usage of the image, corresponding toImageCreateInfo
::usage
.Flags
is a bitmask ofImageCreateFlagBits
specifying additional parameters of the image, corresponding to 'Graphics.Vulkan.Core10.Image.ImageCreateInfo'::'Graphics.Vulkan.Core10.BaseType.Flags'.pImageFormatProperties
is a pointer to aImageFormatProperties
structure in which capabilities are returned.
Description
The Format
, type
, tiling
,
usage
, and Flags
parameters
correspond to parameters that would be consumed by
createImage
(as members of
ImageCreateInfo
).
If Format
is not a supported image
format, or if the combination of
Format
, type
, tiling
, usage
,
and Flags
is not supported for images,
then getPhysicalDeviceImageFormatProperties
returns
ERROR_FORMAT_NOT_SUPPORTED
.
The limitations on an image format that are reported by
getPhysicalDeviceImageFormatProperties
have the following property: if
usage1
and usage2
of type
ImageUsageFlags
are
such that the bits set in usage1
are a subset of the bits set in
usage2
, and flags1
and flags2
of type
ImageCreateFlags
are
such that the bits set in flags1
are a subset of the bits set in
flags2
, then the limitations for usage1
and flags1
must be no
more strict than the limitations for usage2
and flags2
, for all
values of Format
, type
, and
tiling
.
Return Codes
See Also
Format
,
ImageCreateFlags
,
ImageFormatProperties
,
ImageTiling
,
ImageType
,
ImageUsageFlags
,
PhysicalDevice
data PhysicalDeviceProperties Source #
VkPhysicalDeviceProperties - Structure specifying physical device properties
Description
Note
The value of apiVersion
may be different than the version returned
by
enumerateInstanceVersion
;
either higher or lower. In such cases, the application must not use
functionality that exceeds the version of Vulkan associated with a given
object. The pApiVersion
parameter returned by
enumerateInstanceVersion
is the version associated with a
Instance
and its children, except for a
PhysicalDevice
and its children.
PhysicalDeviceProperties
::apiVersion
is the version associated with
a PhysicalDevice
and its children.
The vendorID
and deviceID
fields are provided to allow applications
to adapt to device characteristics that are not adequately exposed by
other Vulkan queries.
Note
These may include performance profiles, hardware errata, or other characteristics.
The vendor identified by vendorID
is the entity responsible for the
most salient characteristics of the underlying implementation of the
PhysicalDevice
being queried.
Note
For example, in the case of a discrete GPU implementation, this should be the GPU chipset vendor. In the case of a hardware accelerator integrated into a system-on-chip (SoC), this should be the supplier of the silicon IP used to create the accelerator.
If the vendor has a
PCI vendor ID, the low
16 bits of vendorID
must contain that PCI vendor ID, and the
remaining bits must be set to zero. Otherwise, the value returned
must be a valid Khronos vendor ID, obtained as described in the
Vulkan Documentation and Extensions: Procedures and Conventions
document in the section “Registering a Vendor ID with Khronos”. Khronos
vendor IDs are allocated starting at 0x10000, to distinguish them from
the PCI vendor ID namespace. Khronos vendor IDs are symbolically defined
in the VendorId
type.
The vendor is also responsible for the value returned in deviceID
. If
the implementation is driven primarily by a
PCI device with a
PCI device ID, the low 16 bits of deviceID
must contain that PCI device ID, and the remaining bits must be set
to zero. Otherwise, the choice of what values to return may be
dictated by operating system or platform policies - but should
uniquely identify both the device version and any major configuration
options (for example, core count in the case of multicore devices).
Note
The same device ID should be used for all physical implementations of that device version and configuration. For example, all uses of a specific silicon IP GPU version and configuration should use the same device ID, even if those uses occur in different SoCs.
See Also
PhysicalDeviceLimits
,
PhysicalDeviceProperties2
,
PhysicalDeviceSparseProperties
,
PhysicalDeviceType
,
getPhysicalDeviceProperties
PhysicalDeviceProperties | |
|
Instances
Show PhysicalDeviceProperties Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization showsPrec :: Int -> PhysicalDeviceProperties -> ShowS # show :: PhysicalDeviceProperties -> String # showList :: [PhysicalDeviceProperties] -> ShowS # | |
FromCStruct PhysicalDeviceProperties Source # | |
ToCStruct PhysicalDeviceProperties Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization withCStruct :: PhysicalDeviceProperties -> (Ptr PhysicalDeviceProperties -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceProperties -> PhysicalDeviceProperties -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceProperties -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceProperties -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero PhysicalDeviceProperties Source # | |
data ApplicationInfo Source #
VkApplicationInfo - Structure specifying application info
Description
Vulkan 1.0 implementations were required to return
ERROR_INCOMPATIBLE_DRIVER
if
apiVersion
was larger than 1.0. Implementations that support Vulkan
1.1 or later must not return
ERROR_INCOMPATIBLE_DRIVER
for any
value of apiVersion
.
Note
Because Vulkan 1.0 implementations may fail with
ERROR_INCOMPATIBLE_DRIVER
,
applications should determine the version of Vulkan available before
calling createInstance
. If the getInstanceProcAddr
returns NULL
for
enumerateInstanceVersion
,
it is a Vulkan 1.0 implementation. Otherwise, the application can call
enumerateInstanceVersion
to determine the version of Vulkan.
As long as the instance supports at least Vulkan 1.1, an application can use different versions of Vulkan with an instance than it does with a device or physical device.
Note
The Khronos validation layers will treat apiVersion
as the highest API
version the application targets, and will validate API usage against the
minimum of that version and the implementation version (instance or
device, depending on context). If an application tries to use
functionality from a greater version than this, a validation error will
be triggered.
For example, if the instance supports Vulkan 1.1 and three physical
devices support Vulkan 1.0, Vulkan 1.1, and Vulkan 1.2, respectively,
and if the application sets apiVersion
to 1.2, the application can
use the following versions of Vulkan:
- Vulkan 1.0 can be used with the instance and with all physical devices.
- Vulkan 1.1 can be used with the instance and with the physical devices that support Vulkan 1.1 and Vulkan 1.2.
- Vulkan 1.2 can be used with the physical device that supports Vulkan 1.2.
If we modify the above example so that the application sets apiVersion
to 1.1, then the application must not use Vulkan 1.2 functionality on
the physical device that supports Vulkan 1.2.
Implicit layers must be disabled if they do not support a version at
least as high as apiVersion
. See the
Vulkan Loader Specification and Architecture Overview
document for additional information.
Note
Providing a NULL
InstanceCreateInfo
::pApplicationInfo
or providing
an apiVersion
of 0 is equivalent to providing an apiVersion
of
VK_MAKE_VERSION(1,0,0)
.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_APPLICATION_INFO
pNext
must beNULL
- If
pApplicationName
is notNULL
,pApplicationName
must be a null-terminated UTF-8 string - If
pEngineName
is notNULL
,pEngineName
must be a null-terminated UTF-8 string
See Also
ApplicationInfo | |
|
Instances
Show ApplicationInfo Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization showsPrec :: Int -> ApplicationInfo -> ShowS # show :: ApplicationInfo -> String # showList :: [ApplicationInfo] -> ShowS # | |
FromCStruct ApplicationInfo Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization | |
ToCStruct ApplicationInfo Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization withCStruct :: ApplicationInfo -> (Ptr ApplicationInfo -> IO b) -> IO b Source # pokeCStruct :: Ptr ApplicationInfo -> ApplicationInfo -> IO b -> IO b Source # withZeroCStruct :: (Ptr ApplicationInfo -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ApplicationInfo -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero ApplicationInfo Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization |
data InstanceCreateInfo (es :: [Type]) Source #
VkInstanceCreateInfo - Structure specifying parameters of a newly created instance
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_INSTANCE_CREATE_INFO
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofDebugReportCallbackCreateInfoEXT
,DebugUtilsMessengerCreateInfoEXT
,ValidationFeaturesEXT
, orValidationFlagsEXT
- The
sType
value of each struct in thepNext
chain must be unique Flags
must be0
- If
pApplicationInfo
is notNULL
,pApplicationInfo
must be a valid pointer to a validApplicationInfo
structure - If
enabledLayerCount
is not0
,ppEnabledLayerNames
must be a valid pointer to an array ofenabledLayerCount
null-terminated UTF-8 strings - If
enabledExtensionCount
is not0
,ppEnabledExtensionNames
must be a valid pointer to an array ofenabledExtensionCount
null-terminated UTF-8 strings
See Also
ApplicationInfo
,
InstanceCreateFlags
,
StructureType
,
createInstance
InstanceCreateInfo | |
|
Instances
data QueueFamilyProperties Source #
VkQueueFamilyProperties - Structure providing information about a queue family
Description
The value returned in minImageTransferGranularity
has a unit of
compressed texel blocks for images having a block-compressed format, and
a unit of texels otherwise.
Possible values of minImageTransferGranularity
are:
(0,0,0) which indicates that only whole mip levels must be transferred using the image transfer operations on the corresponding queues. In this case, the following restrictions apply to all offset and extent parameters of image transfer operations:
(Ax, Ay, Az) where Ax, Ay, and Az are all integer powers of two. In this case the following restrictions apply to all image transfer operations:
x
,y
, andz
of aOffset3D
parameter must be integer multiples of Ax, Ay, and Az, respectively.width
of aExtent3D
parameter must be an integer multiple of Ax, or elsex
+width
must equal the width of the image subresource corresponding to the parameter.height
of aExtent3D
parameter must be an integer multiple of Ay, or elsey
+height
must equal the height of the image subresource corresponding to the parameter.depth
of aExtent3D
parameter must be an integer multiple of Az, or elsez
+depth
must equal the depth of the image subresource corresponding to the parameter.- If the format of the image corresponding to the parameters is one of the block-compressed formats then for the purposes of the above calculations the granularity must be scaled up by the compressed texel block dimensions.
Queues supporting graphics and/or compute operations must report
(1,1,1) in minImageTransferGranularity
, meaning that there are no
additional restrictions on the granularity of image transfer operations
for these queues. Other queues supporting image transfer operations are
only required to support whole mip level transfers, thus
minImageTransferGranularity
for queues belonging to such queue
families may be (0,0,0).
The Device Memory section describes memory properties queried from the physical device.
For physical device feature queries see the Features chapter.
See Also
Extent3D
,
QueueFamilyProperties2
,
QueueFlags
,
getPhysicalDeviceQueueFamilyProperties
QueueFamilyProperties | |
|
Instances
Show QueueFamilyProperties Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization showsPrec :: Int -> QueueFamilyProperties -> ShowS # show :: QueueFamilyProperties -> String # showList :: [QueueFamilyProperties] -> ShowS # | |
FromCStruct QueueFamilyProperties Source # | |
ToCStruct QueueFamilyProperties Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization withCStruct :: QueueFamilyProperties -> (Ptr QueueFamilyProperties -> IO b) -> IO b Source # pokeCStruct :: Ptr QueueFamilyProperties -> QueueFamilyProperties -> IO b -> IO b Source # withZeroCStruct :: (Ptr QueueFamilyProperties -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr QueueFamilyProperties -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero QueueFamilyProperties Source # | |
data PhysicalDeviceMemoryProperties Source #
VkPhysicalDeviceMemoryProperties - Structure specifying physical device memory properties
Description
The PhysicalDeviceMemoryProperties
structure describes a number of
memory heaps as well as a number of memory types that can be used
to access memory allocated in those heaps. Each heap describes a memory
resource of a particular size, and each memory type describes a set of
memory properties (e.g. host cached vs uncached) that can be used with
a given memory heap. Allocations using a particular memory type will
consume resources from the heap indicated by that memory type’s heap
index. More than one memory type may share each heap, and the heaps
and memory types provide a mechanism to advertise an accurate size of
the physical memory resources while allowing the memory to be used with
a variety of different properties.
The number of memory heaps is given by memoryHeapCount
and is less
than or equal to MAX_MEMORY_HEAPS
.
Each heap is described by an element of the memoryHeaps
array as a
MemoryHeap
structure. The number of memory types available across all
memory heaps is given by memoryTypeCount
and is less than or equal to
MAX_MEMORY_TYPES
. Each memory type
is described by an element of the memoryTypes
array as a MemoryType
structure.
At least one heap must include
MEMORY_HEAP_DEVICE_LOCAL_BIT
in 'MemoryHeap'::'Graphics.Vulkan.Core10.BaseType.Flags'. If there are
multiple heaps that all have similar performance characteristics, they
may all include
MEMORY_HEAP_DEVICE_LOCAL_BIT
.
In a unified memory architecture (UMA) system there is often only a
single memory heap which is considered to be equally “local” to the host
and to the device, and such an implementation must advertise the heap
as device-local.
Each memory type returned by getPhysicalDeviceMemoryProperties
must
have its propertyFlags
set to one of the following values:
- 0
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT
MEMORY_PROPERTY_PROTECTED_BIT
MEMORY_PROPERTY_PROTECTED_BIT
|MEMORY_PROPERTY_DEVICE_LOCAL_BIT
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
|MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
|MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
|MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
|MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
|MEMORY_PROPERTY_HOST_VISIBLE_BIT
|MEMORY_PROPERTY_HOST_CACHED_BIT
|MEMORY_PROPERTY_HOST_COHERENT_BIT
|MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
|MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
There must be at least one memory type with both the
MEMORY_PROPERTY_HOST_VISIBLE_BIT
and
MEMORY_PROPERTY_HOST_COHERENT_BIT
bits set in its propertyFlags
. There must be at least one memory
type with the
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
bit set in its propertyFlags
. If the
deviceCoherentMemory
feature is enabled, there must be at least one memory type with the
MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
bit set in its propertyFlags
.
For each pair of elements X and Y returned in memoryTypes
,
X must be placed at a lower index position than Y if:
- either the set of bit flags returned in the
propertyFlags
member of X is a strict subset of the set of bit flags returned in thepropertyFlags
member of Y; or - the
propertyFlags
members of X and Y are equal, and X belongs to a memory heap with greater performance (as determined in an implementation-specific manner) ; or - or the
propertyFlags
members of X includesMEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
orMEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
and Y does not
Note
There is no ordering requirement between X and Y elements for
the case their propertyFlags
members are not in a subset relation.
That potentially allows more than one possible way to order the same set
of memory types. Notice that the
list of all allowed memory property flag combinations
is written in a valid order. But if instead
MEMORY_PROPERTY_DEVICE_LOCAL_BIT
was before
MEMORY_PROPERTY_HOST_VISIBLE_BIT
|
MEMORY_PROPERTY_HOST_COHERENT_BIT
,
the list would still be in a valid order.
There may be a performance penalty for using device coherent or uncached device memory types, and using these accidentally is undesirable. In order to avoid this, memory types with these properties always appear at the end of the list; but are subject to the same rules otherwise.
This ordering requirement enables applications to use a simple search loop to select the desired memory type along the lines of:
// Find a memory in `memoryTypeBitsRequirement` that includes all of `requiredProperties` int32_t findProperties(const VkPhysicalDeviceMemoryProperties* pMemoryProperties, uint32_t memoryTypeBitsRequirement, VkMemoryPropertyFlags requiredProperties) { const uint32_t memoryCount = pMemoryProperties->memoryTypeCount; for (uint32_t memoryIndex = 0; memoryIndex < memoryCount; ++memoryIndex) { const uint32_t memoryTypeBits = (1 << memoryIndex); const bool isRequiredMemoryType = memoryTypeBitsRequirement & memoryTypeBits; const VkMemoryPropertyFlags properties = pMemoryProperties->memoryTypes[memoryIndex].propertyFlags; const bool hasRequiredProperties = (properties & requiredProperties) == requiredProperties; if (isRequiredMemoryType && hasRequiredProperties) return static_cast<int32_t>(memoryIndex); } // failed to find memory type return -1; } // Try to find an optimal memory type, or if it does not exist try fallback memory type // `device` is the VkDevice // `image` is the VkImage that requires memory to be bound // `memoryProperties` properties as returned by vkGetPhysicalDeviceMemoryProperties // `requiredProperties` are the property flags that must be present // `optimalProperties` are the property flags that are preferred by the application VkMemoryRequirements memoryRequirements; vkGetImageMemoryRequirements(device, image, &memoryRequirements); int32_t memoryType = findProperties(&memoryProperties, memoryRequirements.memoryTypeBits, optimalProperties); if (memoryType == -1) // not found; try fallback properties memoryType = findProperties(&memoryProperties, memoryRequirements.memoryTypeBits, requiredProperties);
See Also
MemoryHeap
, MemoryType
,
PhysicalDeviceMemoryProperties2
,
getPhysicalDeviceMemoryProperties
PhysicalDeviceMemoryProperties | |
|
Instances
data MemoryType Source #
VkMemoryType - Structure specifying memory type
See Also
MemoryType | |
|
Instances
data MemoryHeap Source #
VkMemoryHeap - Structure specifying a memory heap
See Also
MemoryHeap | |
|
Instances
data FormatProperties Source #
VkFormatProperties - Structure specifying image format properties
Description
Note
If no format feature flags are supported, the format itself is not supported, and images of that format cannot be created.
If Format
is a block-compressed
format, then bufferFeatures
must not support any features for the
format.
If Format
is not a multi-plane
format then linearTilingFeatures
and optimalTilingFeatures
must
not contain
FORMAT_FEATURE_DISJOINT_BIT
.
See Also
FormatFeatureFlags
,
FormatProperties2
,
getPhysicalDeviceFormatProperties
FormatProperties | |
|
Instances
data ImageFormatProperties Source #
VkImageFormatProperties - Structure specifying an image format properties
Members
maxExtent
are the maximum image dimensions. See the Allowed Extent Values section below for how these values are constrained bytype
.
maxMipLevels
is the maximum number of mipmap levels.maxMipLevels
must be equal to the number of levels in the complete mipmap chain based on themaxExtent.width
,maxExtent.height
, andmaxExtent.depth
, except when one of the following conditions is true, in which case it may instead be1
:getPhysicalDeviceImageFormatProperties
::tiling
wasIMAGE_TILING_LINEAR
PhysicalDeviceImageFormatInfo2
::tiling
wasIMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
- the
PhysicalDeviceImageFormatInfo2
::pNext
chain included aPhysicalDeviceExternalImageFormatInfo
structure with a handle type included in thehandleTypes
member for which mipmap image support is not required - image
Format
is one of those listed in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion Flags
containsIMAGE_CREATE_SUBSAMPLED_BIT_EXT
maxArrayLayers
is the maximum number of array layers.maxArrayLayers
must be no less thanPhysicalDeviceLimits
::maxImageArrayLayers
, except when one of the following conditions is true, in which case it may instead be1
:tiling
isIMAGE_TILING_LINEAR
tiling
isIMAGE_TILING_OPTIMAL
andtype
isIMAGE_TYPE_3D
Format
is one of those listed in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-requiring-sampler-ycbcr-conversion
- If
tiling
isIMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
, thenmaxArrayLayers
must not be 0. sampleCounts
is a bitmask ofSampleCountFlagBits
specifying all the supported sample counts for this image as described below.maxResourceSize
is an upper bound on the total image size in bytes, inclusive of all image subresources. Implementations may have an address space limit on total size of a resource, which is advertised by this property.maxResourceSize
must be at least 231.
Description
Note
There is no mechanism to query the size of an image before creating it,
to compare that size against maxResourceSize
. If an application
attempts to create an image that exceeds this limit, the creation will
fail and createImage
will return
ERROR_OUT_OF_DEVICE_MEMORY
. While
the advertised limit must be at least 231, it may not be possible to
create an image that approaches that size, particularly for
IMAGE_TYPE_1D
.
If the combination of parameters to
getPhysicalDeviceImageFormatProperties
is not supported by the
implementation for use in createImage
,
then all members of ImageFormatProperties
will be filled with zero.
Note
Filling ImageFormatProperties
with zero for unsupported formats is an
exception to the usual rule that output structures have undefined
contents on error. This exception was unintentional, but is preserved
for backwards compatibility.
See Also
DeviceSize
,
Extent3D
,
ExternalImageFormatPropertiesNV
,
ImageFormatProperties2
,
SampleCountFlags
,
getPhysicalDeviceImageFormatProperties
Instances
Show ImageFormatProperties Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization showsPrec :: Int -> ImageFormatProperties -> ShowS # show :: ImageFormatProperties -> String # showList :: [ImageFormatProperties] -> ShowS # | |
FromCStruct ImageFormatProperties Source # | |
ToCStruct ImageFormatProperties Source # | |
Defined in Graphics.Vulkan.Core10.DeviceInitialization withCStruct :: ImageFormatProperties -> (Ptr ImageFormatProperties -> IO b) -> IO b Source # pokeCStruct :: Ptr ImageFormatProperties -> ImageFormatProperties -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImageFormatProperties -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImageFormatProperties -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero ImageFormatProperties Source # | |
data PhysicalDeviceFeatures Source #
VkPhysicalDeviceFeatures - Structure describing the fine-grained features that can be supported by an implementation
Members
The members of the PhysicalDeviceFeatures
structure describe the
following features:
See Also
Bool32
,
DeviceCreateInfo
,
PhysicalDeviceFeatures2
,
getPhysicalDeviceFeatures
PhysicalDeviceFeatures | |
|
Instances
data PhysicalDeviceSparseProperties Source #
VkPhysicalDeviceSparseProperties - Structure specifying physical device sparse memory properties
See Also
PhysicalDeviceSparseProperties | |
|
Instances
data PhysicalDeviceLimits Source #
VkPhysicalDeviceLimits - Structure reporting implementation-dependent physical device limits
Members
The PhysicalDeviceLimits
are properties of the physical device. These
are available in the limits
member of the PhysicalDeviceProperties
structure which is returned from getPhysicalDeviceProperties
.
Description
- 1
- For all bitmasks of
SampleCountFlagBits
, the sample count limits defined above represent the minimum supported sample counts for each image type. Individual images may support additional sample counts, which are queried usinggetPhysicalDeviceImageFormatProperties
as described in Supported Sample Counts.
See Also
Bool32
,
DeviceSize
,
PhysicalDeviceProperties
,
SampleCountFlags
PhysicalDeviceLimits | |
|