Class VkImageViewUsageCreateInfo

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

    public class VkImageViewUsageCreateInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Specify the intended usage of an image view.
    Description

    When this structure is chained to VkImageViewCreateInfo the usage field overrides the implicit usage parameter inherited from image creation time and its value is used instead for the purposes of determining the valid usage conditions of VkImageViewCreateInfo.

    Valid Usage (Implicit)

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • usage – a bitmask describing the allowed usages of the image view. See VkImageUsageFlagBits for a description of the supported bits.

    Layout

    
     struct VkImageViewUsageCreateInfo {
         VkStructureType sType;
         void const * pNext;
         VkImageUsageFlags usage;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, USAGE

        The struct member offsets.
    • Constructor Detail

      • VkImageViewUsageCreateInfo

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

        public int usage()
        Returns the value of the usage field.
      • set

        public VkImageViewUsageCreateInfo set​(int sType,
                                              long pNext,
                                              int usage)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

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

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

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

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

        public static int nusage​(long struct)
        Unsafe version of usage().
      • 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.
      • nusage

        public static void nusage​(long struct,
                                  int value)
        Unsafe version of usage.