Package org.lwjgl.openxr

Class XrLocalizationMapML

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrLocalizationMapML>
org.lwjgl.openxr.XrLocalizationMapML
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrLocalizationMapML extends org.lwjgl.system.Struct<XrLocalizationMapML> implements org.lwjgl.system.NativeResource
Information on the localization map.
Valid Usage (Implicit)
See Also

XrEventDataLocalizationChangedML, XrUuidEXT, EnableLocalizationEventsML, QueryLocalizationMapsML

Layout


 struct XrLocalizationMapML {
     XrStructureType type();
     void * next();
     char name()[XR_MAX_LOCALIZATION_MAP_NAME_LENGTH_ML];
     XrUuidEXT mapUuid();
     XrLocalizationMapTypeML mapType();
 }

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

    • NAME

      public static final int NAME
      The struct member offsets.

    • MAPUUID

      public static final int MAPUUID
      The struct member offsets.

    • MAPTYPE

      public static final int MAPTYPE
      The struct member offsets.

  • Constructor Details

    • XrLocalizationMapML

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

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

    • name

      public ByteBuffer name()
      a human readable name of the localization map, as a null terminated UTF-8 string. This name is set outside of this extension.

    • nameString

      public String nameString()
      a human readable name of the localization map, as a null terminated UTF-8 string. This name is set outside of this extension.

    • mapUuid

      public XrUuidEXT mapUuid()
      the XrUuidEXT of the localization map.

    • mapType

      public int mapType()
      the XrLocalizationMapTypeML of the map.

    • type

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

    • type$Default

      public XrLocalizationMapML type$Default()
      Sets the TYPE_LOCALIZATION_MAP_ML value to the type() field.

    • next

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

    • name

      public XrLocalizationMapML name(ByteBuffer value)
      Copies the specified encoded string to the name() field.

    • mapUuid

      public XrLocalizationMapML mapUuid(XrUuidEXT value)
      Copies the specified XrUuidEXT to the mapUuid() field.

    • mapUuid

      public XrLocalizationMapML mapUuid(Consumer<XrUuidEXT> consumer)
      Passes the mapUuid() field to the specified Consumer.

    • mapType

      public XrLocalizationMapML mapType(int value)
      Sets the specified value to the mapType() field.

    • set

      public XrLocalizationMapML set(int type, long next, ByteBuffer name, XrUuidEXT mapUuid, int mapType)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nname

      public static ByteBuffer nname(long struct)
      Unsafe version of name().

    • nnameString

      public static String nnameString(long struct)
      Unsafe version of nameString().

    • nmapUuid

      public static XrUuidEXT nmapUuid(long struct)
      Unsafe version of mapUuid().

    • nmapType

      public static int nmapType(long struct)
      Unsafe version of mapType().

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

    • nname

      public static void nname(long struct, ByteBuffer value)
      Unsafe version of name.

    • nmapUuid

      public static void nmapUuid(long struct, XrUuidEXT value)
      Unsafe version of mapUuid.

    • nmapType

      public static void nmapType(long struct, int value)
      Unsafe version of mapType.