Package org.lwjgl.vulkan

Class KHRGetDisplayProperties2

java.lang.Object

org.lwjgl.vulkan.KHRGetDisplayProperties2

public class KHRGetDisplayProperties2
extends Object

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

Name String

VK_KHR_get_display_properties2

Extension Type

Instance extension

Registered Extension Number

122

Revision

1

Extension and Version Dependencies

VK_KHR_display

Contact

• James Jones cubanismo

Other Extension Metadata

Last Modified Date

2017-02-21

IP Status

No known IP claims.

Contributors

• Ian Elliott, Google
• James Jones, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME	The extension name.
static final int	VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetDisplayModeProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, long pPropertyCount, long pProperties)	Unsafe version of: GetDisplayModeProperties2KHR
static int	nvkGetDisplayPlaneCapabilities2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pDisplayPlaneInfo, long pCapabilities)	Unsafe version of: GetDisplayPlaneCapabilities2KHR
static int	nvkGetPhysicalDeviceDisplayPlaneProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)	Unsafe version of: GetPhysicalDeviceDisplayPlaneProperties2KHR
static int	nvkGetPhysicalDeviceDisplayProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)	Unsafe version of: GetPhysicalDeviceDisplayProperties2KHR
static int	vkGetDisplayModeProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, @Nullable VkDisplayModeProperties2KHR.Buffer pProperties)	Array version of: GetDisplayModeProperties2KHR
static int	vkGetDisplayModeProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, IntBuffer pPropertyCount, @Nullable VkDisplayModeProperties2KHR.Buffer pProperties)	Query information about the available display modes.
static int	vkGetDisplayPlaneCapabilities2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, VkDisplayPlaneInfo2KHR pDisplayPlaneInfo, VkDisplayPlaneCapabilities2KHR pCapabilities)	Query capabilities of a mode and plane combination.
static int	vkGetPhysicalDeviceDisplayPlaneProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int[] pPropertyCount, @Nullable VkDisplayPlaneProperties2KHR.Buffer pProperties)	Array version of: GetPhysicalDeviceDisplayPlaneProperties2KHR
static int	vkGetPhysicalDeviceDisplayPlaneProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, IntBuffer pPropertyCount, @Nullable VkDisplayPlaneProperties2KHR.Buffer pProperties)	Query information about the available display planes.
static int	vkGetPhysicalDeviceDisplayProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int[] pPropertyCount, @Nullable VkDisplayProperties2KHR.Buffer pProperties)	Array version of: GetPhysicalDeviceDisplayProperties2KHR
static int	vkGetPhysicalDeviceDisplayProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, IntBuffer pPropertyCount, @Nullable VkDisplayProperties2KHR.Buffer pProperties)	Query information about the available displays.

Methods inherited from class java.lang.Object

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

Field Details

VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION

public static final int VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME

public static final String VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR

public static final int VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR

public static final int VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR

public static final int VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

public static final int VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

public static final int VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
• STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

See Also:

• Constant Field Values

Method Details

nvkGetPhysicalDeviceDisplayProperties2KHR

public static int nvkGetPhysicalDeviceDisplayProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long pPropertyCount,
 long pProperties)

Unsafe version of: GetPhysicalDeviceDisplayProperties2KHR

Parameters:

pPropertyCount - a pointer to an integer related to the number of display devices available or queried, as described below.

vkGetPhysicalDeviceDisplayProperties2KHR

public static int vkGetPhysicalDeviceDisplayProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 IntBuffer pPropertyCount,
 @Nullable VkDisplayProperties2KHR.Buffer pProperties)

Query information about the available displays.

C Specification

To query information about the available displays, call:

 VkResult vkGetPhysicalDeviceDisplayProperties2KHR(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pPropertyCount,
     VkDisplayProperties2KHR*                    pProperties);

Description

vkGetPhysicalDeviceDisplayProperties2KHR behaves similarly to GetPhysicalDeviceDisplayPropertiesKHR, with the ability to return extended information via chained output structures.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• 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 VkDisplayProperties2KHR 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

See Also

VkDisplayProperties2KHR

Parameters:

physicalDevice - a physical device.

pPropertyCount - a pointer to an integer related to the number of display devices available or queried, as described below.

pProperties - either NULL or a pointer to an array of VkDisplayProperties2KHR structures.

nvkGetPhysicalDeviceDisplayPlaneProperties2KHR

public static int nvkGetPhysicalDeviceDisplayPlaneProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long pPropertyCount,
 long pProperties)

Unsafe version of: GetPhysicalDeviceDisplayPlaneProperties2KHR

Parameters:

pPropertyCount - a pointer to an integer related to the number of display planes available or queried, as described below.

vkGetPhysicalDeviceDisplayPlaneProperties2KHR

public static int vkGetPhysicalDeviceDisplayPlaneProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 IntBuffer pPropertyCount,
 @Nullable VkDisplayPlaneProperties2KHR.Buffer pProperties)

Query information about the available display planes.

C Specification

To query the properties of a device’s display planes, call:

 VkResult vkGetPhysicalDeviceDisplayPlaneProperties2KHR(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pPropertyCount,
     VkDisplayPlaneProperties2KHR*               pProperties);

Description

vkGetPhysicalDeviceDisplayPlaneProperties2KHR behaves similarly to GetPhysicalDeviceDisplayPlanePropertiesKHR, with the ability to return extended information via chained output structures.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• 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 VkDisplayPlaneProperties2KHR 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

See Also

VkDisplayPlaneProperties2KHR

Parameters:

physicalDevice - a physical device.

pPropertyCount - a pointer to an integer related to the number of display planes available or queried, as described below.

pProperties - either NULL or a pointer to an array of VkDisplayPlaneProperties2KHR structures.

nvkGetDisplayModeProperties2KHR

public static int nvkGetDisplayModeProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long display,
 long pPropertyCount,
 long pProperties)

Unsafe version of: GetDisplayModeProperties2KHR

Parameters:

pPropertyCount - a pointer to an integer related to the number of display modes available or queried, as described below.

vkGetDisplayModeProperties2KHR

public static int vkGetDisplayModeProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long display,
 IntBuffer pPropertyCount,
 @Nullable VkDisplayModeProperties2KHR.Buffer pProperties)

Query information about the available display modes.

C Specification

To query the properties of a device’s built-in display modes, call:

 VkResult vkGetDisplayModeProperties2KHR(
     VkPhysicalDevice                            physicalDevice,
     VkDisplayKHR                                display,
     uint32_t*                                   pPropertyCount,
     VkDisplayModeProperties2KHR*                pProperties);

Description

vkGetDisplayModeProperties2KHR behaves similarly to GetDisplayModePropertiesKHR, with the ability to return extended information via chained output structures.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• display must be a valid VkDisplayKHR handle
• 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 VkDisplayModeProperties2KHR structures
• display must have been created, allocated, or retrieved from physicalDevice

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDisplayModeProperties2KHR

Parameters:

physicalDevice - the physical device associated with display.

display - the display to query.

pPropertyCount - a pointer to an integer related to the number of display modes available or queried, as described below.

pProperties - either NULL or a pointer to an array of VkDisplayModeProperties2KHR structures.

nvkGetDisplayPlaneCapabilities2KHR

public static int nvkGetDisplayPlaneCapabilities2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long pDisplayPlaneInfo,
 long pCapabilities)

Unsafe version of: GetDisplayPlaneCapabilities2KHR

vkGetDisplayPlaneCapabilities2KHR

public static int vkGetDisplayPlaneCapabilities2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 VkDisplayPlaneInfo2KHR pDisplayPlaneInfo,
 VkDisplayPlaneCapabilities2KHR pCapabilities)

Query capabilities of a mode and plane combination.

C Specification

To query the capabilities of a given mode and plane combination, call:

 VkResult vkGetDisplayPlaneCapabilities2KHR(
     VkPhysicalDevice                            physicalDevice,
     const VkDisplayPlaneInfo2KHR*               pDisplayPlaneInfo,
     VkDisplayPlaneCapabilities2KHR*             pCapabilities);

Description

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

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pDisplayPlaneInfo must be a valid pointer to a valid VkDisplayPlaneInfo2KHR structure
• pCapabilities must be a valid pointer to a VkDisplayPlaneCapabilities2KHR structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDisplayPlaneCapabilities2KHR, VkDisplayPlaneInfo2KHR

Parameters:

physicalDevice - the physical device associated with pDisplayPlaneInfo.

pDisplayPlaneInfo - a pointer to a VkDisplayPlaneInfo2KHR structure describing the plane and mode.

pCapabilities - a pointer to a VkDisplayPlaneCapabilities2KHR structure in which the capabilities are returned.

vkGetPhysicalDeviceDisplayProperties2KHR

public static int vkGetPhysicalDeviceDisplayProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 int[] pPropertyCount,
 @Nullable VkDisplayProperties2KHR.Buffer pProperties)

Array version of: GetPhysicalDeviceDisplayProperties2KHR

vkGetPhysicalDeviceDisplayPlaneProperties2KHR

public static int vkGetPhysicalDeviceDisplayPlaneProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 int[] pPropertyCount,
 @Nullable VkDisplayPlaneProperties2KHR.Buffer pProperties)

Array version of: GetPhysicalDeviceDisplayPlaneProperties2KHR

vkGetDisplayModeProperties2KHR

public static int vkGetDisplayModeProperties2KHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long display,
 int[] pPropertyCount,
 @Nullable VkDisplayModeProperties2KHR.Buffer pProperties)

Array version of: GetDisplayModeProperties2KHR