Class VkImageFormatListCreateInfo

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

    public class VkImageFormatListCreateInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Specify that an image can be used with a particular set of formats.
    Description

    If viewFormatCount is zero, pViewFormats is ignored and the image is created as if the VkImageFormatListCreateInfo structure were not included in the pNext chain of VkImageCreateInfo.

    Valid Usage (Implicit)

    Layout

    
     struct VkImageFormatListCreateInfo {
         VkStructureType sType();
         void const * pNext();
         uint32_t viewFormatCount();
         VkFormat const * pViewFormats();
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, VIEWFORMATCOUNT, PVIEWFORMATS

        The struct member offsets.
    • Constructor Detail

      • VkImageFormatListCreateInfo

        public VkImageFormatListCreateInfo​(java.nio.ByteBuffer container)
        Creates a VkImageFormatListCreateInfo 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()
        the type of this structure.
      • pNext

        public long pNext()
        NULL or a pointer to a structure extending this structure.
      • viewFormatCount

        public int viewFormatCount()
        the number of entries in the pViewFormats array.
      • pViewFormats

        @Nullable
        public java.nio.IntBuffer pViewFormats()
        a pointer to an array of VkFormat values specifying all formats which can be used when creating views of this image.
      • set

        public VkImageFormatListCreateInfo set​(int sType,
                                               long pNext,
                                               @Nullable
                                               java.nio.IntBuffer pViewFormats)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

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

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

        public static int nviewFormatCount​(long struct)
        Unsafe version of viewFormatCount().
      • npViewFormats

        @Nullable
        public static java.nio.IntBuffer npViewFormats​(long struct)
        Unsafe version of pViewFormats.
      • 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.
      • nviewFormatCount

        public static void nviewFormatCount​(long struct,
                                            int value)
        Sets the specified value to the viewFormatCount field of the specified struct.
      • npViewFormats

        public static void npViewFormats​(long struct,
                                         @Nullable
                                         java.nio.IntBuffer value)
        Unsafe version of pViewFormats.
      • validate

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