Package org.lwjgl.vulkan

Class VkWriteDescriptorSet

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkWriteDescriptorSet>
org.lwjgl.vulkan.VkWriteDescriptorSet
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkWriteDescriptorSet extends org.lwjgl.system.Struct<VkWriteDescriptorSet> implements org.lwjgl.system.NativeResource
Structure specifying the parameters of a descriptor set write operation.
Description

Only one of pImageInfo, pBufferInfo, or pTexelBufferView members is used according to the descriptor type specified in the descriptorType member of the containing VkWriteDescriptorSet structure, or none of them in case descriptorType is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK, in which case the source data for the descriptor writes is taken from the VkWriteDescriptorSetInlineUniformBlock structure included in the pNext chain of VkWriteDescriptorSet, or if descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, in which case the source data for the descriptor writes is taken from the VkWriteDescriptorSetAccelerationStructureKHR structure in the pNext chain of VkWriteDescriptorSet, or if descriptorType is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, in which case the source data for the descriptor writes is taken from the VkWriteDescriptorSetAccelerationStructureNV structure in the pNext chain of VkWriteDescriptorSet, as specified below.

If the nullDescriptor feature is enabled, the buffer, acceleration structure, imageView, or bufferView can be NULL_HANDLE. Loads from a null descriptor return zero values and stores and atomics to a null descriptor are discarded. A null acceleration structure descriptor results in the miss shader being invoked.

If the destination descriptor is a mutable descriptor, the active descriptor type for the destination descriptor becomes descriptorType.

If the dstBinding has fewer than descriptorCount array elements remaining starting from dstArrayElement, then the remainder will be used to update the subsequent binding - dstBinding+1 starting at array element zero. If a binding has a descriptorCount of zero, it is skipped. This behavior applies recursively, with the update affecting consecutive bindings as needed to update all descriptorCount descriptors. Consecutive bindings must have identical VkDescriptorType, VkShaderStageFlags, VkDescriptorBindingFlagBits, and immutable samplers references. In addition, if the VkDescriptorType is DESCRIPTOR_TYPE_MUTABLE_EXT, the supported descriptor types in VkMutableDescriptorTypeCreateInfoEXT must be equally defined.

Note

The same behavior applies to bindings with a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK where descriptorCount specifies the number of bytes to update while dstArrayElement specifies the starting byte offset, thus in this case if the dstBinding has a smaller byte size than the sum of dstArrayElement and descriptorCount, then the remainder will be used to update the subsequent binding - dstBinding+1 starting at offset zero. This falls out as a special case of the above rule.

Valid Usage
Valid Usage (Implicit)
See Also

VkDescriptorBufferInfo, VkDescriptorImageInfo, VkPushDescriptorSetInfo, CmdPushDescriptorSet, CmdPushDescriptorSetKHR, UpdateDescriptorSets

Layout


 struct VkWriteDescriptorSet {
     VkStructureType sType();
     void const * pNext();
     VkDescriptorSet dstSet();
     uint32_t dstBinding();
     uint32_t dstArrayElement();
     uint32_t descriptorCount();
     VkDescriptorType descriptorType();
     VkDescriptorImageInfo const * pImageInfo();
     VkDescriptorBufferInfo const * pBufferInfo();
     VkBufferView const * pTexelBufferView();
 }