Package org.lwjgl.vulkan
Class EXTDisplayControl
- java.lang.Object
-
- org.lwjgl.vulkan.EXTDisplayControl
-
public class EXTDisplayControl extends java.lang.Object
This extension defines a set of utility functions for use with theVK_KHR_display
andVK_KHR_display_swapchain
extensions.- Name String
VK_EXT_display_control
- Extension Type
- Device extension
- Registered Extension Number
- 92
- Revision
- 1
- Extension and Version Dependencies
- Requires Vulkan 1.0
- Requires
VK_EXT_display_surface_counter
- Requires
VK_KHR_swapchain
- Contact
- James Jones cubanismo
- Last Modified Date
- 2016-12-13
- IP Status
- No known IP claims.
- Contributors
- Pierre Boudier, NVIDIA
- James Jones, NVIDIA
- Damien Leone, NVIDIA
- Pierre-Loup Griffais, Valve
- Daniel Vetter, Intel
-
-
Field Summary
Fields Modifier and Type Field Description static int
VK_DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT
VkDeviceEventTypeEXT - Events that can occur on a device objectstatic int
VK_DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT
VkDisplayEventTypeEXT - Events that can occur on a display objectstatic int
VK_DISPLAY_POWER_STATE_OFF_EXT
VK_DISPLAY_POWER_STATE_ON_EXT
VK_DISPLAY_POWER_STATE_SUSPEND_EXTVkDisplayPowerStateEXT - Possible power states for a displaystatic java.lang.String
VK_EXT_DISPLAY_CONTROL_EXTENSION_NAME
The extension name.static int
VK_EXT_DISPLAY_CONTROL_SPEC_VERSION
The extension specification version.static int
VK_STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT
VK_STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT
VK_STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT
VK_STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXTExtendsVkStructureType
.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static int
nvkDisplayPowerControlEXT(VkDevice device, long display, long pDisplayPowerInfo)
Unsafe version of:DisplayPowerControlEXT
static int
nvkGetSwapchainCounterEXT(VkDevice device, long swapchain, int counter, long pCounterValue)
Unsafe version of:GetSwapchainCounterEXT
static int
nvkRegisterDeviceEventEXT(VkDevice device, long pDeviceEventInfo, long pAllocator, long pFence)
Unsafe version of:RegisterDeviceEventEXT
static int
nvkRegisterDisplayEventEXT(VkDevice device, long display, long pDisplayEventInfo, long pAllocator, long pFence)
Unsafe version of:RegisterDisplayEventEXT
static int
vkDisplayPowerControlEXT(VkDevice device, long display, VkDisplayPowerInfoEXT pDisplayPowerInfo)
Set the power state of a display.static int
vkGetSwapchainCounterEXT(VkDevice device, long swapchain, int counter, long[] pCounterValue)
Array version of:GetSwapchainCounterEXT
static int
vkGetSwapchainCounterEXT(VkDevice device, long swapchain, int counter, java.nio.LongBuffer pCounterValue)
Query the current value of a surface counter.static int
vkRegisterDeviceEventEXT(VkDevice device, VkDeviceEventInfoEXT pDeviceEventInfo, VkAllocationCallbacks pAllocator, long[] pFence)
Array version of:RegisterDeviceEventEXT
static int
vkRegisterDeviceEventEXT(VkDevice device, VkDeviceEventInfoEXT pDeviceEventInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pFence)
Signal a fence when a device event occurs.static int
vkRegisterDisplayEventEXT(VkDevice device, long display, VkDisplayEventInfoEXT pDisplayEventInfo, VkAllocationCallbacks pAllocator, long[] pFence)
Array version of:RegisterDisplayEventEXT
static int
vkRegisterDisplayEventEXT(VkDevice device, long display, VkDisplayEventInfoEXT pDisplayEventInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pFence)
Signal a fence when a display event occurs.
-
-
-
Field Detail
-
VK_EXT_DISPLAY_CONTROL_SPEC_VERSION
The extension specification version.
-
VK_EXT_DISPLAY_CONTROL_EXTENSION_NAME
The extension name.
-
VK_STRUCTURE_TYPE_DISPLAY_POWER_INFO_EXT, VK_STRUCTURE_TYPE_DEVICE_EVENT_INFO_EXT, VK_STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT, VK_STRUCTURE_TYPE_SWAPCHAIN_COUNTER_CREATE_INFO_EXT
ExtendsVkStructureType
.Enum values:
-
VK_DISPLAY_POWER_STATE_OFF_EXT, VK_DISPLAY_POWER_STATE_SUSPEND_EXT, VK_DISPLAY_POWER_STATE_ON_EXT
VkDisplayPowerStateEXT - Possible power states for a displayDescription
DISPLAY_POWER_STATE_OFF_EXT
specifies that the display is powered down.DISPLAY_POWER_STATE_SUSPEND_EXT
specifies that the display is put into a low power mode, from which it may be able to transition back toDISPLAY_POWER_STATE_ON_EXT
more quickly than if it were inDISPLAY_POWER_STATE_OFF_EXT
. This state may be the same asDISPLAY_POWER_STATE_OFF_EXT
.DISPLAY_POWER_STATE_ON_EXT
specifies that the display is powered on.
See Also
-
VK_DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT
VkDeviceEventTypeEXT - Events that can occur on a device objectDescription
DEVICE_EVENT_TYPE_DISPLAY_HOTPLUG_EXT
specifies that the fence is signaled when a display is plugged into or unplugged from the specified device. Applications can use this notification to determine when they need to re-enumerate the available displays on a device.
See Also
-
VK_DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT
VkDisplayEventTypeEXT - Events that can occur on a display objectDescription
DISPLAY_EVENT_TYPE_FIRST_PIXEL_OUT_EXT
specifies that the fence is signaled when the first pixel of the next display refresh cycle leaves the display engine for the display.
See Also
-
-
Method Detail
-
nvkDisplayPowerControlEXT
public static int nvkDisplayPowerControlEXT(VkDevice device, long display, long pDisplayPowerInfo)
Unsafe version of:DisplayPowerControlEXT
-
vkDisplayPowerControlEXT
public static int vkDisplayPowerControlEXT(VkDevice device, long display, VkDisplayPowerInfoEXT pDisplayPowerInfo)
Set the power state of a display.C Specification
To set the power state of a display, call:
VkResult vkDisplayPowerControlEXT( VkDevice device, VkDisplayKHR display, const VkDisplayPowerInfoEXT* pDisplayPowerInfo);
Valid Usage (Implicit)
device
must be a validVkDevice
handledisplay
must be a validVkDisplayKHR
handlepDisplayPowerInfo
must be a valid pointer to a validVkDisplayPowerInfoEXT
structure
Return Codes
- On success, this command returns
See Also
- Parameters:
device
- a logical device associated withdisplay
.display
- the display whose power state is modified.pDisplayPowerInfo
- an instance ofVkDisplayPowerInfoEXT
specifying the new power state ofdisplay
.
-
nvkRegisterDeviceEventEXT
public static int nvkRegisterDeviceEventEXT(VkDevice device, long pDeviceEventInfo, long pAllocator, long pFence)
Unsafe version of:RegisterDeviceEventEXT
-
vkRegisterDeviceEventEXT
public static int vkRegisterDeviceEventEXT(VkDevice device, VkDeviceEventInfoEXT pDeviceEventInfo, @Nullable VkAllocationCallbacks pAllocator, java.nio.LongBuffer pFence)
Signal a fence when a device event occurs.C Specification
To create a fence that will be signaled when an event occurs on a device, call:
VkResult vkRegisterDeviceEventEXT( VkDevice device, const VkDeviceEventInfoEXT* pDeviceEventInfo, const VkAllocationCallbacks* pAllocator, VkFence* pFence);
Valid Usage (Implicit)
device
must be a validVkDevice
handlepDeviceEventInfo
must be a valid pointer to a validVkDeviceEventInfoEXT
structure- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validVkAllocationCallbacks
structure pFence
must be a valid pointer to aVkFence
handle
Return Codes
- On success, this command returns
See Also
- Parameters:
device
- a logical device on which the event may occur.pDeviceEventInfo
- a pointer to an instance of theVkDeviceEventInfoEXT
structure describing the event of interest to the application.pAllocator
- controls host memory allocation as described in the Memory Allocation chapter.pFence
- points to a handle in which the resulting fence object is returned.
-
nvkRegisterDisplayEventEXT
public static int nvkRegisterDisplayEventEXT(VkDevice device, long display, long pDisplayEventInfo, long pAllocator, long pFence)
Unsafe version of:RegisterDisplayEventEXT
-
vkRegisterDisplayEventEXT
public static int vkRegisterDisplayEventEXT(VkDevice device, long display, VkDisplayEventInfoEXT pDisplayEventInfo, @Nullable VkAllocationCallbacks pAllocator, java.nio.LongBuffer pFence)
Signal a fence when a display event occurs.C Specification
To create a fence that will be signaled when an event occurs on a
VkDisplayKHR
object, call:VkResult vkRegisterDisplayEventEXT( VkDevice device, VkDisplayKHR display, const VkDisplayEventInfoEXT* pDisplayEventInfo, const VkAllocationCallbacks* pAllocator, VkFence* pFence);
Valid Usage (Implicit)
device
must be a validVkDevice
handledisplay
must be a validVkDisplayKHR
handlepDisplayEventInfo
must be a valid pointer to a validVkDisplayEventInfoEXT
structure- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validVkAllocationCallbacks
structure pFence
must be a valid pointer to aVkFence
handle
Return Codes
- On success, this command returns
See Also
- Parameters:
device
- a logical device associated withdisplay
display
- the display on which the event may occur.pDisplayEventInfo
- a pointer to an instance of theVkDisplayEventInfoEXT
structure describing the event of interest to the application.pAllocator
- controls host memory allocation as described in the Memory Allocation chapter.pFence
- points to a handle in which the resulting fence object is returned.
-
nvkGetSwapchainCounterEXT
public static int nvkGetSwapchainCounterEXT(VkDevice device, long swapchain, int counter, long pCounterValue)
Unsafe version of:GetSwapchainCounterEXT
-
vkGetSwapchainCounterEXT
public static int vkGetSwapchainCounterEXT(VkDevice device, long swapchain, int counter, java.nio.LongBuffer pCounterValue)
Query the current value of a surface counter.C Specification
The requested counters become active when the first presentation command for the associated swapchain is processed by the presentation engine. To query the value of an active counter, use:
VkResult vkGetSwapchainCounterEXT( VkDevice device, VkSwapchainKHR swapchain, VkSurfaceCounterFlagBitsEXT counter, uint64_t* pCounterValue);
Description
If a counter is not available because the swapchain is out of date, the implementation may return
ERROR_OUT_OF_DATE_KHR
.Valid Usage
- One or more present commands on
swapchain
must have been processed by the presentation engine.
Valid Usage (Implicit)
device
must be a validVkDevice
handleswapchain
must be a validVkSwapchainKHR
handlecounter
must be a validVkSurfaceCounterFlagBitsEXT
valuepCounterValue
must be a valid pointer to auint64_t
value- Both of
device
, andswapchain
must have been created, allocated, or retrieved from the sameVkInstance
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
device
- theVkDevice
associated withswapchain
.swapchain
- the swapchain from which to query the counter value.counter
- the counter to query.pCounterValue
- will return the current value of the counter.
- One or more present commands on
-
vkRegisterDeviceEventEXT
public static int vkRegisterDeviceEventEXT(VkDevice device, VkDeviceEventInfoEXT pDeviceEventInfo, @Nullable VkAllocationCallbacks pAllocator, long[] pFence)
Array version of:RegisterDeviceEventEXT
-
vkRegisterDisplayEventEXT
public static int vkRegisterDisplayEventEXT(VkDevice device, long display, VkDisplayEventInfoEXT pDisplayEventInfo, @Nullable VkAllocationCallbacks pAllocator, long[] pFence)
Array version of:RegisterDisplayEventEXT
-
vkGetSwapchainCounterEXT
public static int vkGetSwapchainCounterEXT(VkDevice device, long swapchain, int counter, long[] pCounterValue)
Array version of:GetSwapchainCounterEXT
-
-