VKGETIMAGESUBRESOURC(3)

NAME
vkGetImageSubresourceLayout - Retrieve information about an image subresource.

C SPECIFICATION

To query the host access layout of an image subresource, for an image created with linear tiling, call:

    void vkGetImageSubresourceLayout(
        VkDevice                                    device,
        VkImage                                     image,
        const VkImageSubresource*                   pSubresource,
        VkSubresourceLayout*                        pLayout);

PARAMETERS

    • device is the logical device that owns the image.

    • image is the image whose layout is being queried.

    • pSubresource is a pointer to a VkImageSubresource structure selecting a specific image for the image subresource.

    • pLayout points to a VkSubresourceLayout structure in which the layout is returned.

DESCRIPTION

vkGetImageSubresourceLayout is invariant for the lifetime of a single image.

VALID USAGE

    • device must be a valid VkDevice handle

    • image must be a valid VkImage handle

    • pSubresource must be a pointer to a valid VkImageSubresource structure

    • pLayout must be a pointer to a VkSubresourceLayout structure

    • image must have been created, allocated or retrieved from device

    • Each of device and image must have been created, allocated or retrieved from the same VkPhysicalDevice

    • image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR

    • The aspectMask member of pSubresource must only have a single bit set

SEE ALSO

VkDevice, VkImage, VkImageSubresource, VkSubresourceLayout

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.