Package org.lwjgl.openxr

Class XrSceneMarkersMSFT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSceneMarkersMSFT>
org.lwjgl.openxr.XrSceneMarkersMSFT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSceneMarkersMSFT extends org.lwjgl.system.Struct<XrSceneMarkersMSFT> implements org.lwjgl.system.NativeResource
Provide an array to retrieve scene marker properties.
Description

Once the application creates an XrSceneMSFT after a successful scene compute, it can retrieve the scene markers' properties by chaining XrSceneMarkersMSFT structure to the next pointer of XrSceneComponentsGetInfoMSFT when calling GetSceneComponentsMSFT.

GetSceneComponentsMSFT follows the two-call idiom for filling the XrSceneComponentsMSFT structure to which an XrSceneMarkersMSFT structure can be chained.

The input sceneMarkerCapacityInput must be equal to or greater than the corresponding XrSceneComponentsMSFT::componentCapacityInput, otherwise the runtime must return ERROR_SIZE_INSUFFICIENT.

The actual count of elements returned in the array sceneMarkers is consistent with the extended XrSceneComponentsMSFT structure and returned in XrSceneComponentsMSFT::componentCountOutput.

Valid Usage (Implicit)
See Also

XrSceneMarkerMSFT, GetSceneComponentsMSFT

Layout


 struct XrSceneMarkersMSFT {
     XrStructureType type();
     void const * next();
     uint32_t sceneMarkerCapacityInput();
     XrSceneMarkerMSFT * sceneMarkers();
 }

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

    • SCENEMARKERCAPACITYINPUT

      public static final int SCENEMARKERCAPACITYINPUT
      The struct member offsets.

    • SCENEMARKERS

      public static final int SCENEMARKERS
      The struct member offsets.

  • Constructor Details

    • XrSceneMarkersMSFT

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

    • 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. See also: XrSceneComponentsMSFT, XrSceneMarkerQRCodesMSFT

    • sceneMarkerCapacityInput

      public int sceneMarkerCapacityInput()
      a uint32_t indicating the capacity of elements in the sceneMarkers array.

    • sceneMarkers

      public @Nullable XrSceneMarkerMSFT.Buffer sceneMarkers()
      an array of XrSceneMarkerMSFT to fill with the properties of the markers.

    • type

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

    • type$Default

      public XrSceneMarkersMSFT type$Default()
      Sets the TYPE_SCENE_MARKERS_MSFT value to the type() field.

    • next

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

    • sceneMarkerCapacityInput

      public XrSceneMarkersMSFT sceneMarkerCapacityInput(int value)
      Sets the specified value to the sceneMarkerCapacityInput() field.

    • sceneMarkers

      public XrSceneMarkersMSFT sceneMarkers(@Nullable XrSceneMarkerMSFT.Buffer value)
      Sets the address of the specified XrSceneMarkerMSFT.Buffer to the sceneMarkers() field.

    • set

      public XrSceneMarkersMSFT set(int type, long next, int sceneMarkerCapacityInput, @Nullable XrSceneMarkerMSFT.Buffer sceneMarkers)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nsceneMarkerCapacityInput

      public static int nsceneMarkerCapacityInput(long struct)
      Unsafe version of sceneMarkerCapacityInput().

    • nsceneMarkers

      public static @Nullable XrSceneMarkerMSFT.Buffer nsceneMarkers(long struct)
      Unsafe version of sceneMarkers().

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

    • nsceneMarkerCapacityInput

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

    • nsceneMarkers

      public static void nsceneMarkers(long struct, @Nullable XrSceneMarkerMSFT.Buffer value)
      Unsafe version of sceneMarkers.