Class VkAttachmentDescription2KHR

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

    public class VkAttachmentDescription2KHR
    extends Struct
    implements NativeResource
    Structure specifying an attachment description.
    Description

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

    Valid Usage
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHR
    • flags must be a valid combination of VkAttachmentDescriptionFlagBits values
    • format must be a valid VkFormat value
    • samples must be a valid VkSampleCountFlagBits value
    • loadOp must be a valid VkAttachmentLoadOp value
    • storeOp must be a valid VkAttachmentStoreOp value
    • stencilLoadOp must be a valid VkAttachmentLoadOp value
    • stencilStoreOp must be a valid VkAttachmentStoreOp value
    • initialLayout must be a valid VkImageLayout value
    • finalLayout must be a valid VkImageLayout value
    See Also

    VkRenderPassCreateInfo2KHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – a bitmask of VkAttachmentDescriptionFlagBits specifying additional properties of the attachment.
    • format – a VkFormat value specifying the format of the image that will be used for the attachment.
    • samples – the number of samples of the image as defined in VkSampleCountFlagBits.
    • loadOp – a VkAttachmentLoadOp value specifying how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used.
    • storeOp – a VkAttachmentStoreOp value specifying how the contents of color and depth components of the attachment are treated at the end of the subpass where it is last used.
    • stencilLoadOp – a VkAttachmentLoadOp value specifying how the contents of stencil components of the attachment are treated at the beginning of the subpass where it is first used.
    • stencilStoreOp – a VkAttachmentStoreOp value specifying how the contents of stencil components of the attachment are treated at the end of the last subpass where it is used.
    • initialLayout – the layout the attachment image subresource will be in when a render pass instance begins.
    • finalLayout – the layout the attachment image subresource will be transitioned to when a render pass instance ends.

    Layout

    
     struct VkAttachmentDescription2KHR {
         VkStructureType sType;
         void const * pNext;
         VkAttachmentDescriptionFlags flags;
         VkFormat format;
         VkSampleCountFlagBits samples;
         VkAttachmentLoadOp loadOp;
         VkAttachmentStoreOp storeOp;
         VkAttachmentLoadOp stencilLoadOp;
         VkAttachmentStoreOp stencilStoreOp;
         VkImageLayout initialLayout;
         VkImageLayout finalLayout;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, FLAGS, FORMAT, SAMPLES, LOADOP, STOREOP, STENCILLOADOP, STENCILSTOREOP, INITIALLAYOUT, FINALLAYOUT

        The struct member offsets.
    • Constructor Detail

      • VkAttachmentDescription2KHR

        public VkAttachmentDescription2KHR​(java.nio.ByteBuffer container)
        Creates a VkAttachmentDescription2KHR 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class 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.
      • format

        public int format()
        Returns the value of the format field.
      • samples

        public int samples()
        Returns the value of the samples field.
      • loadOp

        public int loadOp()
        Returns the value of the loadOp field.
      • storeOp

        public int storeOp()
        Returns the value of the storeOp field.
      • stencilLoadOp

        public int stencilLoadOp()
        Returns the value of the stencilLoadOp field.
      • stencilStoreOp

        public int stencilStoreOp()
        Returns the value of the stencilStoreOp field.
      • initialLayout

        public int initialLayout()
        Returns the value of the initialLayout field.
      • finalLayout

        public int finalLayout()
        Returns the value of the finalLayout field.
      • stencilStoreOp

        public VkAttachmentDescription2KHR stencilStoreOp​(int value)
        Sets the specified value to the stencilStoreOp field.
      • set

        public VkAttachmentDescription2KHR set​(int sType,
                                               long pNext,
                                               int flags,
                                               int format,
                                               int samples,
                                               int loadOp,
                                               int storeOp,
                                               int stencilLoadOp,
                                               int stencilStoreOp,
                                               int initialLayout,
                                               int finalLayout)
        Initializes this struct with the specified values.
      • malloc

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

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

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

        public static VkAttachmentDescription2KHR callocStack​(MemoryStack stack)
        Returns a new VkAttachmentDescription2KHR 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().
      • nformat

        public static int nformat​(long struct)
        Unsafe version of format().
      • nsamples

        public static int nsamples​(long struct)
        Unsafe version of samples().
      • nloadOp

        public static int nloadOp​(long struct)
        Unsafe version of loadOp().
      • nstoreOp

        public static int nstoreOp​(long struct)
        Unsafe version of storeOp().
      • nstencilLoadOp

        public static int nstencilLoadOp​(long struct)
        Unsafe version of stencilLoadOp().
      • nstencilStoreOp

        public static int nstencilStoreOp​(long struct)
        Unsafe version of stencilStoreOp().
      • ninitialLayout

        public static int ninitialLayout​(long struct)
        Unsafe version of initialLayout().
      • nfinalLayout

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

        public static void nformat​(long struct,
                                   int value)
        Unsafe version of format.
      • nsamples

        public static void nsamples​(long struct,
                                    int value)
        Unsafe version of samples.
      • nloadOp

        public static void nloadOp​(long struct,
                                   int value)
        Unsafe version of loadOp.
      • nstoreOp

        public static void nstoreOp​(long struct,
                                    int value)
        Unsafe version of storeOp.
      • nstencilLoadOp

        public static void nstencilLoadOp​(long struct,
                                          int value)
        Unsafe version of stencilLoadOp.
      • nstencilStoreOp

        public static void nstencilStoreOp​(long struct,
                                           int value)
        Unsafe version of stencilStoreOp.
      • ninitialLayout

        public static void ninitialLayout​(long struct,
                                          int value)
        Unsafe version of initialLayout.
      • nfinalLayout

        public static void nfinalLayout​(long struct,
                                        int value)
        Unsafe version of finalLayout.