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

63 lines
1.7 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/
VkDescriptorBufferInfo(3)
=========================
Name
----
VkDescriptorBufferInfo - Structure specifying descriptor buffer info
C Specification
---------------
// refBegin VkDescriptorBufferInfo - Structure specifying descriptor buffer info
The sname:VkDescriptorBufferInfo structure is defined as:
include::../structs/VkDescriptorBufferInfo.txt[]
Members
-------
* pname:buffer is the buffer resource.
* pname:offset is the offset in bytes from the start of pname:buffer.
Access to buffer memory via this descriptor uses addressing that is
relative to this starting offset.
* pname:range is the size in bytes that is used for this descriptor
update, or ename:VK_WHOLE_SIZE to use the range from pname:offset to the
end of the buffer.
Description
-----------
For ename:VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC and
ename:VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC descriptor types,
pname:offset is the base offset from which the dynamic offset is applied and
pname:range is the static size used for all dynamic offsets.
include::../validity/structs/VkDescriptorBufferInfo.txt[]
See Also
--------
slink:VkBuffer, basetype:VkDeviceSize, slink:VkWriteDescriptorSet
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkDescriptorBufferInfo
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]