Package org.lwjgl.openxr

Class XrSemanticLabelsSupportInfoFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSemanticLabelsSupportInfoFB>
org.lwjgl.openxr.XrSemanticLabelsSupportInfoFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSemanticLabelsSupportInfoFB extends org.lwjgl.system.Struct<XrSemanticLabelsSupportInfoFB> implements org.lwjgl.system.NativeResource
Specifies additional behaviors of the xrGetSpaceSemanticLabelsFB function.
Description

The XrSemanticLabelsSupportInfoFB structure may be specified in the next chain of XrSemanticLabelsFB to specify additional behaviors of the GetSpaceSemanticLabelsFB function. The runtime must follow the behaviors specified in flags according to the descriptions of XrSemanticLabelsSupportFlagBitsFB. The runtime must return any semantic label that is not included in recognizedLabels as "OTHER" to the application. The runtime must follow this direction only if the runtime reports the XrExtensionProperties::extensionVersion as 2 or greater, otherwise the runtime must ignore this as an unknown chained structure.

If the XrSemanticLabelsSupportInfoFB structure is not present in the next chain of XrSemanticLabelsFB, the runtime may return any semantic labels to the application.

Valid Usage (Implicit)

Layout


 struct XrSemanticLabelsSupportInfoFB {
     XrStructureType type();
     void const * next();
     XrSemanticLabelsSupportFlagsFB flags();
     char const * recognizedLabels();
 }

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

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • RECOGNIZEDLABELS

      public static final int RECOGNIZEDLABELS
      The struct member offsets.

  • Constructor Details

    • XrSemanticLabelsSupportInfoFB

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

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

    • flags

      public long flags()
      a bitmask of XrSemanticLabelsSupportFlagBitsFB that specifies additional behaviors.

    • recognizedLabels

      public ByteBuffer recognizedLabels()
      a NULL terminated string that indicates a set of semantic labels recognized by the application. Each semantic label must be represented as a string and be separated by a comma without spaces. This field must include at least "OTHER" and must not be NULL.

    • recognizedLabelsString

      public String recognizedLabelsString()
      a NULL terminated string that indicates a set of semantic labels recognized by the application. Each semantic label must be represented as a string and be separated by a comma without spaces. This field must include at least "OTHER" and must not be NULL.

    • type

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

    • type$Default

      public XrSemanticLabelsSupportInfoFB type$Default()
      Sets the TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB value to the type() field.

    • next

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

    • flags

      public XrSemanticLabelsSupportInfoFB flags(long value)
      Sets the specified value to the flags() field.

    • recognizedLabels

      public XrSemanticLabelsSupportInfoFB recognizedLabels(ByteBuffer value)
      Sets the address of the specified encoded string to the recognizedLabels() field.

    • set

      public XrSemanticLabelsSupportInfoFB set(int type, long next, long flags, ByteBuffer recognizedLabels)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nflags

      public static long nflags(long struct)
      Unsafe version of flags().

    • nrecognizedLabels

      public static ByteBuffer nrecognizedLabels(long struct)
      Unsafe version of recognizedLabels().

    • nrecognizedLabelsString

      public static String nrecognizedLabelsString(long struct)
      Unsafe version of recognizedLabelsString().

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

    • nflags

      public static void nflags(long struct, long value)
      Unsafe version of flags.

    • nrecognizedLabels

      public static void nrecognizedLabels(long struct, ByteBuffer value)
      Unsafe version of recognizedLabels.

    • validate

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