Class VkFramebufferAttachmentImageInfoKHR

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

    public class VkFramebufferAttachmentImageInfoKHR
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying parameters of an image that will be used with a framebuffer.
    Description

    Images that can be used with the framebuffer when beginning a render pass, as specified by VkRenderPassAttachmentBeginInfoKHR, must be created with parameters that are identical to those specified here.

    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO_KHR
    • pNext must be NULL
    • flags must be a valid combination of VkImageCreateFlagBits values
    • usage must be a valid combination of VkImageUsageFlagBits values
    • usage must not be 0
    • If viewFormatCount is not 0, pViewFormats must be a valid pointer to an array of viewFormatCount valid VkFormat values
    See Also

    VkFramebufferAttachmentsCreateInfoKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – a bitmask of VkImageCreateFlagBits, matching the value of VkImageCreateInfo::flags used to create an image that will be used with this framebuffer.
    • usage – a bitmask of VkImageUsageFlagBits, matching the value of VkImageCreateInfo::usage used to create an image used with this framebuffer.
    • width – the width of the image view used for rendering.
    • height – the height of the image view used for rendering.
    • viewFormatCount – the number of entries in the pViewFormats array, matching the value of VkImageFormatListCreateInfoKHR::viewFormatCount used to create an image used with this framebuffer.
    • pViewFormats – an array which lists of all formats which can be used when creating views of the image, matching the value of VkImageFormatListCreateInfoKHR::pViewFormats used to create an image used with this framebuffer.

    Layout

    
     struct VkFramebufferAttachmentImageInfoKHR {
         VkStructureType sType;
         void const * pNext;
         VkImageCreateFlags flags;
         VkImageUsageFlags usage;
         uint32_t width;
         uint32_t height;
         uint32_t layerCount;
         uint32_t viewFormatCount;
         VkFormat const * pViewFormats;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, FLAGS, USAGE, WIDTH, HEIGHT, LAYERCOUNT, VIEWFORMATCOUNT, PVIEWFORMATS

        The struct member offsets.
    • Constructor Detail

      • VkFramebufferAttachmentImageInfoKHR

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

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

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

        public int width()
        Returns the value of the width field.
      • height

        public int height()
        Returns the value of the height field.
      • layerCount

        public int layerCount()
        Returns the value of the layerCount 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 VkFramebufferAttachmentImageInfoKHR pViewFormats​(@Nullable
                                                                java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pViewFormats field.
      • set

        public VkFramebufferAttachmentImageInfoKHR set​(int sType,
                                                       long pNext,
                                                       int flags,
                                                       int usage,
                                                       int width,
                                                       int height,
                                                       int layerCount,
                                                       @Nullable
                                                       java.nio.IntBuffer pViewFormats)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

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

        public static VkFramebufferAttachmentImageInfoKHR callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkFramebufferAttachmentImageInfoKHR 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().
      • nflags

        public static int nflags​(long struct)
        Unsafe version of flags().
      • nusage

        public static int nusage​(long struct)
        Unsafe version of usage().
      • nwidth

        public static int nwidth​(long struct)
        Unsafe version of width().
      • nheight

        public static int nheight​(long struct)
        Unsafe version of height().
      • nlayerCount

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

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

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

        public static void nwidth​(long struct,
                                  int value)
        Unsafe version of width.
      • nheight

        public static void nheight​(long struct,
                                   int value)
        Unsafe version of height.
      • nlayerCount

        public static void nlayerCount​(long struct,
                                       int value)
        Unsafe version of layerCount.
      • 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