Class VkImageFormatListCreateInfoKHR

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

    public class VkImageFormatListCreateInfoKHR
    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 VkImageFormatListCreateInfoKHR structure were not included in the pNext list of VkImageCreateInfo.

    Valid Usage
    Valid Usage (Implicit)

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • viewFormatCount – the number of entries in the pViewFormats array.
    • pViewFormats – an array which lists of all formats which can be used when creating views of this image.

    Layout

    
     struct VkImageFormatListCreateInfoKHR {
         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

      • VkImageFormatListCreateInfoKHR

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

        public int viewFormatCount()
        Returns the value of the viewFormatCount field.
      • pViewFormats

        @Nullable
        public java.nio.IntBuffer pViewFormats()
        Returns a IntBuffer view of the data pointed to by the pViewFormats field.
      • pViewFormats

        public VkImageFormatListCreateInfoKHR pViewFormats​(@Nullable
                                                           java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pViewFormats field.
      • set

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

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

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

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

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

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

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

        public static VkImageFormatListCreateInfoKHR callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkImageFormatListCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • 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
      • 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