Package org.lwjgl.openxr

Class XrSceneMarkerMSFT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSceneMarkerMSFT>
org.lwjgl.openxr.XrSceneMarkerMSFT
All Implemented Interfaces:
org.lwjgl.system.Pointer
public class XrSceneMarkerMSFT extends org.lwjgl.system.Struct<XrSceneMarkerMSFT>
The properties of a scene marker.
Description

The XrSceneMarkerMSFT structure is an element in the array of XrSceneMarkersMSFT::sceneMarkers.

Refer to the QR code convention for an example of marker’s center and size in the context of a QR code.

When the runtime updates the location or properties of an observed marker, the runtime must set the XrSceneMarkerMSFT::lastSeenTime to the new timestamp of the update.

When the runtime cannot observe a previously observed XrSceneMarkerMSFT, the runtime must keep the previous lastSeenTime for the marker. Hence, the application can use the lastSeenTime to know how fresh the tracking information is for a given marker.

The center and size are measured in meters, relative to the XrPosef of the marker for the visual bound of the marker in XY plane, regardless of the marker type.

Valid Usage (Implicit)
See Also

XrExtent2Df, XrOffset2Df, XrSceneMarkersMSFT

Layout


 struct XrSceneMarkerMSFT {
     XrSceneMarkerTypeMSFT markerType();
     XrTime lastSeenTime();
     XrOffset2Df center();
     XrExtent2Df size();
 }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    XrSceneMarkerMSFT.Buffer
    An array of XrSceneMarkerMSFT structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    org.lwjgl.system.Pointer.Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNOF
    The struct alignment in bytes.
    static final int
    CENTER
    The struct member offsets.
    static final int
    LASTSEENTIME
    The struct member offsets.
    static final int
    MARKERTYPE
    The struct member offsets.
    static final int
    SIZE
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.

    Fields inherited from interface org.lwjgl.system.Pointer

    BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    XrSceneMarkerMSFT(ByteBuffer container)
    Creates a XrSceneMarkerMSFT instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    XrOffset2Df
    center()
    an XrOffset2Df structure representing the location of the center of the axis-aligned bounding box of the marker in the XY plane of the marker’s coordinate system.
    static XrSceneMarkerMSFT
    create(long address)
    Returns a new XrSceneMarkerMSFT instance for the specified memory address.
    static XrSceneMarkerMSFT.Buffer
    create(long address, int capacity)
    Create a XrSceneMarkerMSFT.Buffer instance at the specified memory.
    static @Nullable XrSceneMarkerMSFT
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable XrSceneMarkerMSFT.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    long
    lastSeenTime()
    an XrTime indicating when the marker was seen last.
    int
    markerType()
    an XrSceneMarkerTypeMSFT indicating the type of the marker.
    static XrOffset2Df
    ncenter(long struct)
    Unsafe version of center().
    static long
    nlastSeenTime(long struct)
    Unsafe version of lastSeenTime().
    static int
    nmarkerType(long struct)
    Unsafe version of markerType().
    static XrExtent2Df
    nsize(long struct)
    Unsafe version of size().
    XrExtent2Df
    size()
    an XrExtent2Df structure representing the width and height of the axis-aligned bounding box of the marker in the XY plane of the marker’s coordinate system.
    int
    sizeof()
     

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    Methods inherited from class org.lwjgl.system.Pointer.Default

    address, equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • MARKERTYPE

      public static final int MARKERTYPE
      The struct member offsets.

    • LASTSEENTIME

      public static final int LASTSEENTIME
      The struct member offsets.

    • CENTER

      public static final int CENTER
      The struct member offsets.

    • SIZE

      public static final int SIZE
      The struct member offsets.

  • Constructor Details

    • XrSceneMarkerMSFT

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

    • markerType

      public int markerType()
      an XrSceneMarkerTypeMSFT indicating the type of the marker.

    • lastSeenTime

      public long lastSeenTime()
      an XrTime indicating when the marker was seen last.

    • center

      public XrOffset2Df center()
      an XrOffset2Df structure representing the location of the center of the axis-aligned bounding box of the marker in the XY plane of the marker’s coordinate system.

    • size

      public XrExtent2Df size()
      an XrExtent2Df structure representing the width and height of the axis-aligned bounding box of the marker in the XY plane of the marker’s coordinate system.

    • create

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

    • createSafe

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

    • create

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

    • createSafe

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

    • nmarkerType

      public static int nmarkerType(long struct)
      Unsafe version of markerType().

    • nlastSeenTime

      public static long nlastSeenTime(long struct)
      Unsafe version of lastSeenTime().

    • ncenter

      public static XrOffset2Df ncenter(long struct)
      Unsafe version of center().

    • nsize

      public static XrExtent2Df nsize(long struct)
      Unsafe version of size().