Class VkDisplayPresentInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer


    public class VkDisplayPresentInfoKHR
    extends Struct
    Khronos Reference Page
    Vulkan Specification

    When the VK_KHR_display_swapchain extension is enabled additional fields can be specified when presenting an image to a swapchain by setting VkPresentInfoKHR::pNext to point to a VkDisplayPresentInfoKHR structure.

    Valid Usage

    Member documentation

    • sType – the type of this structure. Must be: STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR
    • pNext – reserved for use by extensions
    • srcRect – a rectangular region of pixels to present. It must be a subset of the image being presented. If VkDisplayPresentInfoKHR is not specified, this region will be assumed to be the entire presentable image.
    • dstRect – a rectangular region within the visible region of the swapchain’s display mode. If VkDisplayPresentInfoKHR is not specified, this region will be assumed to be the entire visible region of the visible region of the swapchain’s mode. If the specified rectangle is a subset of the display mode’s visible region, content from display planes below the swapchain’s plane will be visible outside the rectangle. If there are no planes below the swapchain’s, the area outside the specified rectangle will be black. If portions of the specified rectangle are outside of the display’s visible region, pixels mapping only to those portions of the rectangle will be discarded.
    • persistent – if TRUE, the display engine will enable buffered mode on displays that support it. This allows the display engine to stop sending content to the display until a new image is presented. The display will instead maintain a copy of the last presented image. This allows less power to be used, but may increase presentation latency. If VkDisplayPresentInfoKHR is not specified, persistent mode will not be used.

    Layout

    struct VkDisplayPresentInfoKHR {
        VkStructureType sType;
        const void * pNext;
        VkRect2D srcRect;
        VkRect2D dstRect;
        VkBool32 persistent;
    }