org.lwjgl.vulkan

Class KHRDisplay

java.lang.Object

org.lwjgl.vulkan.KHRDisplay

public class KHRDisplay
extends java.lang.Object

This extension provides the API to enumerate displays and available modes on a given device.

Examples

Note

The example code for the VK_KHR_display and VK_KHR_display_swapchain extensions was removed from the appendix after revision 1.0.43. The display enumeration example code was ported to the cube demo that is shipped with the official Khronos SDK, and is being kept up-to-date in that location (see: https://github.com/KhronosGroup/Vulkan-Tools/blob/master/cube/cube.c).

Name String

VK_KHR_display

Extension Type

Instance extension

Registered Extension Number

3

Revision

23

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_surface

Contact

• James Jones cubanismo
• Norbert Nopper FslNopper

Last Modified Date

2017-03-13

IP Status

No known IP claims.

Contributors

• James Jones, NVIDIA
• Norbert Nopper, Freescale
• Jeff Vigil, Qualcomm
• Daniel Rakos, AMD

Field Summary

Fields

Modifier and Type	Field and Description
static int	VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type
static int	VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type
static int	VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type
static int	VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type
static java.lang.String	VK_KHR_DISPLAY_EXTENSION_NAME The extension name.
static int	VK_KHR_DISPLAY_SPEC_VERSION The extension specification version.
static int	VK_OBJECT_TYPE_DISPLAY_KHR Extends VkObjectType.
static int	VK_OBJECT_TYPE_DISPLAY_MODE_KHR Extends VkObjectType.
static int	VK_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR Extends VkStructureType.

Method Summary

Modifier and Type	Method and Description
static int	nvkCreateDisplayModeKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, long pCreateInfo, long pAllocator, long pMode) Unsafe version of: CreateDisplayModeKHR
static int	nvkCreateDisplayPlaneSurfaceKHR(org.lwjgl.vulkan.VkInstance instance, long pCreateInfo, long pAllocator, long pSurface) Unsafe version of: CreateDisplayPlaneSurfaceKHR
static int	nvkGetDisplayModePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, long pPropertyCount, long pProperties) Unsafe version of: GetDisplayModePropertiesKHR
static int	nvkGetDisplayPlaneCapabilitiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long mode, int planeIndex, long pCapabilities) Unsafe version of: GetDisplayPlaneCapabilitiesKHR
static int	nvkGetDisplayPlaneSupportedDisplaysKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int planeIndex, long pDisplayCount, long pDisplays) Unsafe version of: GetDisplayPlaneSupportedDisplaysKHR
static int	nvkGetPhysicalDeviceDisplayPlanePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties) Unsafe version of: GetPhysicalDeviceDisplayPlanePropertiesKHR
static int	nvkGetPhysicalDeviceDisplayPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties) Unsafe version of: GetPhysicalDeviceDisplayPropertiesKHR
static int	vkCreateDisplayModeKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, VkDisplayModeCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pMode) Array version of: CreateDisplayModeKHR
static int	vkCreateDisplayModeKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, VkDisplayModeCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pMode) Create a display mode.
static int	vkCreateDisplayPlaneSurfaceKHR(org.lwjgl.vulkan.VkInstance instance, VkDisplaySurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface) Array version of: CreateDisplayPlaneSurfaceKHR
static int	vkCreateDisplayPlaneSurfaceKHR(org.lwjgl.vulkan.VkInstance instance, VkDisplaySurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSurface) Create a VkSurfaceKHR structure representing a display plane and mode.
static int	vkGetDisplayModePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, VkDisplayModePropertiesKHR.Buffer pProperties) Array version of: GetDisplayModePropertiesKHR
static int	vkGetDisplayModePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long display, java.nio.IntBuffer pPropertyCount, VkDisplayModePropertiesKHR.Buffer pProperties) Query the set of mode properties supported by the display.
static int	vkGetDisplayPlaneCapabilitiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long mode, int planeIndex, VkDisplayPlaneCapabilitiesKHR pCapabilities) Query capabilities of a mode and plane combination.
static int	vkGetDisplayPlaneSupportedDisplaysKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int planeIndex, int[] pDisplayCount, long[] pDisplays) Array version of: GetDisplayPlaneSupportedDisplaysKHR
static int	vkGetDisplayPlaneSupportedDisplaysKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int planeIndex, java.nio.IntBuffer pDisplayCount, java.nio.LongBuffer pDisplays) Query the list of displays a plane supports.
static int	vkGetPhysicalDeviceDisplayPlanePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPlanePropertiesKHR.Buffer pProperties) Array version of: GetPhysicalDeviceDisplayPlanePropertiesKHR
static int	vkGetPhysicalDeviceDisplayPlanePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayPlanePropertiesKHR.Buffer pProperties) Query the plane properties.
static int	vkGetPhysicalDeviceDisplayPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPropertiesKHR.Buffer pProperties) Array version of: GetPhysicalDeviceDisplayPropertiesKHR
static int	vkGetPhysicalDeviceDisplayPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayPropertiesKHR.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 Detail

VK_KHR_DISPLAY_SPEC_VERSION

public static final int VK_KHR_DISPLAY_SPEC_VERSION

The extension specification version.

See Also:

Constant Field Values

VK_KHR_DISPLAY_EXTENSION_NAME

public static final java.lang.String VK_KHR_DISPLAY_EXTENSION_NAME

The extension name.

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
• STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR

See Also:

Constant Field Values

VK_OBJECT_TYPE_DISPLAY_KHR

public static final int VK_OBJECT_TYPE_DISPLAY_KHR

Extends VkObjectType.

Enum values:

• OBJECT_TYPE_DISPLAY_KHR
• OBJECT_TYPE_DISPLAY_MODE_KHR

See Also:

Constant Field Values

VK_OBJECT_TYPE_DISPLAY_MODE_KHR

public static final int VK_OBJECT_TYPE_DISPLAY_MODE_KHR

Extends VkObjectType.

Enum values:

• OBJECT_TYPE_DISPLAY_KHR
• OBJECT_TYPE_DISPLAY_MODE_KHR

See Also:

Constant Field Values

VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR

public static final int VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha channel of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color channels.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color channels.

See Also

VkDisplayPlaneAlphaFlagsKHR, VkDisplaySurfaceCreateInfoKHR

See Also:

Constant Field Values

VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR

public static final int VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha channel of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color channels.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color channels.

See Also

VkDisplayPlaneAlphaFlagsKHR, VkDisplaySurfaceCreateInfoKHR

See Also:

Constant Field Values

VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR

public static final int VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha channel of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color channels.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color channels.

See Also

VkDisplayPlaneAlphaFlagsKHR, VkDisplaySurfaceCreateInfoKHR

See Also:

Constant Field Values

VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR

public static final int VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

• DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR specifies that the source image will be treated as opaque.
• DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR specifies that a global alpha value must be specified that will be applied to all pixels in the source image.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR specifies that the alpha value will be determined by the alpha channel of the source image’s pixels. If the source format contains no alpha values, no blending will be applied. The source alpha values are not premultiplied into the source image’s other color channels.
• DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR is equivalent to DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR, except the source alpha values are assumed to be premultiplied into the source image’s other color channels.

See Also

VkDisplayPlaneAlphaFlagsKHR, VkDisplaySurfaceCreateInfoKHR

See Also:

Constant Field Values

Method Detail

nvkGetPhysicalDeviceDisplayPropertiesKHR

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

Unsafe version of: GetPhysicalDeviceDisplayPropertiesKHR

Parameters:

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

vkGetPhysicalDeviceDisplayPropertiesKHR

public static int vkGetPhysicalDeviceDisplayPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                          java.nio.IntBuffer pPropertyCount,
                                                          @Nullable
                                                          VkDisplayPropertiesKHR.Buffer pProperties)

Query information about the available displays.

C Specification

Various functions are provided for enumerating the available display devices present on a Vulkan physical device. To query information about the available displays, call:

 VkResult vkGetPhysicalDeviceDisplayPropertiesKHR(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pPropertyCount,
     VkDisplayPropertiesKHR*                     pProperties);

Description

If pProperties is NULL, then the number of display devices available for physicalDevice is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If the value of pPropertyCount is less than the number of display devices for physicalDevice, at most pPropertyCount structures will be written. If pPropertyCount is smaller than the number of display devices available for physicalDevice, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.

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 VkDisplayPropertiesKHR 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

VkDisplayPropertiesKHR

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 VkDisplayPropertiesKHR structures.

nvkGetPhysicalDeviceDisplayPlanePropertiesKHR

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

Unsafe version of: GetPhysicalDeviceDisplayPlanePropertiesKHR

Parameters:

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

vkGetPhysicalDeviceDisplayPlanePropertiesKHR

public static int vkGetPhysicalDeviceDisplayPlanePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                               java.nio.IntBuffer pPropertyCount,
                                                               @Nullable
                                                               VkDisplayPlanePropertiesKHR.Buffer pProperties)

Query the plane properties.

C Specification

Images are presented to individual planes on a display. Devices must support at least one plane on each display. Planes can be stacked and blended to composite multiple images on one display. Devices may support only a fixed stacking order and fixed mapping between planes and displays, or they may allow arbitrary application specified stacking orders and mappings between planes and displays. To query the properties of device display planes, call:

 VkResult vkGetPhysicalDeviceDisplayPlanePropertiesKHR(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pPropertyCount,
     VkDisplayPlanePropertiesKHR*                pProperties);

Description

If pProperties is NULL, then the number of display planes available for physicalDevice is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If the value of pPropertyCount is less than the number of display planes for physicalDevice, at most pPropertyCount structures will be written.

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 VkDisplayPlanePropertiesKHR 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

VkDisplayPlanePropertiesKHR

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 VkDisplayPlanePropertiesKHR structures.

nvkGetDisplayPlaneSupportedDisplaysKHR

public static int nvkGetDisplayPlaneSupportedDisplaysKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                         int planeIndex,
                                                         long pDisplayCount,
                                                         long pDisplays)

Unsafe version of: GetDisplayPlaneSupportedDisplaysKHR

Parameters:

pDisplayCount - a pointer to an integer related to the number of displays available or queried, as described below.

vkGetDisplayPlaneSupportedDisplaysKHR

public static int vkGetDisplayPlaneSupportedDisplaysKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                        int planeIndex,
                                                        java.nio.IntBuffer pDisplayCount,
                                                        @Nullable
                                                        java.nio.LongBuffer pDisplays)

Query the list of displays a plane supports.

C Specification

To determine which displays a plane is usable with, call

 VkResult vkGetDisplayPlaneSupportedDisplaysKHR(
     VkPhysicalDevice                            physicalDevice,
     uint32_t                                    planeIndex,
     uint32_t*                                   pDisplayCount,
     VkDisplayKHR*                               pDisplays);

Description

If pDisplays is NULL, then the number of displays usable with the specified planeIndex for physicalDevice is returned in pDisplayCount. Otherwise, pDisplayCount must point to a variable set by the user to the number of elements in the pDisplays array, and on return the variable is overwritten with the number of handles actually written to pDisplays. If the value of pDisplayCount is less than the number of display planes for physicalDevice, at most pDisplayCount handles will be written. If pDisplayCount is smaller than the number of displays usable with the specified planeIndex for physicalDevice, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.

Valid Usage

• planeIndex must be less than the number of display planes supported by the device as determined by calling vkGetPhysicalDeviceDisplayPlanePropertiesKHR

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pDisplayCount must be a valid pointer to a uint32_t value
• If the value referenced by pDisplayCount is not 0, and pDisplays is not NULL, pDisplays must be a valid pointer to an array of pDisplayCount VkDisplayKHR handles

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

Parameters:

physicalDevice - a physical device.

planeIndex - the plane which the application wishes to use, and must be in the range [0, physical device plane count - 1].

pDisplayCount - a pointer to an integer related to the number of displays available or queried, as described below.

pDisplays - either NULL or a pointer to an array of VkDisplayKHR handles.

nvkGetDisplayModePropertiesKHR

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

Unsafe version of: GetDisplayModePropertiesKHR

Parameters:

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

vkGetDisplayModePropertiesKHR

public static int vkGetDisplayModePropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                long display,
                                                java.nio.IntBuffer pPropertyCount,
                                                @Nullable
                                                VkDisplayModePropertiesKHR.Buffer pProperties)

Query the set of mode properties supported by the display.

C Specification

Each display has one or more supported modes associated with it by default. These built-in modes are queried by calling:

 VkResult vkGetDisplayModePropertiesKHR(
     VkPhysicalDevice                            physicalDevice,
     VkDisplayKHR                                display,
     uint32_t*                                   pPropertyCount,
     VkDisplayModePropertiesKHR*                 pProperties);

Description

If pProperties is NULL, then the number of display modes available on the specified display for physicalDevice is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If the value of pPropertyCount is less than the number of display modes for physicalDevice, at most pPropertyCount structures will be written. If pPropertyCount is smaller than the number of display modes available on the specified display for physicalDevice, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.

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 VkDisplayModePropertiesKHR 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

VkDisplayModePropertiesKHR

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 VkDisplayModePropertiesKHR structures.

nvkCreateDisplayModeKHR

public static int nvkCreateDisplayModeKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                          long display,
                                          long pCreateInfo,
                                          long pAllocator,
                                          long pMode)

Unsafe version of: CreateDisplayModeKHR

vkCreateDisplayModeKHR

public static int vkCreateDisplayModeKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                         long display,
                                         VkDisplayModeCreateInfoKHR pCreateInfo,
                                         @Nullable
                                         VkAllocationCallbacks pAllocator,
                                         java.nio.LongBuffer pMode)

Create a display mode.

C Specification

Additional modes may also be created by calling:

 VkResult vkCreateDisplayModeKHR(
     VkPhysicalDevice                            physicalDevice,
     VkDisplayKHR                                display,
     const VkDisplayModeCreateInfoKHR*           pCreateInfo,
     const VkAllocationCallbacks*                pAllocator,
     VkDisplayModeKHR*                           pMode);

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• display must be a valid VkDisplayKHR handle
• pCreateInfo must be a valid pointer to a valid VkDisplayModeCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pMode must be a valid pointer to a VkDisplayModeKHR handle

Host Synchronization

• Host access to display must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED

See Also

VkAllocationCallbacks, VkDisplayModeCreateInfoKHR

Parameters:

physicalDevice - the physical device associated with display.

display - the display to create an additional mode for.

pCreateInfo - a VkDisplayModeCreateInfoKHR structure describing the new mode to create.

pAllocator - the allocator used for host memory allocated for the display mode object when there is no more specific allocator available (see Memory Allocation).

pMode - returns the handle of the mode created.

nvkGetDisplayPlaneCapabilitiesKHR

public static int nvkGetDisplayPlaneCapabilitiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                    long mode,
                                                    int planeIndex,
                                                    long pCapabilities)

Unsafe version of: GetDisplayPlaneCapabilitiesKHR

vkGetDisplayPlaneCapabilitiesKHR

public static int vkGetDisplayPlaneCapabilitiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                   long mode,
                                                   int planeIndex,
                                                   VkDisplayPlaneCapabilitiesKHR pCapabilities)

Query capabilities of a mode and plane combination.

C Specification

Applications that wish to present directly to a display must select which layer, or "plane" of the display they wish to target, and a mode to use with the display. Each display supports at least one plane. The capabilities of a given mode and plane combination are determined by calling:

 VkResult vkGetDisplayPlaneCapabilitiesKHR(
     VkPhysicalDevice                            physicalDevice,
     VkDisplayModeKHR                            mode,
     uint32_t                                    planeIndex,
     VkDisplayPlaneCapabilitiesKHR*              pCapabilities);

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• mode must be a valid VkDisplayModeKHR handle
• pCapabilities must be a valid pointer to a VkDisplayPlaneCapabilitiesKHR structure

Host Synchronization

• Host access to mode must be externally synchronized

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

VkDisplayPlaneCapabilitiesKHR

Parameters:

physicalDevice - the physical device associated with display

mode - the display mode the application intends to program when using the specified plane. Note this parameter also implicitly specifies a display.

planeIndex - the plane which the application intends to use with the display, and is less than the number of display planes supported by the device.

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

nvkCreateDisplayPlaneSurfaceKHR

public static int nvkCreateDisplayPlaneSurfaceKHR(org.lwjgl.vulkan.VkInstance instance,
                                                  long pCreateInfo,
                                                  long pAllocator,
                                                  long pSurface)

Unsafe version of: CreateDisplayPlaneSurfaceKHR

vkCreateDisplayPlaneSurfaceKHR

public static int vkCreateDisplayPlaneSurfaceKHR(org.lwjgl.vulkan.VkInstance instance,
                                                 VkDisplaySurfaceCreateInfoKHR pCreateInfo,
                                                 @Nullable
                                                 VkAllocationCallbacks pAllocator,
                                                 java.nio.LongBuffer pSurface)

Create a VkSurfaceKHR structure representing a display plane and mode.

C Specification

A complete display configuration includes a mode, one or more display planes and any parameters describing their behavior, and parameters describing some aspects of the images associated with those planes. Display surfaces describe the configuration of a single plane within a complete display configuration. To create a VkSurfaceKHR structure for a display surface, call:

 VkResult vkCreateDisplayPlaneSurfaceKHR(
     VkInstance                                  instance,
     const VkDisplaySurfaceCreateInfoKHR*        pCreateInfo,
     const VkAllocationCallbacks*                pAllocator,
     VkSurfaceKHR*                               pSurface);

Valid Usage (Implicit)

• instance must be a valid VkInstance handle
• pCreateInfo must be a valid pointer to a valid VkDisplaySurfaceCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pSurface must be a valid pointer to a VkSurfaceKHR handle

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

VkAllocationCallbacks, VkDisplaySurfaceCreateInfoKHR

Parameters:

instance - the instance corresponding to the physical device the targeted display is on.

pCreateInfo - a pointer to a VkDisplaySurfaceCreateInfoKHR structure specifying which mode, plane, and other parameters to use, as described below.

pAllocator - the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

pSurface - a pointer to a VkSurfaceKHR handle in which the created surface is returned.

vkGetPhysicalDeviceDisplayPropertiesKHR

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

Array version of: GetPhysicalDeviceDisplayPropertiesKHR

vkGetPhysicalDeviceDisplayPlanePropertiesKHR

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

Array version of: GetPhysicalDeviceDisplayPlanePropertiesKHR

vkGetDisplayPlaneSupportedDisplaysKHR

public static int vkGetDisplayPlaneSupportedDisplaysKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                                        int planeIndex,
                                                        int[] pDisplayCount,
                                                        @Nullable
                                                        long[] pDisplays)

Array version of: GetDisplayPlaneSupportedDisplaysKHR

vkGetDisplayModePropertiesKHR

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

Array version of: GetDisplayModePropertiesKHR

vkCreateDisplayModeKHR

public static int vkCreateDisplayModeKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
                                         long display,
                                         VkDisplayModeCreateInfoKHR pCreateInfo,
                                         @Nullable
                                         VkAllocationCallbacks pAllocator,
                                         long[] pMode)

Array version of: CreateDisplayModeKHR

vkCreateDisplayPlaneSurfaceKHR

public static int vkCreateDisplayPlaneSurfaceKHR(org.lwjgl.vulkan.VkInstance instance,
                                                 VkDisplaySurfaceCreateInfoKHR pCreateInfo,
                                                 @Nullable
                                                 VkAllocationCallbacks pAllocator,
                                                 long[] pSurface)

Array version of: CreateDisplayPlaneSurfaceKHR