Package org.lwjgl.openxr

Class XrDebugUtilsLabelEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrDebugUtilsLabelEXT>
org.lwjgl.openxr.XrDebugUtilsLabelEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrDebugUtilsLabelEXT extends org.lwjgl.system.Struct<XrDebugUtilsLabelEXT> implements org.lwjgl.system.NativeResource
Debug Utils Label.
Valid Usage (Implicit)
See Also

XrDebugUtilsMessengerCallbackDataEXT, SessionBeginDebugUtilsLabelRegionEXT, SessionInsertDebugUtilsLabelEXT

Layout


 struct XrDebugUtilsLabelEXT {
     XrStructureType type();
     void const * next();
     char const * labelName();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • TYPE

      public static final int TYPE
      The struct member offsets.

    • NEXT

      public static final int NEXT
      The struct member offsets.

    • LABELNAME

      public static final int LABELNAME
      The struct member offsets.

  • Constructor Details

    • XrDebugUtilsLabelEXT

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

    • type

      public int type()
      the XrStructureType of this structure.

    • next

      public long next()
      NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

    • labelName

      public ByteBuffer labelName()
      a NULL terminated UTF-8 string specifying the label name.

    • labelNameString

      public String labelNameString()
      a NULL terminated UTF-8 string specifying the label name.

    • type

      public XrDebugUtilsLabelEXT type(int value)
      Sets the specified value to the type() field.

    • type$Default

      public XrDebugUtilsLabelEXT type$Default()
      Sets the TYPE_DEBUG_UTILS_LABEL_EXT value to the type() field.

    • next

      public XrDebugUtilsLabelEXT next(long value)
      Sets the specified value to the next() field.

    • labelName

      public XrDebugUtilsLabelEXT labelName(ByteBuffer value)
      Sets the address of the specified encoded string to the labelName() field.

    • set

      public XrDebugUtilsLabelEXT set(int type, long next, ByteBuffer labelName)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • ntype

      public static int ntype(long struct)
      Unsafe version of type().

    • nnext

      public static long nnext(long struct)
      Unsafe version of next().

    • nlabelName

      public static ByteBuffer nlabelName(long struct)
      Unsafe version of labelName().

    • nlabelNameString

      public static String nlabelNameString(long struct)
      Unsafe version of labelNameString().

    • ntype

      public static void ntype(long struct, int value)
      Unsafe version of type.

    • nnext

      public static void nnext(long struct, long value)
      Unsafe version of next.

    • nlabelName

      public static void nlabelName(long struct, ByteBuffer value)
      Unsafe version of labelName.

    • validate

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