the application may need to know which regions of the surface are used when
presenting locally on each physical device.
Presentation of swapchain images to this surface need only have valid
contents in the regions returned by this command.
To query a set of rectangles used in presentation on the physical device, call:
// Provided by VK_KHR_swapchain with VK_VERSION_1_1, VK_KHR_device_group with VK_KHR_surface VkResult vkGetPhysicalDevicePresentRectanglesKHR( VkPhysicalDevice physicalDevice, VkSurfaceKHR surface, uint32_t* pRectCount, VkRect2D* pRects);
physicalDeviceis the physical device.
surfaceis the surface.
pRectCountis a pointer to an integer related to the number of rectangles available or queried, as described below.
NULLor a pointer to an array of VkRect2D structures.
NULL, then the number of rectangles used when
presenting the given
surface is returned in
pRectCount must point to a variable set by the user to the
number of elements in the
pRects array, and on return the variable is
overwritten with the number of structures actually written to
If the value of
pRectCount is less than the number of rectangles, at
pRectCount structures will be written.
pRectCount is smaller than the number of rectangles used for the
VK_INCOMPLETE will be returned instead of
VK_SUCCESS to indicate that not all the available values were
The values returned by this command are not invariant, and may change in response to the surface being moved, resized, or occluded.
The rectangles returned by this command must not overlap.
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.