Package org.lwjgl.vulkan

Class VkRenderingAreaInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkRenderingAreaInfo>
org.lwjgl.vulkan.VkRenderingAreaInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkRenderingAreaInfoKHR
public class VkRenderingAreaInfo extends org.lwjgl.system.Struct<VkRenderingAreaInfo> implements org.lwjgl.system.NativeResource
Structure describing rendering area granularity query info.
Valid Usage (Implicit)
See Also

GetRenderingAreaGranularity, GetRenderingAreaGranularityKHR

Layout


 struct VkRenderingAreaInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t viewMask();
     uint32_t colorAttachmentCount();
     VkFormat const * pColorAttachmentFormats();
     VkFormat depthAttachmentFormat();
     VkFormat stencilAttachmentFormat();
 }

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

    • VIEWMASK

      public static final int VIEWMASK
      The struct member offsets.

    • COLORATTACHMENTCOUNT

      public static final int COLORATTACHMENTCOUNT
      The struct member offsets.

    • PCOLORATTACHMENTFORMATS

      public static final int PCOLORATTACHMENTFORMATS
      The struct member offsets.

    • DEPTHATTACHMENTFORMAT

      public static final int DEPTHATTACHMENTFORMAT
      The struct member offsets.

    • STENCILATTACHMENTFORMAT

      public static final int STENCILATTACHMENTFORMAT
      The struct member offsets.

  • Constructor Details

    • VkRenderingAreaInfo

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

    • sType

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

    • pNext

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

    • viewMask

      public int viewMask()
      the viewMask used for rendering.

    • colorAttachmentCount

      public int colorAttachmentCount()
      the number of entries in pColorAttachmentFormats

    • pColorAttachmentFormats

      public @Nullable IntBuffer pColorAttachmentFormats()
      a pointer to an array of VkFormat values defining the format of color attachments used in the render pass instance.

    • depthAttachmentFormat

      public int depthAttachmentFormat()
      a VkFormat value defining the format of the depth attachment used in the render pass instance.

    • stencilAttachmentFormat

      public int stencilAttachmentFormat()
      a VkFormat value defining the format of the stencil attachment used in the render pass instance.

    • sType

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

    • sType$Default

      public VkRenderingAreaInfo sType$Default()
      Sets the STRUCTURE_TYPE_RENDERING_AREA_INFO value to the sType() field.

    • pNext

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

    • viewMask

      public VkRenderingAreaInfo viewMask(int value)
      Sets the specified value to the viewMask() field.

    • colorAttachmentCount

      public VkRenderingAreaInfo colorAttachmentCount(int value)
      Sets the specified value to the colorAttachmentCount() field.

    • pColorAttachmentFormats

      public VkRenderingAreaInfo pColorAttachmentFormats(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the pColorAttachmentFormats() field.

    • depthAttachmentFormat

      public VkRenderingAreaInfo depthAttachmentFormat(int value)
      Sets the specified value to the depthAttachmentFormat() field.

    • stencilAttachmentFormat

      public VkRenderingAreaInfo stencilAttachmentFormat(int value)
      Sets the specified value to the stencilAttachmentFormat() field.

    • set

      public VkRenderingAreaInfo set(int sType, long pNext, int viewMask, int colorAttachmentCount, @Nullable IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nviewMask

      public static int nviewMask(long struct)
      Unsafe version of viewMask().

    • ncolorAttachmentCount

      public static int ncolorAttachmentCount(long struct)
      Unsafe version of colorAttachmentCount().

    • npColorAttachmentFormats

      public static @Nullable IntBuffer npColorAttachmentFormats(long struct)
      Unsafe version of pColorAttachmentFormats.

    • ndepthAttachmentFormat

      public static int ndepthAttachmentFormat(long struct)
      Unsafe version of depthAttachmentFormat().

    • nstencilAttachmentFormat

      public static int nstencilAttachmentFormat(long struct)
      Unsafe version of stencilAttachmentFormat().

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

    • nviewMask

      public static void nviewMask(long struct, int value)
      Unsafe version of viewMask.

    • ncolorAttachmentCount

      public static void ncolorAttachmentCount(long struct, int value)
      Sets the specified value to the colorAttachmentCount field of the specified struct.

    • npColorAttachmentFormats

      public static void npColorAttachmentFormats(long struct, @Nullable IntBuffer value)
      Unsafe version of pColorAttachmentFormats.

    • ndepthAttachmentFormat

      public static void ndepthAttachmentFormat(long struct, int value)
      Unsafe version of depthAttachmentFormat.

    • nstencilAttachmentFormat

      public static void nstencilAttachmentFormat(long struct, int value)
      Unsafe version of stencilAttachmentFormat.