Class VkAttachmentDescription

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkAttachmentDescription>
org.lwjgl.vulkan.VkAttachmentDescription
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class VkAttachmentDescription extends Struct<VkAttachmentDescription> implements NativeResource
struct VkAttachmentDescription {
    VkAttachmentDescriptionFlags flags;
    VkFormat format;
    VkSampleCountFlagBits samples;
    VkAttachmentLoadOp loadOp;
    VkAttachmentStoreOp storeOp;
    VkAttachmentLoadOp stencilLoadOp;
    VkAttachmentStoreOp stencilStoreOp;
    VkImageLayout initialLayout;
    VkImageLayout finalLayout;
}

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • FORMAT

      public static final int FORMAT
      The struct member offsets.

    • SAMPLES

      public static final int SAMPLES
      The struct member offsets.

    • LOADOP

      public static final int LOADOP
      The struct member offsets.

    • STOREOP

      public static final int STOREOP
      The struct member offsets.

    • STENCILLOADOP

      public static final int STENCILLOADOP
      The struct member offsets.

    • STENCILSTOREOP

      public static final int STENCILSTOREOP
      The struct member offsets.

    • INITIALLAYOUT

      public static final int INITIALLAYOUT
      The struct member offsets.

    • FINALLAYOUT

      public static final int FINALLAYOUT
      The struct member offsets.

  • Constructor Details

    • VkAttachmentDescription

      public VkAttachmentDescription(ByteBuffer container)
      Creates a VkAttachmentDescription 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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<VkAttachmentDescription>

    • flags

      @NativeType("VkAttachmentDescriptionFlags") public int flags()
      Returns:
      the value of the flags field.

    • format

      @NativeType("VkFormat") public int format()
      Returns:
      the value of the format field.

    • samples

      @NativeType("VkSampleCountFlagBits") public int samples()
      Returns:
      the value of the samples field.

    • loadOp

      @NativeType("VkAttachmentLoadOp") public int loadOp()
      Returns:
      the value of the loadOp field.

    • storeOp

      @NativeType("VkAttachmentStoreOp") public int storeOp()
      Returns:
      the value of the storeOp field.

    • stencilLoadOp

      @NativeType("VkAttachmentLoadOp") public int stencilLoadOp()
      Returns:
      the value of the stencilLoadOp field.

    • stencilStoreOp

      @NativeType("VkAttachmentStoreOp") public int stencilStoreOp()
      Returns:
      the value of the stencilStoreOp field.

    • initialLayout

      @NativeType("VkImageLayout") public int initialLayout()
      Returns:
      the value of the initialLayout field.

    • finalLayout

      @NativeType("VkImageLayout") public int finalLayout()
      Returns:
      the value of the finalLayout field.

    • flags

      public VkAttachmentDescription flags(@NativeType("VkAttachmentDescriptionFlags") int value)
      Sets the specified value to the flags field.

    • format

      public VkAttachmentDescription format(@NativeType("VkFormat") int value)
      Sets the specified value to the format field.

    • samples

      public VkAttachmentDescription samples(@NativeType("VkSampleCountFlagBits") int value)
      Sets the specified value to the samples field.

    • loadOp

      public VkAttachmentDescription loadOp(@NativeType("VkAttachmentLoadOp") int value)
      Sets the specified value to the loadOp field.

    • storeOp

      public VkAttachmentDescription storeOp(@NativeType("VkAttachmentStoreOp") int value)
      Sets the specified value to the storeOp field.

    • stencilLoadOp

      public VkAttachmentDescription stencilLoadOp(@NativeType("VkAttachmentLoadOp") int value)
      Sets the specified value to the stencilLoadOp field.

    • stencilStoreOp

      public VkAttachmentDescription stencilStoreOp(@NativeType("VkAttachmentStoreOp") int value)
      Sets the specified value to the stencilStoreOp field.

    • initialLayout

      public VkAttachmentDescription initialLayout(@NativeType("VkImageLayout") int value)
      Sets the specified value to the initialLayout field.

    • finalLayout

      public VkAttachmentDescription finalLayout(@NativeType("VkImageLayout") int value)
      Sets the specified value to the finalLayout field.

    • set

      public VkAttachmentDescription set(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.

    • set

      public VkAttachmentDescription set(VkAttachmentDescription src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

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

    • calloc

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

    • create

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

    • create

      public static VkAttachmentDescription create(long address)
      Returns a new VkAttachmentDescription instance for the specified memory address.

    • createSafe

      public static @Nullable VkAttachmentDescription createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkAttachmentDescription.Buffer malloc(int capacity)
      Returns a new VkAttachmentDescription.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkAttachmentDescription.Buffer calloc(int capacity)
      Returns a new VkAttachmentDescription.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkAttachmentDescription.Buffer create(int capacity)
      Returns a new VkAttachmentDescription.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkAttachmentDescription.Buffer create(long address, int capacity)
      Create a VkAttachmentDescription.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkAttachmentDescription.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkAttachmentDescription malloc(MemoryStack stack)
      Returns a new VkAttachmentDescription instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkAttachmentDescription calloc(MemoryStack stack)
      Returns a new VkAttachmentDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkAttachmentDescription.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new VkAttachmentDescription.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkAttachmentDescription.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new VkAttachmentDescription.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • 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().

    • 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.