public Class KHRGetSurfaceCapabilities2

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR
• STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR
• STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR
• STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR
• STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR
• STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR
• STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR

Unsafe version of: GetPhysicalDeviceSurfaceCapabilities2KHR

Unsafe version of: GetPhysicalDeviceSurfaceFormats2KHR

Parameters

pSurfaceFormatCount:long

a pointer to an integer related to the number of format tuples available or queried, as described below.

Reports capabilities of a surface on a physical device.

C Specification

To query the basic capabilities of a surface defined by the core or extensions, call:

VkResult vkGetPhysicalDeviceSurfaceCapabilities2KHR(
    VkPhysicalDevice                            physicalDevice,
    const VkPhysicalDeviceSurfaceInfo2KHR*      pSurfaceInfo,
    VkSurfaceCapabilities2KHR*                  pSurfaceCapabilities);

Description

vkGetPhysicalDeviceSurfaceCapabilities2KHR behaves similarly to GetPhysicalDeviceSurfaceCapabilitiesKHR, with the ability to specify extended inputs via chained input structures, and to return extended information via chained output structures.

Valid Usage

• If the VK_GOOGLE_surfaceless_query extension is not enabled, pSurfaceInfo→surface must be a valid VkSurfaceKHR handle
• If pSurfaceInfo→surface is not NULL_HANDLE, it must be supported by physicalDevice, as reported by GetPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

• If a VkSurfaceCapabilitiesFullScreenExclusiveEXT structure is included in the pNext chain of pSurfaceCapabilities, a VkSurfaceFullScreenExclusiveWin32InfoEXT structure must be included in the pNext chain of pSurfaceInfo
• If a VkSurfacePresentModeCompatibilityEXT structure is included in the pNext chain of pSurfaceCapabilities, a VkSurfacePresentModeEXT structure must be included in the pNext chain of pSurfaceInfo
• If a VkSurfacePresentScalingCapabilitiesEXT structure is included in the pNext chain of pSurfaceCapabilities, a VkSurfacePresentModeEXT structure must be included in the pNext chain of pSurfaceInfo
• If a VkSurfacePresentModeCompatibilityEXT structure is included in the pNext chain of pSurfaceCapabilities, pSurfaceInfo→surface must be a valid VkSurfaceKHR handle
• If a VkSurfacePresentScalingCapabilitiesEXT structure is included in the pNext chain of pSurfaceCapabilities, pSurfaceInfo→surface must be a valid VkSurfaceKHR handle

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pSurfaceInfo must be a valid pointer to a valid VkPhysicalDeviceSurfaceInfo2KHR structure
• pSurfaceCapabilities must be a valid pointer to a VkSurfaceCapabilities2KHR structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

VkPhysicalDeviceSurfaceInfo2KHR, VkSurfaceCapabilities2KHR

Parameters

physicalDevice:VkPhysicalDevice

the physical device that will be associated with the swapchain to be created, as described for CreateSwapchainKHR.

pSurfaceInfo:VkPhysicalDeviceSurfaceInfo2KHR

a pointer to a VkPhysicalDeviceSurfaceInfo2KHR structure describing the surface and other fixed parameters that would be consumed by CreateSwapchainKHR.

pSurfaceCapabilities:VkSurfaceCapabilities2KHR

a pointer to a VkSurfaceCapabilities2KHR structure in which the capabilities are returned.

Annotations

@NativeType:VkResult

Query color formats supported by surface.

C Specification

To query the supported swapchain format tuples for a surface, call:

VkResult vkGetPhysicalDeviceSurfaceFormats2KHR(
    VkPhysicalDevice                            physicalDevice,
    const VkPhysicalDeviceSurfaceInfo2KHR*      pSurfaceInfo,
    uint32_t*                                   pSurfaceFormatCount,
    VkSurfaceFormat2KHR*                        pSurfaceFormats);

Description

GetPhysicalDeviceSurfaceFormats2KHR behaves similarly to GetPhysicalDeviceSurfaceFormatsKHR, with the ability to be extended via pNext chains.

If pSurfaceFormats is NULL, then the number of format tuples supported for the given surface is returned in pSurfaceFormatCount. Otherwise, pSurfaceFormatCount must point to a variable set by the user to the number of elements in the pSurfaceFormats array, and on return the variable is overwritten with the number of structures actually written to pSurfaceFormats. If the value of pSurfaceFormatCount is less than the number of format tuples supported, at most pSurfaceFormatCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available values were returned.

Valid Usage

• If the VK_GOOGLE_surfaceless_query extension is not enabled, pSurfaceInfo→surface must be a valid VkSurfaceKHR handle
• If pSurfaceInfo→surface is not NULL_HANDLE, it must be supported by physicalDevice, as reported by GetPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pSurfaceInfo must be a valid pointer to a valid VkPhysicalDeviceSurfaceInfo2KHR structure
• pSurfaceFormatCount must be a valid pointer to a uint32_t value
• If the value referenced by pSurfaceFormatCount is not 0, and pSurfaceFormats is not NULL, pSurfaceFormats must be a valid pointer to an array of pSurfaceFormatCount VkSurfaceFormat2KHR structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

VkPhysicalDeviceSurfaceInfo2KHR, VkSurfaceFormat2KHR

Parameters

physicalDevice:VkPhysicalDevice

the physical device that will be associated with the swapchain to be created, as described for CreateSwapchainKHR.

pSurfaceInfo:VkPhysicalDeviceSurfaceInfo2KHR

a pointer to a VkPhysicalDeviceSurfaceInfo2KHR structure describing the surface and other fixed parameters that would be consumed by CreateSwapchainKHR.

pSurfaceFormatCount:IntBuffer

a pointer to an integer related to the number of format tuples available or queried, as described below.

pSurfaceFormats:VkSurfaceFormat2KHR.Buffer

either NULL or a pointer to an array of VkSurfaceFormat2KHR structures.

Annotations

@NativeType:VkResult

Array version of: GetPhysicalDeviceSurfaceFormats2KHR

Annotations

@NativeType:VkResult