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

65 lines
2.0 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/
VkBufferViewCreateInfo(3)
=========================
Name
----
VkBufferViewCreateInfo - Structure specifying parameters of a newly created buffer view
C Specification
---------------
// refBegin VkBufferViewCreateInfo - Structure specifying parameters of a newly created buffer view
The sname:VkBufferViewCreateInfo structure is defined as:
include::../api/structs/VkBufferViewCreateInfo.txt[]
Members
-------
* pname:sType is the type of this structure.
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
* pname:flags is reserved for future use.
* pname:buffer is a sname:VkBuffer on which the view will be created.
* pname:format is a elink:VkFormat describing the format of the data
elements in the buffer.
* pname:offset is an offset in bytes from the base address of the buffer.
Accesses to the buffer view from shaders use addressing that is relative
to this starting offset.
* pname:range is a size in bytes of the buffer view. If pname:range is
equal to ename:VK_WHOLE_SIZE, the range from pname:offset to the end of
the buffer is used. If ename:VK_WHOLE_SIZE is used and the remaining
size of the buffer is not a multiple of the element size of
pname:format, then the nearest smaller multiple is used.
Description
-----------
include::../validity/structs/VkBufferViewCreateInfo.txt[]
See Also
--------
slink:VkBuffer, elink:VkBufferViewCreateFlags, basetype:VkDeviceSize, elink:VkFormat, elink:VkStructureType, flink:vkCreateBufferView
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkBufferViewCreateInfo
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]