Package org.lwjgl.vulkan

Class VkMicromapVersionInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkMicromapVersionInfoEXT>
org.lwjgl.vulkan.VkMicromapVersionInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkMicromapVersionInfoEXT extends org.lwjgl.system.Struct<VkMicromapVersionInfoEXT> implements org.lwjgl.system.NativeResource
Micromap version information.
Description
Note

pVersionData is a pointer to an array of 2×UUID_SIZE uint8_t values instead of two UUID_SIZE arrays as the expected use case for this member is to be pointed at the header of a previously serialized micromap (via CmdCopyMicromapToMemoryEXT or CopyMicromapToMemoryEXT) that is loaded in memory. Using arrays would necessitate extra memory copies of the UUIDs.

Valid Usage (Implicit)
See Also

GetDeviceMicromapCompatibilityEXT

Layout


 struct VkMicromapVersionInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint8_t const * pVersionData(int);
 }

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

    • PVERSIONDATA

      public static final int PVERSIONDATA
      The struct member offsets.

  • Constructor Details

    • VkMicromapVersionInfoEXT

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

    • sType

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

    • pNext

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

    • pVersionData

      public ByteBuffer pVersionData(int capacity)
      Parameters:
      capacity - the number of elements in the returned buffer
      Returns:
      a pointer to the version header of a micromap as defined in CmdCopyMicromapToMemoryEXT

    • sType

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

    • sType$Default

      public VkMicromapVersionInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_MICROMAP_VERSION_INFO_EXT value to the sType() field.

    • pNext

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

    • pVersionData

      public VkMicromapVersionInfoEXT pVersionData(ByteBuffer value)
      Sets the address of the specified ByteBuffer to the pVersionData(int) field.

    • set

      public VkMicromapVersionInfoEXT set(int sType, long pNext, ByteBuffer pVersionData)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • npVersionData

      public static ByteBuffer npVersionData(long struct, int capacity)
      Unsafe version of pVersionData.

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

    • npVersionData

      public static void npVersionData(long struct, ByteBuffer value)
      Unsafe version of pVersionData.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate