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

56 lines
1.8 KiB
Plaintext

vkAllocateDescriptorSets(3)
===========================
Name
----
vkAllocateDescriptorSets - Allocate one or more descriptor sets.
C Specification
---------------
include::../protos/vkAllocateDescriptorSets.txt[]
Parameters
----------
pname:device::
The device that will create the descriptor sets.
pname:pAllocateInfo::
A pointer to a structure containing information about the sets to allocate.
pname:pDescriptorSets::
An array of variables that will receive the handles to the newly created descriptor sets.
Description
-----------
fname:vkAllocateDescriptorSets allocates one or more descriptor sets using
information contained in the structure pointed to by pname:pAllocateInfo.
pname:pAllocateInfo is an instance of the slink:VkDescriptorSetAllocateInfo
structure, the definition of which is:
include::../structs/VkDescriptorSetAllocateInfo.txt[]
The pname:sType member of slink:VkDescriptorSetAllocateInfo must be set to
ename:VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO. The pname:pNext member
is reserved for use by extensions and should be set to code:NULL.
The requested sets are allocated from the descriptor pool specified by
pname:descriptorPool. pname:descriptorPool and the resulting descriptor sets
must be owned by the device specified in pname:device.
pname:setLayoutCount specifies the number of sets to allocate. pname:pSetLayouts is
an array of pname:setLayoutCount sname:VkDescriptorSetLayout object handles which
describe the layouts of each of the sets. On success, pname:setLayoutCount descriptor
set handles will be allocated and placed in the pname:pDescriptorSets array.
include::../validity/protos/vkAllocateDescriptorSets.txt[]
See Also
--------
flink:vkFreeDescriptorSets, flink:vkUpdateDescriptorSets, flink:vkCreateDescriptorPool, flink:vkCreateDescriptorSetLayout
include::footer.txt[]