mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-18 09:16:51 +00:00
e2d981c029
* Bump API patch number and header version number to 20 for this
update.
Github Issues:
* Replaced existing reference pages by text automatically extracted
from the specification source, or generated from vk.xml in some
cases. This isn't a complete solution for the reference pages, but
puts them in a much better state. The ref pages (only) are now
placed under a CC BY open source license, which is more current than
the obsolete license previously used.
Further improvements to the pages should not edit them directly, but
instead concentrate on the specification source from which the ref
pages are being extracted (public issues 44, 55, 160; internal issue
389).
73 lines
2.3 KiB
Plaintext
73 lines
2.3 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/
|
|
|
|
vkAllocateDescriptorSets(3)
|
|
===========================
|
|
|
|
Name
|
|
----
|
|
vkAllocateDescriptorSets - Allocate one or more descriptor sets.
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
// refBegin vkAllocateDescriptorSets Allocate one or more descriptor sets.
|
|
|
|
To allocate descriptor sets from a descriptor pool, call:
|
|
|
|
include::../protos/vkAllocateDescriptorSets.txt[]
|
|
|
|
|
|
Parameters
|
|
----------
|
|
|
|
* pname:device is the logical device that owns the descriptor pool.
|
|
* pname:pAllocateInfo is a pointer to an instance of the
|
|
slink:VkDescriptorSetAllocateInfo structure describing parameters of the
|
|
allocation.
|
|
* pname:pDescriptorSets is a pointer to an array of sname:VkDescriptorSet
|
|
handles in which the resulting descriptor set objects are returned. The
|
|
array must: be at least the length specified by the
|
|
pname:descriptorSetCount member of pname:pAllocateInfo.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
The allocated descriptor sets are returned in pname:pDescriptorSets.
|
|
|
|
When a descriptor set is allocated, the initial state is largely
|
|
uninitialized and all descriptors are undefined. However,
|
|
the descriptor set can: be bound
|
|
in a command buffer without causing errors or exceptions. All entries that
|
|
are statically used by a pipeline in a drawing or dispatching command must:
|
|
have been populated before the descriptor set is bound for use by that command.
|
|
Entries that are not statically used by a pipeline can: have uninitialized
|
|
descriptors or descriptors of resources that have been destroyed, and executing
|
|
a draw or dispatch with such a descriptor set bound does not cause undefined
|
|
behavior. This means applications need not populate unused entries with dummy
|
|
descriptors.
|
|
|
|
include::../validity/protos/vkAllocateDescriptorSets.txt[]
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
slink:VkDescriptorSet, slink:VkDescriptorSetAllocateInfo, slink:VkDevice
|
|
|
|
|
|
Document Notes
|
|
--------------
|
|
|
|
For more information, see the Vulkan Specification at URL
|
|
|
|
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkAllocateDescriptorSets
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
Fixes and changes should be made to the Specification,not directly.
|
|
|
|
include::footer.txt[]
|
|
|