Package org.lwjgl.vulkan

Class VkRenderingAreaInfoKHR

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

GetRenderingAreaGranularityKHR

Layout


 struct VkRenderingAreaInfoKHR {
     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

    • VkRenderingAreaInfoKHR

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

    • 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

      @Nullable public 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 VkRenderingAreaInfoKHR sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkRenderingAreaInfoKHR sType$Default()
      Sets the STRUCTURE_TYPE_RENDERING_AREA_INFO_KHR value to the sType() field.

    • pNext

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

    • viewMask

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

    • colorAttachmentCount

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

    • pColorAttachmentFormats

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

    • depthAttachmentFormat

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

    • stencilAttachmentFormat

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

    • set

      public VkRenderingAreaInfoKHR 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 VkRenderingAreaInfoKHR set(VkRenderingAreaInfoKHR src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

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