Class VkDescriptorUpdateTemplateCreateInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    Direct Known Subclasses:
    VkDescriptorUpdateTemplateCreateInfoKHR

    public class VkDescriptorUpdateTemplateCreateInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying parameters of a newly created descriptor update template.
    Valid Usage
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_DESCRIPTOR_UPDATE_TEMPLATE_CREATE_INFO
    • pNext must be NULL
    • flags must be 0
    • pDescriptorUpdateEntries must be a valid pointer to an array of descriptorUpdateEntryCount valid VkDescriptorUpdateTemplateEntry structures
    • templateType must be a valid VkDescriptorUpdateTemplateType value
    • If descriptorSetLayout is not NULL_HANDLE, descriptorSetLayout must be a valid VkDescriptorSetLayout handle
    • descriptorUpdateEntryCount must be greater than 0
    • Both of descriptorSetLayout, and pipelineLayout that are valid handles must have been created, allocated, or retrieved from the same VkDevice
    See Also

    VkDescriptorUpdateTemplateEntry, CreateDescriptorUpdateTemplate, CreateDescriptorUpdateTemplateKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – reserved for future use.
    • descriptorUpdateEntryCount – the number of elements in the pDescriptorUpdateEntries array.
    • pDescriptorUpdateEntries – a pointer to an array of VkDescriptorUpdateTemplateEntry structures describing the descriptors to be updated by the descriptor update template.
    • templateType – Specifies the type of the descriptor update template. If set to DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET it can only be used to update descriptor sets with a fixed descriptorSetLayout. If set to DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR it can only be used to push descriptor sets using the provided pipelineBindPoint, pipelineLayout, and set number.
    • descriptorSetLayout – the descriptor set layout the parameter update template will be used with. All descriptor sets which are going to be updated through the newly created descriptor update template must be created with this layout. descriptorSetLayout is the descriptor set layout used to build the descriptor update template. All descriptor sets which are going to be updated through the newly created descriptor update template must be created with a layout that matches (is the same as, or defined identically to) this layout. This parameter is ignored if templateType is not DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET.
    • pipelineBindPoint – a VkPipelineBindPoint indicating whether the descriptors will be used by graphics pipelines or compute pipelines. This parameter is ignored if templateType is not DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR
    • pipelineLayout – a VkPipelineLayout object used to program the bindings. This parameter is ignored if templateType is not DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR
    • set – the set number of the descriptor set in the pipeline layout that will be updated. This parameter is ignored if templateType is not DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS_KHR

    Layout

    
     struct VkDescriptorUpdateTemplateCreateInfo {
         VkStructureType sType;
         void const * pNext;
         VkDescriptorUpdateTemplateCreateFlags flags;
         uint32_t descriptorUpdateEntryCount;
         VkDescriptorUpdateTemplateEntry const * pDescriptorUpdateEntries;
         VkDescriptorUpdateTemplateType templateType;
         VkDescriptorSetLayout descriptorSetLayout;
         VkPipelineBindPoint pipelineBindPoint;
         VkPipelineLayout pipelineLayout;
         uint32_t set;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, FLAGS, DESCRIPTORUPDATEENTRYCOUNT, PDESCRIPTORUPDATEENTRIES, TEMPLATETYPE, DESCRIPTORSETLAYOUT, PIPELINEBINDPOINT, PIPELINELAYOUT, SET

        The struct member offsets.
    • Constructor Detail

      • VkDescriptorUpdateTemplateCreateInfo

        public VkDescriptorUpdateTemplateCreateInfo​(java.nio.ByteBuffer container)
        Creates a VkDescriptorUpdateTemplateCreateInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

        The created instance holds a strong reference to the container object.