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.
-
-
Field Summary
Fields Modifier and Type Field and Description static int
VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR
A global alpha value must be specified that will be applied to all pixels in the source image.static int
VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR
The source image will be treated as opaque.static int
VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR
The alpha value will be determined by the alpha channel of the source image’s pixels.static int
VK_DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR
This is equivalent toDISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR
except the source alpha values are assumed to be premultiplied into the source image’s other color channels.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_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
VK_STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHRVkStructureType
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method and Description static int
vkCreateDisplayModeKHR(VkPhysicalDevice physicalDevice, long display, VkDisplayModeCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pMode)
Array version of:CreateDisplayModeKHR
static int
vkCreateDisplayModeKHR(VkPhysicalDevice physicalDevice, long display, VkDisplayModeCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pMode)
Creates a display mode.static int
vkCreateDisplayPlaneSurfaceKHR(VkInstance instance, VkDisplaySurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)
Array version of:CreateDisplayPlaneSurfaceKHR
static int
vkCreateDisplayPlaneSurfaceKHR(VkInstance instance, VkDisplaySurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSurface)
Creates aVkSurfaceKHR
structure representing a display plane and mode.static int
vkGetDisplayModePropertiesKHR(VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, VkDisplayModePropertiesKHR.Buffer pProperties)
Array version of:GetDisplayModePropertiesKHR
static int
vkGetDisplayModePropertiesKHR(VkPhysicalDevice physicalDevice, long display, java.nio.IntBuffer pPropertyCount, VkDisplayModePropertiesKHR.Buffer pProperties)
Gets the set of mode properties supported by the display.static int
vkGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, long mode, int planeIndex, VkDisplayPlaneCapabilitiesKHR pCapabilities)
Gets the capabilities of a mode and plane combination.static int
vkGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, int planeIndex, int[] pDisplayCount, long[] pDisplays)
Array version of:GetDisplayPlaneSupportedDisplaysKHR
static int
vkGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, int planeIndex, java.nio.IntBuffer pDisplayCount, java.nio.LongBuffer pDisplays)
Determines which displays a plane is usable with.static int
vkGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPlanePropertiesKHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayPlanePropertiesKHR
static int
vkGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayPlanePropertiesKHR.Buffer pProperties)
Queries the plane properties.static int
vkGetPhysicalDeviceDisplayPropertiesKHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPropertiesKHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayPropertiesKHR
static int
vkGetPhysicalDeviceDisplayPropertiesKHR(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayPropertiesKHR.Buffer pProperties)
Queries information about the available displays.
-
-
-
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
VkStructureType- 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
VkStructureType- See Also:
- Constant Field Values
-
VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR
public static final int VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR
The source image will be treated as opaque.- See Also:
- Constant Field Values
-
VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR
public static final int VK_DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR
A global alpha value must be specified that will be applied to all pixels in the source image.- 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
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.- 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
This is equivalent toDISPLAY_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:
- Constant Field Values
-
-
Method Detail
-
vkGetPhysicalDeviceDisplayPropertiesKHR
public static int vkGetPhysicalDeviceDisplayPropertiesKHR(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayPropertiesKHR.Buffer pProperties)
Queries information about the available displays.If
pProperties
isNULL
, then the number of display devices available forphysicalDevice
is returned inpPropertyCount
. Otherwise,pPropertyCount
must point to a variable set by the user to the number of elements in thepProperties
array, and on return the variable is overwritten with the number of structures actually written topProperties
. If the value ofpPropertyCount
is less than the number of display devices forphysicalDevice
, at mostpPropertyCount
structures will be written. IfpPropertyCount
is smaller than the number of display devices available forphysicalDevice
,INCOMPLETE
will be returned instead ofSUCCESS
to indicate that not all the available values were returned.Valid Usage
physicalDevice
must be a validVkPhysicalDevice
handlepPropertyCount
must be a pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not 0, andpProperties
is notNULL
,pProperties
must be a pointer to an array ofpPropertyCount
VkDisplayPropertiesKHR
structures
- Parameters:
physicalDevice
- a physical devicepPropertyCount
- a pointer to an integer related to the number of display devices available or queriedpProperties
- eitherNULL
or a pointer to an array ofVkDisplayPropertiesKHR
structures
-
vkGetPhysicalDeviceDisplayPlanePropertiesKHR
public static int vkGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkDisplayPlanePropertiesKHR.Buffer pProperties)
Queries the plane properties.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.
If
pProperties
isNULL
, then the number of display planes available forphysicalDevice
is returned inpPropertyCount
. Otherwise,pPropertyCount
must point to a variable set by the user to the number of elements in thepProperties
array, and on return the variable is overwritten with the number of structures actually written topProperties
. If the value ofpPropertyCount
is less than the number of display planes forphysicalDevice
, at mostpPropertyCount
structures will be written.Valid Usage
physicalDevice
must be a validVkPhysicalDevice
handlepPropertyCount
must be a pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not 0, andpProperties
is notNULL
,pProperties
must be a pointer to an array ofpPropertyCount
VkDisplayPlanePropertiesKHR
structures
- Parameters:
physicalDevice
- a valid physical devicepPropertyCount
- a pointer to an integer related to the number of display planes available or queriedpProperties
- eitherNULL
or a pointer to an array ofVkDisplayPlanePropertiesKHR
structures
-
vkGetDisplayPlaneSupportedDisplaysKHR
public static int vkGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, int planeIndex, java.nio.IntBuffer pDisplayCount, java.nio.LongBuffer pDisplays)
Determines which displays a plane is usable with.If
pDisplays
isNULL
, then the number of displays usable with the specifiedplaneIndex
forphysicalDevice
is returned inpDisplayCount
. Otherwise,pDisplayCount
must point to a variable set by the user to the number of elements in thepDisplays
array, and on return the variable is overwritten with the number of structures actually written topDisplays
. If the value ofpDisplayCount
is less than the number of display planes forphysicalDevice
, at mostpDisplayCount
structures will be written. IfpDisplayCount
is smaller than the number of displays usable with the specifiedplaneIndex
forphysicalDevice
,INCOMPLETE
will be returned instead ofSUCCESS
to indicate that not all the available values were returned.Valid Usage
physicalDevice
must be a validVkPhysicalDevice
handlepDisplayCount
must be a pointer to auint32_t
value- If the value referenced by
pDisplayCount
is not 0, andpDisplays
is notNULL
,pDisplays
must be a pointer to an array ofpDisplayCount
VkDisplayKHR
handles planeIndex
must be less than the number of display planes supported by the device as determined by callingGetPhysicalDeviceDisplayPlanePropertiesKHR
- Parameters:
physicalDevice
- a physical deviceplaneIndex
- the plane which the application wishes to use, and must be in the range[0, physicaldeviceplanecount − 1]
pDisplayCount
- a pointer to an integer related to the number of display planes available or queriedpDisplays
- eitherNULL
or a pointer to an array ofVkDisplayKHR
structures
-
vkGetDisplayModePropertiesKHR
public static int vkGetDisplayModePropertiesKHR(VkPhysicalDevice physicalDevice, long display, java.nio.IntBuffer pPropertyCount, VkDisplayModePropertiesKHR.Buffer pProperties)
Gets the set of mode properties supported by the display.If
pProperties
isNULL
, then the number of display modes available on the specified display forphysicalDevice
is returned inpPropertyCount
. Otherwise,pPropertyCount
must point to a variable set by the user to the number of elements in thepProperties
array, and on return the variable is overwritten with the number of structures actually written topProperties
. If the value ofpPropertyCount
is less than the number of display modes forphysicalDevice
, at mostpPropertyCount
structures will be written. IfpPropertyCount
is smaller than the number of display modes available on the specifieddisplay
forphysicalDevice
,INCOMPLETE
will be returned instead ofSUCCESS
to indicate that not all the available values were returned.Valid Usage
physicalDevice
must be a validVkPhysicalDevice
handledisplay
must be a validVkDisplayKHR
handlepPropertyCount
must be a pointer to auint32_t
value- If the value referenced by
pPropertyCount
is not 0, andpProperties
is notNULL
,pProperties
must be a pointer to an array ofpPropertyCount
VkDisplayModePropertiesKHR
structures
- Parameters:
physicalDevice
- the physical device associated with the displaydisplay
- a display present on the physical devicepPropertyCount
- the number of entries in the array pointed to bypProperties
pProperties
- a pointer to an array ofpPropertyCount
VkDisplayModePropertiesKHR
structures
-
vkCreateDisplayModeKHR
public static int vkCreateDisplayModeKHR(VkPhysicalDevice physicalDevice, long display, VkDisplayModeCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pMode)
Creates a display mode.Valid Usage
physicalDevice
must be a validVkPhysicalDevice
handledisplay
must be a validVkDisplayKHR
handlepCreateInfo
must be a pointer to a validVkDisplayModeCreateInfoKHR
structure- If
pAllocator
is notNULL
,pAllocator
must be a pointer to a validVkAllocationCallbacks
structure pMode
must be a pointer to aVkDisplayModeKHR
handle
Host Synchronization
- Host access to
display
must be externally synchronized
- Parameters:
physicalDevice
- the physical device associated withdisplay
display
- the display to create an additional modepCreateInfo
- aVkDisplayModeCreateInfoKHR
structure describing the new mode to createpAllocator
- controls host memory allocationpMode
- returns the handle of the mode created
-
vkGetDisplayPlaneCapabilitiesKHR
public static int vkGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, long mode, int planeIndex, VkDisplayPlaneCapabilitiesKHR pCapabilities)
Gets the capabilities of a mode and plane combination.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 this command.
Valid Usage
physicalDevice
must be a validVkPhysicalDevice
handlemode
must be a validVkDisplayModeKHR
handlepCapabilities
must be a pointer to aVkDisplayPlaneCapabilitiesKHR
structure
Host Synchronization
- Host access to
mode
must be externally synchronized
- Parameters:
physicalDevice
- the physical device associated with thedisplay
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 devicepCapabilities
- a pointer to aVkDisplayPlaneCapabilitiesKHR
struct
-
vkCreateDisplayPlaneSurfaceKHR
public static int vkCreateDisplayPlaneSurfaceKHR(VkInstance instance, VkDisplaySurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSurface)
Creates aVkSurfaceKHR
structure representing a display plane and mode.Valid Usage
instance
must be a validVkInstance
handlepCreateInfo
must be a pointer to a validVkDisplaySurfaceCreateInfoKHR
structure- If
pAllocator
is notNULL
,pAllocator
must be a pointer to a validVkAllocationCallbacks
structure pSurface
must be a pointer to aVkSurfaceKHR
handle
- Parameters:
instance
- the instance corresponding to the physical device the targeted display is onpCreateInfo
- a pointer to an instance of theVkDisplaySurfaceCreateInfoKHR
structure containing the parameters affecting the creation of the surface objectpAllocator
- controls host memory allocationpSurface
- points to aVkSurfaceKHR
handle in which the created surface is returned
-
vkGetPhysicalDeviceDisplayPropertiesKHR
public static int vkGetPhysicalDeviceDisplayPropertiesKHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPropertiesKHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayPropertiesKHR
-
vkGetPhysicalDeviceDisplayPlanePropertiesKHR
public static int vkGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkDisplayPlanePropertiesKHR.Buffer pProperties)
Array version of:GetPhysicalDeviceDisplayPlanePropertiesKHR
-
vkGetDisplayPlaneSupportedDisplaysKHR
public static int vkGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, int planeIndex, int[] pDisplayCount, long[] pDisplays)
Array version of:GetDisplayPlaneSupportedDisplaysKHR
-
vkGetDisplayModePropertiesKHR
public static int vkGetDisplayModePropertiesKHR(VkPhysicalDevice physicalDevice, long display, int[] pPropertyCount, VkDisplayModePropertiesKHR.Buffer pProperties)
Array version of:GetDisplayModePropertiesKHR
-
vkCreateDisplayModeKHR
public static int vkCreateDisplayModeKHR(VkPhysicalDevice physicalDevice, long display, VkDisplayModeCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pMode)
Array version of:CreateDisplayModeKHR
-
vkCreateDisplayPlaneSurfaceKHR
public static int vkCreateDisplayPlaneSurfaceKHR(VkInstance instance, VkDisplaySurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)
Array version of:CreateDisplayPlaneSurfaceKHR
-
-