vulkan-2.0.0.1: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Core11.Promoted_from_VK_KHR_get_physical_device_properties2

Synopsis

Documentation

vkGetPhysicalDeviceFeatures2 :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pFeatures" ::: Ptr VkPhysicalDeviceFeatures2) -> IO () Source #

vkGetPhysicalDeviceFeatures2 - Reports capabilities of a physical device

Parameters

  • physicalDevice is the physical device from which to query the supported features.

Description

Each structure in pFeatures and its pNext chain contain members corresponding to fine-grained features. vkGetPhysicalDeviceFeatures2 writes each member to a boolean value indicating whether that feature is supported.

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • pFeatures must be a valid pointer to a VkPhysicalDeviceFeatures2 structure

See Also

VkPhysicalDevice, VkPhysicalDeviceFeatures2

vkGetPhysicalDeviceProperties2 :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pProperties" ::: Ptr VkPhysicalDeviceProperties2) -> IO () Source #

vkGetPhysicalDeviceProperties2 - Returns properties of a physical device

Parameters

  • physicalDevice is the handle to the physical device whose properties will be queried.

Description

Each structure in pProperties and its pNext chain contain members corresponding to properties or implementation-dependent limits. vkGetPhysicalDeviceProperties2 writes each member to a value indicating the value of that property or limit.

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • pProperties must be a valid pointer to a VkPhysicalDeviceProperties2 structure

See Also

VkPhysicalDevice, VkPhysicalDeviceProperties2

vkGetPhysicalDeviceFormatProperties2 :: ("physicalDevice" ::: VkPhysicalDevice) -> ("format" ::: VkFormat) -> ("pFormatProperties" ::: Ptr VkFormatProperties2) -> IO () Source #

vkGetPhysicalDeviceFormatProperties2 - 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 a VkFormatProperties2 structure in which physical device properties for format are returned.

Description

vkGetPhysicalDeviceFormatProperties2 behaves similarly to vkGetPhysicalDeviceFormatProperties, with the ability to return extended information in a pNext chain of output structures.

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • format must be a valid VkFormat value
  • pFormatProperties must be a valid pointer to a VkFormatProperties2 structure

See Also

VkFormat, VkFormatProperties2, VkPhysicalDevice

vkGetPhysicalDeviceImageFormatProperties2 :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pImageFormatInfo" ::: Ptr VkPhysicalDeviceImageFormatInfo2) -> ("pImageFormatProperties" ::: Ptr VkImageFormatProperties2) -> IO VkResult Source #

vkGetPhysicalDeviceImageFormatProperties2 - Lists physical device’s image format capabilities

Parameters

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

Description

vkGetPhysicalDeviceImageFormatProperties2 behaves similarly to vkGetPhysicalDeviceImageFormatProperties, with the ability to return extended information in a pNext chain of output structures.

Valid Usage

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • pImageFormatInfo must be a valid pointer to a valid VkPhysicalDeviceImageFormatInfo2 structure
  • pImageFormatProperties must be a valid pointer to a VkImageFormatProperties2 structure

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_FORMAT_NOT_SUPPORTED

See Also

VkImageFormatProperties2, VkPhysicalDevice, VkPhysicalDeviceImageFormatInfo2

vkGetPhysicalDeviceQueueFamilyProperties2 :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pQueueFamilyPropertyCount" ::: Ptr Word32) -> ("pQueueFamilyProperties" ::: Ptr VkQueueFamilyProperties2) -> IO () Source #

vkGetPhysicalDeviceQueueFamilyProperties2 - Reports properties of the queues of the specified physical device

Parameters

  • physicalDevice is the handle to the physical device whose properties will be queried.

Description

vkGetPhysicalDeviceQueueFamilyProperties2 behaves similarly to vkGetPhysicalDeviceQueueFamilyProperties, with the ability to return extended information in a pNext chain of output structures.

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • pQueueFamilyPropertyCount must be a valid pointer to a uint32_t value
  • If the value referenced by pQueueFamilyPropertyCount is not 0, and pQueueFamilyProperties is not NULL, pQueueFamilyProperties must be a valid pointer to an array of pQueueFamilyPropertyCount VkQueueFamilyProperties2 structures

See Also

VkPhysicalDevice, VkQueueFamilyProperties2

vkGetPhysicalDeviceMemoryProperties2 :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pMemoryProperties" ::: Ptr VkPhysicalDeviceMemoryProperties2) -> IO () Source #

vkGetPhysicalDeviceMemoryProperties2 - Reports memory information for the specified physical device

Parameters

  • physicalDevice is the handle to the device to query.
  • pMemoryProperties points to an instance of VkPhysicalDeviceMemoryProperties2 structure in which the properties are returned.

Description

vkGetPhysicalDeviceMemoryProperties2 behaves similarly to vkGetPhysicalDeviceMemoryProperties, with the ability to return extended information in a pNext chain of output structures.

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • pMemoryProperties must be a valid pointer to a VkPhysicalDeviceMemoryProperties2 structure

See Also

VkPhysicalDevice, VkPhysicalDeviceMemoryProperties2

vkGetPhysicalDeviceSparseImageFormatProperties2 :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pFormatInfo" ::: Ptr VkPhysicalDeviceSparseImageFormatInfo2) -> ("pPropertyCount" ::: Ptr Word32) -> ("pProperties" ::: Ptr VkSparseImageFormatProperties2) -> IO () Source #

vkGetPhysicalDeviceSparseImageFormatProperties2 - Retrieve properties of an image format applied to sparse images

Parameters

  • physicalDevice is the physical device from which to query the sparse image capabilities.
  • pFormatInfo is a pointer to a structure of type VkPhysicalDeviceSparseImageFormatInfo2 containing input parameters to the command.
  • pPropertyCount is a pointer to an integer related to the number of sparse format properties available or queried, as described below.
  • pProperties is either NULL or a pointer to an array of VkSparseImageFormatProperties2 structures.

Description

vkGetPhysicalDeviceSparseImageFormatProperties2 behaves identically to vkGetPhysicalDeviceSparseImageFormatProperties, with the ability to return extended information by adding extension structures to the pNext chain of its pProperties parameter.

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • pFormatInfo must be a valid pointer to a valid VkPhysicalDeviceSparseImageFormatInfo2 structure
  • pPropertyCount must be a valid pointer to a uint32_t value
  • If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkSparseImageFormatProperties2 structures

See Also

VkPhysicalDevice, VkPhysicalDeviceSparseImageFormatInfo2, VkSparseImageFormatProperties2

data VkPhysicalDeviceFeatures2 Source #

VkPhysicalDeviceFeatures2 - Structure describing the fine-grained features that can be supported by an implementation

Members

The VkPhysicalDeviceFeatures2 structure is defined as:

Description

  • sType is the type of this structure.
  • pNext is NULL or a pointer to an extension-specific structure.
  • features is a structure of type VkPhysicalDeviceFeatures describing the fine-grained features of the Vulkan 1.0 API.

The pNext chain of this structure is used to extend the structure with features defined by extensions. This structure can be used in vkGetPhysicalDeviceFeatures2 or can be in the pNext chain of a VkDeviceCreateInfo structure, in which case it controls which features are enabled in the device in lieu of pEnabledFeatures.

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FEATURES_2

See Also

VkPhysicalDeviceFeatures, VkStructureType, vkGetPhysicalDeviceFeatures2, vkGetPhysicalDeviceFeatures2KHR

data VkPhysicalDeviceProperties2 Source #

Constructors

VkPhysicalDeviceProperties2 

Fields

data VkFormatProperties2 Source #

VkFormatProperties2 - Structure specifying image format properties

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2
  • pNext must be NULL

See Also

VkFormatProperties, VkStructureType, vkGetPhysicalDeviceFormatProperties2, vkGetPhysicalDeviceFormatProperties2KHR

Constructors

VkFormatProperties2 

Fields

data VkImageFormatProperties2 Source #

VkImageFormatProperties2 - Structure specifying a image format properties

Description

If the combination of parameters to vkGetPhysicalDeviceImageFormatProperties2 is not supported by the implementation for use in vkCreateImage, 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. This exeption only applies to imageFormatProperties, not sType, pNext, or any structures chained from pNext.

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2

See Also

VkImageFormatProperties, VkStructureType, vkGetPhysicalDeviceImageFormatProperties2, vkGetPhysicalDeviceImageFormatProperties2KHR

Constructors

VkImageFormatProperties2 

Fields

data VkPhysicalDeviceImageFormatInfo2 Source #

VkPhysicalDeviceImageFormatInfo2 - Structure specifying image creation parameters

Description

The members of VkPhysicalDeviceImageFormatInfo2 correspond to the arguments to vkGetPhysicalDeviceImageFormatProperties, with sType and pNext added for extensibility.

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2

See Also

VkFormat, VkImageCreateFlags, VkImageTiling, VkImageType, VkImageUsageFlags, VkStructureType, vkGetPhysicalDeviceImageFormatProperties2, vkGetPhysicalDeviceImageFormatProperties2KHR

Constructors

VkPhysicalDeviceImageFormatInfo2 

Fields

data VkQueueFamilyProperties2 Source #

VkQueueFamilyProperties2 - Structure providing information about a queue family

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_QUEUE_FAMILY_PROPERTIES_2
  • pNext must be NULL

See Also

VkQueueFamilyProperties, VkStructureType, vkGetPhysicalDeviceQueueFamilyProperties2, vkGetPhysicalDeviceQueueFamilyProperties2KHR

Constructors

VkQueueFamilyProperties2 

Fields

data VkPhysicalDeviceMemoryProperties2 Source #

VkPhysicalDeviceMemoryProperties2 - Structure specifying physical device memory properties

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_PROPERTIES_2
  • pNext must be NULL

See Also

VkPhysicalDeviceMemoryProperties, VkStructureType, vkGetPhysicalDeviceMemoryProperties2, vkGetPhysicalDeviceMemoryProperties2KHR

Constructors

VkPhysicalDeviceMemoryProperties2 

Fields

data VkSparseImageFormatProperties2 Source #

VkSparseImageFormatProperties2 - Structure specifying sparse image format properties

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2
  • pNext must be NULL

See Also

VkSparseImageFormatProperties, VkStructureType, vkGetPhysicalDeviceSparseImageFormatProperties2, vkGetPhysicalDeviceSparseImageFormatProperties2KHR

Constructors

VkSparseImageFormatProperties2 

Fields

data VkPhysicalDeviceSparseImageFormatInfo2 Source #

VkPhysicalDeviceSparseImageFormatInfo2 - Structure specifying sparse image format inputs

Valid Usage

  • samples must be a bit value that is set in VkImageFormatProperties::sampleCounts returned by vkGetPhysicalDeviceImageFormatProperties with format, type, tiling, and usage equal to those in this command and flags equal to the value that is set in VkImageCreateInfo::flags when the image is created

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2

See Also

VkFormat, VkImageTiling, VkImageType, VkImageUsageFlags, VkSampleCountFlagBits, VkStructureType, vkGetPhysicalDeviceSparseImageFormatProperties2, vkGetPhysicalDeviceSparseImageFormatProperties2KHR

Constructors

VkPhysicalDeviceSparseImageFormatInfo2 

Fields