VkRectLayerKHR(3)

# VkRectLayerKHR(3) Manual Page

## Name

VkRectLayerKHR - Structure containing a rectangle, including layer, changed by vkQueuePresentKHR for a given VkImage

## C Specification

The `VkRectLayerKHR` structure is defined as:

    typedef struct VkRectLayerKHR {
        VkOffset2D    offset;
        VkExtent2D    extent;
        uint32_t      layer;
    } VkRectLayerKHR;

## Members

- `offset` is the origin of the rectangle, in pixels.

- `extent` is the size of the rectangle, in pixels.

- `layer` is the layer of the image. For images with only one layer, the value of `layer` must be 0.

## Description

Valid Usage

- The sum of `offset` and `extent` must be no greater than the `imageExtent` member of the `VkSwapchainCreateInfoKHR` structure given to vkCreateSwapchainKHR.

- `layer` must be less than `imageArrayLayers` member of the `VkSwapchainCreateInfoKHR` structure given to vkCreateSwapchainKHR.

Some platforms allow the size of a surface to change, and then scale the pixels of the image to fit the surface. `VkRectLayerKHR` specifies pixels of the swapchain’s image(s), which will be constant for the life of the swapchain.

## See Also

VkExtent2D, VkOffset2D, VkPresentRegionKHR

## Document Notes

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.

## Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.