Package org.lwjgl.vulkan

Class VkDescriptorPoolSize

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkDescriptorPoolSize
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying descriptor pool size.
    Description
    Note

    When creating a descriptor pool that will contain descriptors for combined image samplers of multi-planar formats, an application needs to account for non-trivial descriptor consumption when choosing the descriptorCount value, as indicated by VkSamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount.

    Valid Usage
    Valid Usage (Implicit)
    • type must be a valid VkDescriptorType value
    See Also

    VkDescriptorPoolCreateInfo

    Layout

    
 struct VkDescriptorPoolSize {
     VkDescriptorType type();
     uint32_t descriptorCount();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • TYPE, DESCRIPTORCOUNT

        The struct member offsets.

    • Constructor Detail

      • VkDescriptorPoolSize

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

      • type

        public int type()
        the type of descriptor.

      • descriptorCount

        public int descriptorCount()
        the number of descriptors of that type to allocate. If type is DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK then descriptorCount is the number of bytes to allocate for descriptors of this type.

      • set

        public VkDescriptorPoolSize set​(int type,
                                int descriptorCount)
        Initializes this struct with the specified values.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

        @Nullable
public static VkDescriptorPoolSize createSafe​(long address)
        Like create, but returns null if address is NULL.

      • malloc

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

      • calloc

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

      • malloc

        public static VkDescriptorPoolSize.Buffer malloc​(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
        Returns a new VkDescriptorPoolSize.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • calloc

        public static VkDescriptorPoolSize.Buffer calloc​(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
        Returns a new VkDescriptorPoolSize.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

      • ntype

        public static int ntype​(long struct)
        Unsafe version of type().

      • ndescriptorCount

        public static int ndescriptorCount​(long struct)
        Unsafe version of descriptorCount().

      • ntype

        public static void ntype​(long struct,
                         int value)
        Unsafe version of type.

      • ndescriptorCount

        public static void ndescriptorCount​(long struct,
                                    int value)
        Unsafe version of descriptorCount.