Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class KHRGetDisplayProperties2

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
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.
VK_KHR_get_display_properties2
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
Other Extension Metadata
Last Modified Date
2017-02-21
IP Status
No known IP claims.
Contributors
  • Ian Elliott, Google
  • James Jones, NVIDIA

Field Summary

Modifier and TypeField and Description
public static final String
VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME

The extension name.

public static final int
VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION

The extension specification version.

public static final int
VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR

Extends VkStructureType.

public static final int
VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

Extends VkStructureType.

public static final int
VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

Extends VkStructureType.

public static final int
VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR

Extends VkStructureType.

public static final int
VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR

Extends VkStructureType.

Constructor Summary

AccessConstructor and Description
protected
KHRGetDisplayProperties2()

Method Summary

Modifier and TypeMethod and Description
public static int
nvkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, long
a pointer to an integer related to the number of display modes available or queried, as described below.
pPropertyCount, long pProperties)

Unsafe version of: GetDisplayModeProperties2KHR

public static int
nvkGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice, long pDisplayPlaneInfo, long pCapabilities)

Unsafe version of: GetDisplayPlaneCapabilities2KHR

public static int
nvkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, long
a pointer to an integer related to the number of display planes available or queried, as described below.
pPropertyCount, long pProperties)

Unsafe version of: GetPhysicalDeviceDisplayPlaneProperties2KHR

public static int
nvkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, long
a pointer to an integer related to the number of display devices available or queried, as described below.
pPropertyCount, long pProperties)

Unsafe version of: GetPhysicalDeviceDisplayProperties2KHR

public static int
vkGetDisplayModeProperties2KHR(VkPhysicalDevice
the physical device associated with display.
physicalDevice, long
the display to query.
display, IntBuffer
a pointer to an integer related to the number of display modes available or queried, as described below.
pPropertyCount, VkDisplayModeProperties2KHR.Buffer
either NULL or a pointer to an array of VkDisplayModeProperties2KHR structures.
pProperties)

Query information about the available display modes.

public static int
vkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, VkDisplayModeProperties2KHR.Buffer pProperties)

Array version of: GetDisplayModeProperties2KHR

public static int
vkGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice
the physical device associated with pDisplayPlaneInfo.
physicalDevice, VkDisplayPlaneInfo2KHR
a pointer to a VkDisplayPlaneInfo2KHR structure describing the plane and mode.
pDisplayPlaneInfo, VkDisplayPlaneCapabilities2KHR
a pointer to a VkDisplayPlaneCapabilities2KHR structure in which the capabilities are returned.
pCapabilities)

Query capabilities of a mode and plane combination.

public static int
vkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice
a physical device.
physicalDevice, IntBuffer
a pointer to an integer related to the number of display planes available or queried, as described below.
pPropertyCount, VkDisplayPlaneProperties2KHR.Buffer
either NULL or a pointer to an array of VkDisplayPlaneProperties2KHR structures.
pProperties)

Query information about the available display planes.

public static int
vkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPlaneProperties2KHR.Buffer pProperties)

Array version of: GetPhysicalDeviceDisplayPlaneProperties2KHR

public static int
vkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice
a physical device.
physicalDevice, IntBuffer
a pointer to an integer related to the number of display devices available or queried, as described below.
pPropertyCount, VkDisplayProperties2KHR.Buffer
either NULL or a pointer to an array of VkDisplayProperties2KHR structures.
pProperties)

Query information about the available displays.

public static int
vkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayProperties2KHR.Buffer pProperties)

Array version of: GetPhysicalDeviceDisplayProperties2KHR

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAMEback to summary
public static final String VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME

The extension name.

VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSIONback to summary
public static final int VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION

The extension specification version.

VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHRback to summary
public static final int VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR

Extends VkStructureType.

Enum values:
VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHRback to summary
public static final int VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR

Extends VkStructureType.

Enum values:
VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHRback to summary
public static final int VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

Extends VkStructureType.

Enum values:
VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHRback to summary
public static final int VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR

Extends VkStructureType.

Enum values:
VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHRback to summary
public static final int VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR

Extends VkStructureType.

Enum values:

Constructor Detail

KHRGetDisplayProperties2back to summary
protected KHRGetDisplayProperties2()

Method Detail

nvkGetDisplayModeProperties2KHRback to summary
public static int nvkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, long pPropertyCount, long pProperties)

Unsafe version of: GetDisplayModeProperties2KHR

Parameters
pPropertyCount:long

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

nvkGetDisplayPlaneCapabilities2KHRback to summary
public static int nvkGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice, long pDisplayPlaneInfo, long pCapabilities)

Unsafe version of: GetDisplayPlaneCapabilities2KHR

nvkGetPhysicalDeviceDisplayPlaneProperties2KHRback to summary
public static int nvkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)

Unsafe version of: GetPhysicalDeviceDisplayPlaneProperties2KHR

Parameters
pPropertyCount:long

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

nvkGetPhysicalDeviceDisplayProperties2KHRback to summary
public static int nvkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)

Unsafe version of: GetPhysicalDeviceDisplayProperties2KHR

Parameters
pPropertyCount:long

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

vkGetDisplayModeProperties2KHRback to summary
public static int vkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, IntBuffer pPropertyCount, 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
On failure, this command returns
See Also

VkDisplayModeProperties2KHR

Parameters
physicalDevice:VkPhysicalDevice

the physical device associated with display.

display:long

the display to query.

pPropertyCount:IntBuffer

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

pProperties:VkDisplayModeProperties2KHR.Buffer

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

Annotations
@NativeType:VkResult
vkGetDisplayModeProperties2KHRback to summary
public static int vkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, VkDisplayModeProperties2KHR.Buffer pProperties)

Array version of: GetDisplayModeProperties2KHR

Annotations
@NativeType:VkResult
vkGetDisplayPlaneCapabilities2KHRback to summary
public static int vkGetDisplayPlaneCapabilities2KHR(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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

VkDisplayPlaneCapabilities2KHR, VkDisplayPlaneInfo2KHR

Parameters
physicalDevice:VkPhysicalDevice

the physical device associated with pDisplayPlaneInfo.

pDisplayPlaneInfo:VkDisplayPlaneInfo2KHR

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

pCapabilities:VkDisplayPlaneCapabilities2KHR

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

Annotations
@NativeType:VkResult
vkGetPhysicalDeviceDisplayPlaneProperties2KHRback to summary
public static int vkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, IntBuffer pPropertyCount, 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
On failure, this command returns
See Also

VkDisplayPlaneProperties2KHR

Parameters
physicalDevice:VkPhysicalDevice

a physical device.

pPropertyCount:IntBuffer

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

pProperties:VkDisplayPlaneProperties2KHR.Buffer

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

Annotations
@NativeType:VkResult
vkGetPhysicalDeviceDisplayPlaneProperties2KHRback to summary
public static int vkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPlaneProperties2KHR.Buffer pProperties)

Array version of: GetPhysicalDeviceDisplayPlaneProperties2KHR

Annotations
@NativeType:VkResult
vkGetPhysicalDeviceDisplayProperties2KHRback to summary
public static int vkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, IntBuffer pPropertyCount, 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
On failure, this command returns
See Also

VkDisplayProperties2KHR

Parameters
physicalDevice:VkPhysicalDevice

a physical device.

pPropertyCount:IntBuffer

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

pProperties:VkDisplayProperties2KHR.Buffer

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

Annotations
@NativeType:VkResult
vkGetPhysicalDeviceDisplayProperties2KHRback to summary
public static int vkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayProperties2KHR.Buffer pProperties)

Array version of: GetPhysicalDeviceDisplayProperties2KHR

Annotations
@NativeType:VkResult