Package org.lwjgl.openxr

Class XrSemanticLabelsFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSemanticLabelsFB>
org.lwjgl.openxr.XrSemanticLabelsFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSemanticLabelsFB extends org.lwjgl.system.Struct<XrSemanticLabelsFB> implements org.lwjgl.system.NativeResource
Provides application with semantic usage of a spatial entity.
Description

This structure is used by the GetSpaceSemanticLabelsFB function to provide the application with the intended usage of the spatial entity.

Valid Usage (Implicit)
See Also

GetSpaceSemanticLabelsFB

Layout


 struct XrSemanticLabelsFB {
     XrStructureType type();
     void const * next();
     uint32_t bufferCapacityInput();
     uint32_t bufferCountOutput();
     char * buffer();
 }

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

    • BUFFERCAPACITYINPUT

      public static final int BUFFERCAPACITYINPUT
      The struct member offsets.

    • BUFFERCOUNTOUTPUT

      public static final int BUFFERCOUNTOUTPUT
      The struct member offsets.

    • BUFFER

      public static final int BUFFER
      The struct member offsets.

  • Constructor Details

    • XrSemanticLabelsFB

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

    • 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, such as XrSemanticLabelsSupportInfoFB.

    • bufferCapacityInput

      public int bufferCapacityInput()
      the capacity of the buffer array, in bytes, or 0 to indicate a request to retrieve the required capacity.

    • bufferCountOutput

      public int bufferCountOutput()
      the count of bytes written, or the required capacity in the case that bufferCapacityInput is insufficient.

    • buffer

      public @Nullable ByteBuffer buffer()
      a pointer to an array of bytes, but can be NULL if bufferCapacityInput is 0. Multiple labels represented by raw string, separated by a comma without spaces.

    • type

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

    • type$Default

      public XrSemanticLabelsFB type$Default()
      Sets the TYPE_SEMANTIC_LABELS_FB value to the type() field.

    • next

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

    • bufferCapacityInput

      public XrSemanticLabelsFB bufferCapacityInput(int value)
      Sets the specified value to the bufferCapacityInput() field.

    • bufferCountOutput

      public XrSemanticLabelsFB bufferCountOutput(int value)
      Sets the specified value to the bufferCountOutput() field.

    • buffer

      public XrSemanticLabelsFB buffer(@Nullable ByteBuffer value)
      Sets the address of the specified ByteBuffer to the buffer() field.

    • set

      public XrSemanticLabelsFB set(int type, long next, int bufferCapacityInput, int bufferCountOutput, @Nullable ByteBuffer buffer)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nbufferCapacityInput

      public static int nbufferCapacityInput(long struct)
      Unsafe version of bufferCapacityInput().

    • nbufferCountOutput

      public static int nbufferCountOutput(long struct)
      Unsafe version of bufferCountOutput().

    • nbuffer

      public static @Nullable ByteBuffer nbuffer(long struct)
      Unsafe version of buffer.

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

    • nbufferCapacityInput

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

    • nbufferCountOutput

      public static void nbufferCountOutput(long struct, int value)
      Unsafe version of bufferCountOutput.

    • nbuffer

      public static void nbuffer(long struct, @Nullable ByteBuffer value)
      Unsafe version of buffer.