Vulkan-Docs/doc/specs/vulkan/man/VkSparseImageMemoryBind.txt

66 lines
2.1 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/
VkSparseImageMemoryBind(3)
==========================
Name
----
VkSparseImageMemoryBind - Structure specifying sparse image memory bind
C Specification
---------------
// refBegin VkSparseImageMemoryBind - Structure specifying sparse image memory bind
The sname:VkSparseImageMemoryBind structure is defined as:
include::../api/structs/VkSparseImageMemoryBind.txt[]
Members
-------
* pname:subresource is the aspectMask and region of interest in the image.
* pname:offset are the coordinates of the first texel within the image
subresource to bind.
* pname:extent is the size in texels of the region within the image
subresource to bind. The extent must: be a multiple of the sparse image
block dimensions, except when binding sparse image blocks along the edge
of an image subresource it can: instead be such that any coordinate of
latexmath:[$\mathit{offset} + \mathit{extent}$] equals the corresponding
dimensions of the image subresource.
* pname:memory is the sname:VkDeviceMemory object that the sparse image
blocks of the image are bound to. If pname:memory is dlink:VK_NULL_HANDLE,
the sparse image blocks are unbound.
* pname:memoryOffset is an offset into sname:VkDeviceMemory object. If
pname:memory is dlink:VK_NULL_HANDLE, this value is ignored.
* pname:flags are sparse memory binding flags.
Description
-----------
include::../validity/structs/VkSparseImageMemoryBind.txt[]
See Also
--------
slink:VkDeviceMemory, basetype:VkDeviceSize, slink:VkExtent3D, slink:VkImageSubresource, slink:VkOffset3D, slink:VkSparseImageMemoryBindInfo, elink:VkSparseMemoryBindFlags
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkSparseImageMemoryBind
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]