Class VkRenderPassAttachmentBeginInfoKHR

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

    public class VkRenderPassAttachmentBeginInfoKHR
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying images to be used as framebuffer attachments.
    Valid Usage
    • Each element of pAttachments must only specify a single mip level
    • Each element of pAttachments must have been created with the identity swizzle
    Valid Usage (Implicit)

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • attachmentCount – the number of attachments.
    • pAttachments – an array of VkImageView handles, each of which will be used as the corresponding attachment in the render pass instance.

    Layout

    
     struct VkRenderPassAttachmentBeginInfoKHR {
         VkStructureType sType;
         void const * pNext;
         uint32_t attachmentCount;
         VkImageView const * pAttachments;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, ATTACHMENTCOUNT, PATTACHMENTS

        The struct member offsets.
    • Constructor Detail

      • VkRenderPassAttachmentBeginInfoKHR

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

        public int attachmentCount()
        Returns the value of the attachmentCount field.
      • pAttachments

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

        public VkRenderPassAttachmentBeginInfoKHR pAttachments​(@Nullable
                                                               java.nio.LongBuffer value)
        Sets the address of the specified LongBuffer to the pAttachments field.
      • set

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

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

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

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

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

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

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

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

        public static int nattachmentCount​(long struct)
        Unsafe version of attachmentCount().
      • npAttachments

        @Nullable
        public static java.nio.LongBuffer npAttachments​(long struct)
        Unsafe version of pAttachments.
      • 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.
      • nattachmentCount

        public static void nattachmentCount​(long struct,
                                            int value)
        Sets the specified value to the attachmentCount field of the specified struct.
      • npAttachments

        public static void npAttachments​(long struct,
                                         @Nullable
                                         java.nio.LongBuffer value)
        Unsafe version of pAttachments.
      • 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