Class VkAttachmentReference2KHR

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

    public class VkAttachmentReference2KHR
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying an attachment reference.
    Description

    Parameters defined by this structure with the same name as those in VkAttachmentReference have the identical effect to those parameters.

    aspectMask has the same effect for the described attachment as VkInputAttachmentAspectReference::aspectMask has on each corresponding attachment. It is ignored when this structure is used to describe anything other than an input attachment reference.

    Valid Usage
    Valid Usage (Implicit)
    See Also

    VkSubpassDescription2KHR, VkSubpassDescriptionDepthStencilResolveKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • attachment – either an integer value identifying an attachment at the corresponding index in VkRenderPassCreateInfo::pAttachments, or ATTACHMENT_UNUSED to signify that this attachment is not used.
    • layout – a VkImageLayout value specifying the layout the attachment uses during the subpass.
    • aspectMask – a mask of which aspect(s) can be accessed within the specified subpass as an input attachment.

    Layout

    
     struct VkAttachmentReference2KHR {
         VkStructureType sType;
         void const * pNext;
         uint32_t attachment;
         VkImageLayout layout;
         VkImageAspectFlags aspectMask;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, ATTACHMENT, LAYOUT, ASPECTMASK

        The struct member offsets.
    • Constructor Detail

      • VkAttachmentReference2KHR

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

        public int attachment()
        Returns the value of the attachment field.
      • layout

        public int layout()
        Returns the value of the layout field.
      • aspectMask

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

        public VkAttachmentReference2KHR set​(int sType,
                                             long pNext,
                                             int attachment,
                                             int layout,
                                             int aspectMask)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

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

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

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

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

        public static int nattachment​(long struct)
        Unsafe version of attachment().
      • nlayout

        public static int nlayout​(long struct)
        Unsafe version of layout().
      • naspectMask

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

        public static void nattachment​(long struct,
                                       int value)
        Unsafe version of attachment.
      • nlayout

        public static void nlayout​(long struct,
                                   int value)
        Unsafe version of layout.
      • naspectMask

        public static void naspectMask​(long struct,
                                       int value)
        Unsafe version of aspectMask.