Class VkDescriptorSetAllocateInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class VkDescriptorSetAllocateInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying the allocation parameters for descriptor sets.
    Valid Usage
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO
    • pNext must be NULL or a pointer to a valid instance of VkDescriptorSetVariableDescriptorCountAllocateInfoEXT
    • descriptorPool must be a valid VkDescriptorPool handle
    • pSetLayouts must be a valid pointer to an array of descriptorSetCount valid VkDescriptorSetLayout handles
    • descriptorSetCount must be greater than 0
    • Both of descriptorPool, and the elements of pSetLayouts must have been created, allocated, or retrieved from the same VkDevice
    See Also

    AllocateDescriptorSets

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • descriptorPool – the pool which the sets will be allocated from.
    • descriptorSetCount – determines the number of descriptor sets to be allocated from the pool.
    • pSetLayouts – an array of descriptor set layouts, with each member specifying how the corresponding descriptor set is allocated.

    Layout

    
     struct VkDescriptorSetAllocateInfo {
         VkStructureType sType;
         void const * pNext;
         VkDescriptorPool descriptorPool;
         uint32_t descriptorSetCount;
         VkDescriptorSetLayout const * pSetLayouts;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, DESCRIPTORPOOL, DESCRIPTORSETCOUNT, PSETLAYOUTS

        The struct member offsets.
    • Constructor Detail

      • VkDescriptorSetAllocateInfo

        public VkDescriptorSetAllocateInfo​(java.nio.ByteBuffer container)
        Creates a VkDescriptorSetAllocateInfo 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.

    • Method Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • descriptorPool

        public long descriptorPool()
        Returns the value of the descriptorPool field.
      • descriptorSetCount

        public int descriptorSetCount()
        Returns the value of the descriptorSetCount field.
      • pSetLayouts

        public java.nio.LongBuffer pSetLayouts()
        Returns a LongBuffer view of the data pointed to by the pSetLayouts field.
      • descriptorPool

        public VkDescriptorSetAllocateInfo descriptorPool​(long value)
        Sets the specified value to the descriptorPool field.
      • pSetLayouts

        public VkDescriptorSetAllocateInfo pSetLayouts​(java.nio.LongBuffer value)
        Sets the address of the specified LongBuffer to the pSetLayouts field.
      • set

        public VkDescriptorSetAllocateInfo set​(int sType,
                                               long pNext,
                                               long descriptorPool,
                                               java.nio.LongBuffer pSetLayouts)
        Initializes this struct with the specified values.
      • malloc

        public static VkDescriptorSetAllocateInfo malloc()
        Returns a new VkDescriptorSetAllocateInfo instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static VkDescriptorSetAllocateInfo calloc()
        Returns a new VkDescriptorSetAllocateInfo instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static VkDescriptorSetAllocateInfo create()
        Returns a new VkDescriptorSetAllocateInfo instance allocated with BufferUtils.
      • create

        public static VkDescriptorSetAllocateInfo create​(long address)
        Returns a new VkDescriptorSetAllocateInfo instance for the specified memory address.
      • mallocStack

        public static VkDescriptorSetAllocateInfo mallocStack()
        Returns a new VkDescriptorSetAllocateInfo instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkDescriptorSetAllocateInfo callocStack()
        Returns a new VkDescriptorSetAllocateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static VkDescriptorSetAllocateInfo mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkDescriptorSetAllocateInfo instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static VkDescriptorSetAllocateInfo callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkDescriptorSetAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static VkDescriptorSetAllocateInfo.Buffer callocStack​(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
        Returns a new VkDescriptorSetAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().
      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().
      • ndescriptorPool

        public static long ndescriptorPool​(long struct)
        Unsafe version of descriptorPool().
      • ndescriptorSetCount

        public static int ndescriptorSetCount​(long struct)
        Unsafe version of descriptorSetCount().
      • npSetLayouts

        public static java.nio.LongBuffer npSetLayouts​(long struct)
        Unsafe version of pSetLayouts.
      • nsType

        public static void nsType​(long struct,
                                  int value)
        Unsafe version of sType.
      • npNext

        public static void npNext​(long struct,
                                  long value)
        Unsafe version of pNext.
      • ndescriptorPool

        public static void ndescriptorPool​(long struct,
                                           long value)
        Unsafe version of descriptorPool.
      • ndescriptorSetCount

        public static void ndescriptorSetCount​(long struct,
                                               int value)
        Sets the specified value to the descriptorSetCount field of the specified struct.
      • npSetLayouts

        public static void npSetLayouts​(long struct,
                                        java.nio.LongBuffer value)
        Unsafe version of pSetLayouts.
      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate
      • validate

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array