Package org.lwjgl.vulkan

Class EXTDisplayControl

  • public class EXTDisplayControl
extends java.lang.Object
    This extension defines a set of utility functions for use with the VK_KHR_display and VK_KHR_display_swapchain extensions.
    VK_EXT_display_control
    Name String
    VK_EXT_display_control
    Extension Type
    Device extension
    Registered Extension Number
    92
    Revision
    1
    Extension and Version Dependencies
    Contact
    Other Extension Metadata
    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

    • Method Detail

      • nvkDisplayPowerControlEXT

        public static int nvkDisplayPowerControlEXT​(org.lwjgl.vulkan.VkDevice device,
                                            long display,
                                            long pDisplayPowerInfo)
        Unsafe version of: DisplayPowerControlEXT

      • vkDisplayPowerControlEXT

        public static int vkDisplayPowerControlEXT​(org.lwjgl.vulkan.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 valid VkDevice handle
        • display must be a valid VkDisplayKHR handle
        • pDisplayPowerInfo must be a valid pointer to a valid VkDisplayPowerInfoEXT structure
        • Both of device, and display must have been created, allocated, or retrieved from the same VkPhysicalDevice
        Return Codes
        On success, this command returns
        On failure, this command returns
        See Also

        VkDisplayPowerInfoEXT

        Parameters:
        device - a logical device associated with display.
        display - the display whose power state is modified.
        pDisplayPowerInfo - a pointer to a VkDisplayPowerInfoEXT structure specifying the new power state of display.

      • nvkRegisterDeviceEventEXT

        public static int nvkRegisterDeviceEventEXT​(org.lwjgl.vulkan.VkDevice device,
                                            long pDeviceEventInfo,
                                            long pAllocator,
                                            long pFence)
        Unsafe version of: RegisterDeviceEventEXT

      • vkRegisterDeviceEventEXT

        public static int vkRegisterDeviceEventEXT​(org.lwjgl.vulkan.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 valid VkDevice handle
        • pDeviceEventInfo must be a valid pointer to a valid VkDeviceEventInfoEXT structure
        • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
        • pFence must be a valid pointer to a VkFence handle
        Return Codes
        On success, this command returns
        On failure, this command returns
        See Also

        VkAllocationCallbacks, VkDeviceEventInfoEXT

        Parameters:
        device - a logical device on which the event may occur.
        pDeviceEventInfo - a pointer to a VkDeviceEventInfoEXT structure describing the event of interest to the application.
        pAllocator - controls host memory allocation as described in the Memory Allocation chapter.
        pFence - a pointer to a handle in which the resulting fence object is returned.

      • nvkRegisterDisplayEventEXT

        public static int nvkRegisterDisplayEventEXT​(org.lwjgl.vulkan.VkDevice device,
                                             long display,
                                             long pDisplayEventInfo,
                                             long pAllocator,
                                             long pFence)
        Unsafe version of: RegisterDisplayEventEXT

      • vkRegisterDisplayEventEXT

        public static int vkRegisterDisplayEventEXT​(org.lwjgl.vulkan.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 valid VkDevice handle
        • display must be a valid VkDisplayKHR handle
        • pDisplayEventInfo must be a valid pointer to a valid VkDisplayEventInfoEXT structure
        • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
        • pFence must be a valid pointer to a VkFence handle
        • Both of device, and display must have been created, allocated, or retrieved from the same VkPhysicalDevice
        Return Codes
        On success, this command returns
        On failure, this command returns
        See Also

        VkAllocationCallbacks, VkDisplayEventInfoEXT

        Parameters:
        device - a logical device associated with display
        display - the display on which the event may occur.
        pDisplayEventInfo - a pointer to a VkDisplayEventInfoEXT structure describing the event of interest to the application.
        pAllocator - controls host memory allocation as described in the Memory Allocation chapter.
        pFence - a pointer to a handle in which the resulting fence object is returned.

      • nvkGetSwapchainCounterEXT

        public static int nvkGetSwapchainCounterEXT​(org.lwjgl.vulkan.VkDevice device,
                                            long swapchain,
                                            int counter,
                                            long pCounterValue)
        Unsafe version of: GetSwapchainCounterEXT

      • vkGetSwapchainCounterEXT

        public static int vkGetSwapchainCounterEXT​(org.lwjgl.vulkan.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 valid VkDevice handle
        • swapchain must be a valid VkSwapchainKHR handle
        • counter must be a valid VkSurfaceCounterFlagBitsEXT value
        • pCounterValue must be a valid pointer to a uint64_t value
        • Both of device, and swapchain must have been created, allocated, or retrieved from the same VkInstance
        Return Codes
        On success, this command returns
        On failure, this command returns
        Parameters:
        device - the VkDevice associated with swapchain.
        swapchain - the swapchain from which to query the counter value.
        counter - a VkSurfaceCounterFlagBitsEXT value specifying the counter to query.
        pCounterValue - will return the current value of the counter.

      • vkGetSwapchainCounterEXT

        public static int vkGetSwapchainCounterEXT​(org.lwjgl.vulkan.VkDevice device,
                                           long swapchain,
                                           int counter,
                                           long[] pCounterValue)
        Array version of: GetSwapchainCounterEXT