Package org.lwjgl.vulkan

Class KHRGetSurfaceCapabilities2

java.lang.Object

org.lwjgl.vulkan.KHRGetSurfaceCapabilities2

public class KHRGetSurfaceCapabilities2
extends Object

This extension provides new queries for device surface capabilities that can be easily extended by other extensions, without introducing any further queries. This extension can be considered the VK_KHR_surface equivalent of the VK_KHR_get_physical_device_properties2 extension.

VK_KHR_get_surface_capabilities2

Name String

VK_KHR_get_surface_capabilities2

Extension Type

Instance extension

Registered Extension Number

120

Revision

1

Extension and Version Dependencies

VK_KHR_surface

Contact

• James Jones cubanismo

Other Extension Metadata

Last Modified Date

2017-02-27

IP Status

No known IP claims.

Contributors

• Ian Elliott, Google
• James Jones, NVIDIA
• Alon Or-bach, Samsung

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME	The extension name.
static final int	VK_KHR_GET_SURFACE_CAPABILITIES_2_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetPhysicalDeviceSurfaceCapabilities2KHR(VkPhysicalDevice physicalDevice, long pSurfaceInfo, long pSurfaceCapabilities)	Unsafe version of: GetPhysicalDeviceSurfaceCapabilities2KHR
static int	nvkGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice, long pSurfaceInfo, long pSurfaceFormatCount, long pSurfaceFormats)	Unsafe version of: GetPhysicalDeviceSurfaceFormats2KHR
static int	vkGetPhysicalDeviceSurfaceCapabilities2KHR(VkPhysicalDevice physicalDevice, VkPhysicalDeviceSurfaceInfo2KHR pSurfaceInfo, VkSurfaceCapabilities2KHR pSurfaceCapabilities)	Reports capabilities of a surface on a physical device.
static int	vkGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice, VkPhysicalDeviceSurfaceInfo2KHR pSurfaceInfo, int[] pSurfaceFormatCount, VkSurfaceFormat2KHR.Buffer pSurfaceFormats)	Array version of: GetPhysicalDeviceSurfaceFormats2KHR
static int	vkGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice, VkPhysicalDeviceSurfaceInfo2KHR pSurfaceInfo, IntBuffer pSurfaceFormatCount, VkSurfaceFormat2KHR.Buffer pSurfaceFormats)	Query color formats supported by surface.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_KHR_GET_SURFACE_CAPABILITIES_2_SPEC_VERSION

public static final int VK_KHR_GET_SURFACE_CAPABILITIES_2_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME

public static final String VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_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

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR

public static final int VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_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

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR

public static final int VK_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

See Also:

• Constant Field Values

Method Details

nvkGetPhysicalDeviceSurfaceCapabilities2KHR

public static int nvkGetPhysicalDeviceSurfaceCapabilities2KHR(VkPhysicalDevice physicalDevice,
 long pSurfaceInfo,
 long pSurfaceCapabilities)

Unsafe version of: GetPhysicalDeviceSurfaceCapabilities2KHR

vkGetPhysicalDeviceSurfaceCapabilities2KHR

public static int vkGetPhysicalDeviceSurfaceCapabilities2KHR(VkPhysicalDevice physicalDevice,
 VkPhysicalDeviceSurfaceInfo2KHR pSurfaceInfo,
 VkSurfaceCapabilities2KHR pSurfaceCapabilities)

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 - the physical device that will be associated with the swapchain to be created, as described for CreateSwapchainKHR.

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

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

nvkGetPhysicalDeviceSurfaceFormats2KHR

public static int nvkGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
 long pSurfaceInfo,
 long pSurfaceFormatCount,
 long pSurfaceFormats)

Unsafe version of: GetPhysicalDeviceSurfaceFormats2KHR

Parameters:

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

vkGetPhysicalDeviceSurfaceFormats2KHR

public static int vkGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
 VkPhysicalDeviceSurfaceInfo2KHR pSurfaceInfo,
 IntBuffer pSurfaceFormatCount,
 @Nullable
 VkSurfaceFormat2KHR.Buffer pSurfaceFormats)

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 - the physical device that will be associated with the swapchain to be created, as described for CreateSwapchainKHR.

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

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

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

vkGetPhysicalDeviceSurfaceFormats2KHR

public static int vkGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
 VkPhysicalDeviceSurfaceInfo2KHR pSurfaceInfo,
 int[] pSurfaceFormatCount,
 @Nullable
 VkSurfaceFormat2KHR.Buffer pSurfaceFormats)

Array version of: GetPhysicalDeviceSurfaceFormats2KHR