Vulkan-Docs/doc/specs/vulkan/man/vkGetImageSubresourceLayout...

61 lines
1.6 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkGetImageSubresourceLayout(3)
==============================
Name
----
vkGetImageSubresourceLayout - Retrieve information about an image subresource.
C Specification
---------------
// refBegin vkGetImageSubresourceLayout Retrieve information about an image subresource.
To query the host access layout of an image subresource, for an image
created with linear tiling, call:
include::../api/protos/vkGetImageSubresourceLayout.txt[]
Parameters
----------
* pname:device is the logical device that owns the image.
* pname:image is the image whose layout is being queried.
* pname:pSubresource is a pointer to a slink:VkImageSubresource structure
selecting a specific image for the image subresource.
* pname:pLayout points to a slink:VkSubresourceLayout structure in which
the layout is returned.
Description
-----------
flink:vkGetImageSubresourceLayout is invariant for the lifetime of a single
image.
include::../validity/protos/vkGetImageSubresourceLayout.txt[]
See Also
--------
slink:VkDevice, slink:VkImage, slink:VkImageSubresource, slink: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.
include::footer.txt[]