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

43 lines
1018 B
Plaintext
Raw Normal View History

2016-02-16 01:53:44 -08:00
vkCreateBuffer(3)
==================
Name
----
vkCreateBuffer - Create a new buffer object.
C Specification
---------------
include::../protos/vkCreateBuffer.txt[]
Parameters
----------
pname:device::
The device with which to create the new buffer object.
pname:pCreateInfo::
Pointer to data structure containing information about the object to be created.
pname:pBuffer::
Change log for April 29, 2016 Vulkan 1.0.12 spec update: * Bump API patch number and header version number to 12 for this update. Github Issues: * Change valid usage statements intended to be "sub-points" to be actual sub-points (public issue 66). * Replace double negation in description of slink:VkRenderPassBeginInfo::pname:pClearValues (based on public merge 142). * Cleanup minor typos in spec, ref pages and XML, including those proposed in public pull requests 144, 150, 151, 167, 168, 181, and 186. * Use *strict subset* in describing the partial order of memory property types for slink:VkMemoryType, and update the style guide accordingly (public issue 190). * Fix various "a image" -> "an image" typos (public issue 191). * Note in the <<fundamentals-validusage,Valid Usage>> and <<extensions-interactions,Extension Interactions>> sections that structures defined by extensions which may be passed in structure chains using the ptext:pNext member must: include initial ptext:sType and ptext:pNext members (public issue 192). Internal Issues: * Remove duplicate language from the description of the pname:fence parameter to flink:vkQueueSubmit and improve validity language (internal issue 91). * Added documentation for "optional" attribute to XML readme.tex/pdf (internal issue 149). * Clarify the host-side data validity rules and behavior of flink:vkFlushMappedMemoryRanges and flink:vkInvalidateMappedMemoryRanges (internal issue 266). Other Commits: * Added clarification to flink:vkCmdFillBuffer regarding the use of ename:VK_WHOLE_SIZE. * Fixed and documented implementation of "validextensionstructs" attribute. in XML processing scripts and readme.tex/pdf. * Add missing validity statements to flink:vkResetEvent and flink:vkCmdResetEvent. * Fix validity for the ename:VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT flag. Correct all the draw/dispatch commands to mention optimally tiled images as well as linear tiled images, and say image VIEWS instead of images. Add validity statement to flink:vkCmdBlitImage * Replace the {apiname} macro with hardcoded "Vulkan", now that we've committed to that name. * Add the VK_AMD_rasterization_order extension to vk.xml.
2016-04-29 14:53:46 +02:00
Pointer to a variable to receive a handle to the new buffer object.
2016-02-16 01:53:44 -08:00
Description
-----------
fname:vkCreateBuffer creates a new buffer object using the device specified in pname:device. The
resulting buffer object handle is written into the variable whose address is given in
pname:pBuffer. pname:pCreateInfo is a pointer to a data structure describing the buffer to be
created and is of type slink:VkBufferCreateInfo, whose definition is:
include::../structs/VkBufferCreateInfo.txt[]
include::../validity/protos/vkCreateBuffer.txt[]
See Also
--------
flink:vkCreateImage, flink:vkCreateBufferView
include::footer.txt[]