VKIMAGESUBRESOURCE(3)

NAME
VkImageSubresource - Structure specifying a image subresource

C SPECIFICATION

The VkImageSubresource structure is defined as:

    typedef struct VkImageSubresource {
        VkImageAspectFlags    aspectMask;
        uint32_t              mipLevel;
        uint32_t              arrayLayer;
    } VkImageSubresource;

MEMBERS

    • aspectMask is a VkImageAspectFlags selecting the image aspect.

    • mipLevel selects the mipmap level.

    • arrayLayer selects the array layer.

DESCRIPTION

VALID USAGE

    • aspectMask must be a valid combination of VkImageAspectFlagBits values

    • aspectMask must not be 0

    • mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created

    • arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created

SEE ALSO

VkImageAspectFlags, VkSparseImageMemoryBind, vkGetImageSubresourceLayout

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkImageSubresource

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

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

AUTHOR

Khronos Group
    Author.