86 lines
2.9 KiB
Plaintext
86 lines
2.9 KiB
Plaintext
|
VkWriteDescriptorSet(3)
|
||
|
|
=======================
|
||
|
|
|
||
|
|
Name
|
||
|
|
----
|
||
|
|
VkWriteDescriptorSet - Structure specifying the parameters of a descriptor set write operation.
|
||
|
|
|
||
|
|
C Specification
|
||
|
|
---------------
|
||
|
|
|
||
|
|
include::../structs/VkWriteDescriptorSet.txt[]
|
||
|
|
|
||
|
|
Fields
|
||
|
|
------
|
||
|
|
|
||
|
|
pname:sType::
|
||
|
|
Structure type. Must be ename:VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET.
|
||
|
|
|
||
|
|
pname:pNext::
|
||
|
|
Pointer to next structure in the structure chain when applicable.
|
||
|
|
|
||
|
|
pname:dstSet::
|
||
|
|
Destination descriptor set to write the descriptor data to.
|
||
|
|
|
||
|
|
pname:dstBinding::
|
||
|
|
Binding within the descriptor set to start the update from.
|
||
|
|
|
||
|
|
pname:dstArrayElement::
|
||
|
|
Array element of the binding to start the update from.
|
||
|
|
|
||
|
|
pname:descriptorCount::
|
||
|
|
Number of descriptors to write to the descriptor set.
|
||
|
|
|
||
|
|
pname:descriptorType::
|
||
|
|
Type of descriptors to write to the descriptor set.
|
||
|
|
|
||
|
|
pname:pImageInfo::
|
||
|
|
A pointer to an array of pname:descriptorCount slink:VkDescriptorImageInfo
|
||
|
|
structures specifying the source of the descriptor data to write to the
|
||
|
|
descriptor set for images.
|
||
|
|
|
||
|
|
pname:pBufferInfo::
|
||
|
|
A pointer to an array of pname:descriptorCount slink:VkDescriptorBufferInfo
|
||
|
|
structures specifying the source of the descriptor data to write to the
|
||
|
|
descriptor set for buffers.
|
||
|
|
|
||
|
|
pname:pTexelBufferView::
|
||
|
|
A pointer to an array of basetype:VkBufferView handles used when binding
|
||
|
|
texel buffers into a the descriptor set.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
This structure specifies information about the descriptors to be written to
|
||
|
|
a descriptor set using the fname:vkUpdateDescriptorSets command.
|
||
|
|
|
||
|
|
When writing data to descriptor sets, the pname:pImageInfo, pname:pBufferInfo
|
||
|
|
or pname:pTexelBufferView parameters of fname:vkUpdateDescriptorSets point
|
||
|
|
to pname:descriptorCount instances of data structures, each instance
|
||
|
|
specifying the source of the descriptor data to be written. Which of these
|
||
|
|
parameters is used depends on the value of pname:descriptorType.
|
||
|
|
|
||
|
|
Each instance of the selected array allows writing pname:descriptorCount
|
||
|
|
descriptors of type pname:descriptorType to the destination descriptor
|
||
|
|
set specified by pname:dstSet starting from the array element index
|
||
|
|
pname:dstArrayElement of the pname:dstBinding binding.
|
||
|
|
|
||
|
|
If pname:descriptorCount is greater than the number of descriptors in the
|
||
|
|
specified binding starting from the specified array element index then
|
||
|
|
subsequent descriptors are written to the next binding starting from its
|
||
|
|
first array element. This allows updating multiple subsequent bindings with
|
||
|
|
a single instance of this structure as long as the descriptor type of those
|
||
|
|
bindings match.
|
||
|
|
|
||
|
|
Attempting to write descriptors of incompatible type to any binding of a
|
||
|
|
descriptor set may result in undefined behavior.
|
||
|
|
|
||
|
|
include::../validity/structs/VkWriteDescriptorSet.txt[]
|
||
|
|
|
||
|
|
See Also
|
||
|
|
--------
|
||
|
|
|
||
|
|
flink:vkUpdateDescriptorSets, slink:VkDescriptorImageInfo, slink:VkDescriptorBufferInfo, elink:VkDescriptorType
|
||
|
|
|
||
|
|
include::footer.txt[]
|