Class KHRGetDisplayProperties2
- java.lang.Object
-
- org.lwjgl.vulkan.KHRGetDisplayProperties2
-
public class KHRGetDisplayProperties2 extends java.lang.Object
This extension provides new entry points to query device display properties and capabilities in a way that can be easily extended by other extensions, without introducing any further entry points. 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
- Requires Vulkan 1.0
- Requires
VK_KHR_display
- Contact
- James Jones cubanismo
- 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 java.lang.String
VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME
The extension name.static int
VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION
The extension specification version.static int
VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR
VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHRExtendsVkStructureType
.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static int
nvkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, long pPropertyCount, long pProperties)
Unsafe version of:GetDisplayModeProperties2KHR
static int
nvkGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice, long pDisplayPlaneInfo, long pCapabilities)
Unsafe version of:GetDisplayPlaneCapabilities2KHR
static int
nvkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)
Unsafe version of:GetPhysicalDeviceDisplayPlaneProperties2KHR
static int
nvkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)
Unsafe version of:GetPhysicalDeviceDisplayProperties2KHR
static int
vkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, VkDisplayModeProperties2KHR.Buffer pProperties)
Array version of:GetDisplayModeProperties2KHR
static int
vkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, java.nio.IntBuffer pPropertyCount, VkDisplayModeProperties2KHR.Buffer pProperties)
Query information about the available display modes.static int
vkGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice, VkDisplayPlaneInfo2KHR pDisplayPlaneInfo, VkDisplayPlaneCapabilities2KHR pCapabilities)
Query capabilities of a mode and plane combination.static int
vkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPlaneProperties2KHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayPlaneProperties2KHR
static int
vkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayPlaneProperties2KHR.Buffer pProperties)
Query information about the available display planes.static int
vkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayProperties2KHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayProperties2KHR
static int
vkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayProperties2KHR.Buffer pProperties)
Query information about the available displays.
-
-
-
Field Detail
-
VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION
The extension specification version.
-
VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME
The extension name.
-
-
Method Detail
-
nvkGetPhysicalDeviceDisplayProperties2KHR
public static int nvkGetPhysicalDeviceDisplayProperties2KHR(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(VkPhysicalDevice physicalDevice, java.nio.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 toGetPhysicalDeviceDisplayPropertiesKHR
, with the ability to return extended information via chained output structures.Valid Usage (Implicit)
physicalDevice
must be a validVkPhysicalDevice
handlepPropertyCount
must be a valid pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not 0, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
VkDisplayProperties2KHR
structures
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- 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
- eitherNULL
or a pointer to an array ofVkDisplayProperties2KHR
structures.
-
nvkGetPhysicalDeviceDisplayPlaneProperties2KHR
public static int nvkGetPhysicalDeviceDisplayPlaneProperties2KHR(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(VkPhysicalDevice physicalDevice, java.nio.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 toGetPhysicalDeviceDisplayPlanePropertiesKHR
, with the ability to return extended information via chained output structures.Valid Usage (Implicit)
physicalDevice
must be a validVkPhysicalDevice
handlepPropertyCount
must be a valid pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not 0, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
VkDisplayPlaneProperties2KHR
structures
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- 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
- eitherNULL
or a pointer to an array ofVkDisplayPlaneProperties2KHR
structures.
-
nvkGetDisplayModeProperties2KHR
public static int nvkGetDisplayModeProperties2KHR(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(VkPhysicalDevice physicalDevice, long display, java.nio.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 toGetDisplayModePropertiesKHR
, with the ability to return extended information via chained output structures.Valid Usage (Implicit)
physicalDevice
must be a validVkPhysicalDevice
handledisplay
must be a validVkDisplayKHR
handlepPropertyCount
must be a valid pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not 0, andpProperties
is notNULL
,pProperties
must be a valid pointer to an array ofpPropertyCount
VkDisplayModeProperties2KHR
structures
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
physicalDevice
- the physical device associated withdisplay
.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
- eitherNULL
or a pointer to an array ofVkDisplayModeProperties2KHR
structures.
-
nvkGetDisplayPlaneCapabilities2KHR
public static int nvkGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice, long pDisplayPlaneInfo, long pCapabilities)
Unsafe version of:GetDisplayPlaneCapabilities2KHR
-
vkGetDisplayPlaneCapabilities2KHR
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 toGetDisplayPlaneCapabilitiesKHR
, 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 validVkPhysicalDevice
handlepDisplayPlaneInfo
must be a valid pointer to a validVkDisplayPlaneInfo2KHR
structurepCapabilities
must be a valid pointer to aVkDisplayPlaneCapabilities2KHR
structure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
physicalDevice
- the physical device associated withpDisplayPlaneInfo
.pDisplayPlaneInfo
- a pointer to an instance of theVkDisplayPlaneInfo2KHR
structure describing the plane and mode.pCapabilities
- a pointer to aVkDisplayPlaneCapabilities2KHR
structure in which the capabilities are returned.
-
vkGetPhysicalDeviceDisplayProperties2KHR
public static int vkGetPhysicalDeviceDisplayProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, @Nullable VkDisplayProperties2KHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayProperties2KHR
-
vkGetPhysicalDeviceDisplayPlaneProperties2KHR
public static int vkGetPhysicalDeviceDisplayPlaneProperties2KHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, @Nullable VkDisplayPlaneProperties2KHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayPlaneProperties2KHR
-
vkGetDisplayModeProperties2KHR
public static int vkGetDisplayModeProperties2KHR(VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, @Nullable VkDisplayModeProperties2KHR.Buffer pProperties)
Array version of:GetDisplayModeProperties2KHR
-
-