Package org.lwjgl.vulkan

Class VkFramebufferAttachmentImageInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkFramebufferAttachmentImageInfo>
org.lwjgl.vulkan.VkFramebufferAttachmentImageInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkFramebufferAttachmentImageInfoKHR
public class VkFramebufferAttachmentImageInfo extends org.lwjgl.system.Struct<VkFramebufferAttachmentImageInfo> 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 VkRenderPassAttachmentBeginInfo, must be created with parameters that are identical to those specified here.

Valid Usage
  • If viewFormatCount is not 0, and the render pass is not being used with an external format resolve attachment, each element of pViewFormats must not be FORMAT_UNDEFINED
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO
  • 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

VkFramebufferAttachmentsCreateInfo

Layout


 struct VkFramebufferAttachmentImageInfo {
     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 Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • USAGE

      public static final int USAGE
      The struct member offsets.

    • WIDTH

      public static final int WIDTH
      The struct member offsets.

    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.

    • LAYERCOUNT

      public static final int LAYERCOUNT
      The struct member offsets.

    • VIEWFORMATCOUNT

      public static final int VIEWFORMATCOUNT
      The struct member offsets.

    • PVIEWFORMATS

      public static final int PVIEWFORMATS
      The struct member offsets.

  • Constructor Details

    • VkFramebufferAttachmentImageInfo

      public VkFramebufferAttachmentImageInfo(ByteBuffer container)
      Creates a VkFramebufferAttachmentImageInfo 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()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkFramebufferAttachmentImageInfo>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • flags

      public int flags()
      a bitmask of VkImageCreateFlagBits, matching the value of VkImageCreateInfo::flags used to create an image that will be used with this framebuffer.

    • usage

      public int usage()
      a bitmask of VkImageUsageFlagBits, matching the value of VkImageCreateInfo::usage used to create an image used with this framebuffer.

    • width

      public int width()
      the width of the image view used for rendering.

    • height

      public int height()
      the height of the image view used for rendering.

    • layerCount

      public int layerCount()
      the number of array layers of the image view used for rendering.

    • viewFormatCount

      public int viewFormatCount()
      the number of entries in the pViewFormats array, matching the value of VkImageFormatListCreateInfo::viewFormatCount used to create an image used with this framebuffer.

    • pViewFormats

      public @Nullable IntBuffer pViewFormats()
      a pointer to an array of VkFormat values specifying all of the formats which can be used when creating views of the image, matching the value of VkImageFormatListCreateInfo::pViewFormats used to create an image used with this framebuffer.

    • sType

      public VkFramebufferAttachmentImageInfo sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkFramebufferAttachmentImageInfo sType$Default()
      Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO value to the sType() field.

    • pNext

      public VkFramebufferAttachmentImageInfo pNext(long value)
      Sets the specified value to the pNext() field.

    • flags

      public VkFramebufferAttachmentImageInfo flags(int value)
      Sets the specified value to the flags() field.

    • usage

      public VkFramebufferAttachmentImageInfo usage(int value)
      Sets the specified value to the usage() field.

    • width

      public VkFramebufferAttachmentImageInfo width(int value)
      Sets the specified value to the width() field.

    • height

      public VkFramebufferAttachmentImageInfo height(int value)
      Sets the specified value to the height() field.

    • layerCount

      public VkFramebufferAttachmentImageInfo layerCount(int value)
      Sets the specified value to the layerCount() field.

    • pViewFormats

      public VkFramebufferAttachmentImageInfo pViewFormats(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the pViewFormats() field.

    • set

      public VkFramebufferAttachmentImageInfo set(int sType, long pNext, int flags, int usage, int width, int height, int layerCount, @Nullable IntBuffer pViewFormats)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

      public static VkFramebufferAttachmentImageInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkFramebufferAttachmentImageInfo.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

    • 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

      public static @Nullable 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 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