Package org.lwjgl.vulkan

Class VkMicromapBuildSizesInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkMicromapBuildSizesInfoEXT>
org.lwjgl.vulkan.VkMicromapBuildSizesInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkMicromapBuildSizesInfoEXT extends org.lwjgl.system.Struct<VkMicromapBuildSizesInfoEXT> implements org.lwjgl.system.NativeResource
Structure specifying build sizes for a micromap.
Valid Usage (Implicit)
See Also

GetMicromapBuildSizesEXT

Layout


 struct VkMicromapBuildSizesInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDeviceSize micromapSize();
     VkDeviceSize buildScratchSize();
     VkBool32 discardable();
 }

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

    • MICROMAPSIZE

      public static final int MICROMAPSIZE
      The struct member offsets.

    • BUILDSCRATCHSIZE

      public static final int BUILDSCRATCHSIZE
      The struct member offsets.

    • DISCARDABLE

      public static final int DISCARDABLE
      The struct member offsets.

  • Constructor Details

    • VkMicromapBuildSizesInfoEXT

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

    • sType

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

    • pNext

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

    • micromapSize

      public long micromapSize()
      the size in bytes required in a VkMicromapEXT for a build or update operation.

    • buildScratchSize

      public long buildScratchSize()
      the size in bytes required in a scratch buffer for a build operation.

    • discardable

      public boolean discardable()
      indicates whether or not the micromap object may be destroyed after an acceleration structure build or update. A false value means that acceleration structures built with this micromap may contain references to the data contained therein, and the application must not destroy the micromap until ray traversal has concluded. A true value means that the information in the micromap will be copied by value into the acceleration structure, and the micromap may be destroyed after the acceleration structure build concludes.

    • sType

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

    • sType$Default

      public VkMicromapBuildSizesInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_MICROMAP_BUILD_SIZES_INFO_EXT value to the sType() field.

    • pNext

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

    • micromapSize

      public VkMicromapBuildSizesInfoEXT micromapSize(long value)
      Sets the specified value to the micromapSize() field.

    • buildScratchSize

      public VkMicromapBuildSizesInfoEXT buildScratchSize(long value)
      Sets the specified value to the buildScratchSize() field.

    • discardable

      public VkMicromapBuildSizesInfoEXT discardable(boolean value)
      Sets the specified value to the discardable() field.

    • set

      public VkMicromapBuildSizesInfoEXT set(int sType, long pNext, long micromapSize, long buildScratchSize, boolean discardable)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nmicromapSize

      public static long nmicromapSize(long struct)
      Unsafe version of micromapSize().

    • nbuildScratchSize

      public static long nbuildScratchSize(long struct)
      Unsafe version of buildScratchSize().

    • ndiscardable

      public static int ndiscardable(long struct)
      Unsafe version of discardable().

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

    • nmicromapSize

      public static void nmicromapSize(long struct, long value)
      Unsafe version of micromapSize.

    • nbuildScratchSize

      public static void nbuildScratchSize(long struct, long value)
      Unsafe version of buildScratchSize.

    • ndiscardable

      public static void ndiscardable(long struct, int value)
      Unsafe version of discardable.