Package org.lwjgl.openxr

Class XrPlaneDetectorLocationEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrPlaneDetectorLocationEXT>
org.lwjgl.openxr.XrPlaneDetectorLocationEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrPlaneDetectorLocationEXT extends org.lwjgl.system.Struct<XrPlaneDetectorLocationEXT> implements org.lwjgl.system.NativeResource
Describes the location of a plane.
Valid Usage (Implicit)
See Also

XrExtent2Df, XrPlaneDetectorLocationsEXT, XrPosef, GetPlaneDetectionsEXT

Layout


 struct XrPlaneDetectorLocationEXT {
     XrStructureType type();
     void * next();
     uint64_t planeId();
     XrSpaceLocationFlags locationFlags();
     XrPosef pose();
     XrExtent2Df extents();
     XrPlaneDetectorOrientationEXT orientation();
     XrPlaneDetectorSemanticTypeEXT semanticType();
     uint32_t polygonBufferCount();
 }

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

    • PLANEID

      public static final int PLANEID
      The struct member offsets.

    • LOCATIONFLAGS

      public static final int LOCATIONFLAGS
      The struct member offsets.

    • POSE

      public static final int POSE
      The struct member offsets.

    • EXTENTS

      public static final int EXTENTS
      The struct member offsets.

    • ORIENTATION

      public static final int ORIENTATION
      The struct member offsets.

    • SEMANTICTYPE

      public static final int SEMANTICTYPE
      The struct member offsets.

    • POLYGONBUFFERCOUNT

      public static final int POLYGONBUFFERCOUNT
      The struct member offsets.

  • Constructor Details

    • XrPlaneDetectorLocationEXT

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

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

    • planeId

      public long planeId()
      a uint64_t unique identifier of the plane. The planeId should remain the same for the duration of the XrPlaneDetectorEXT handle for a physical plane. A runtime on occasion may assign a different id to the same physical plane, for example when several planes merge into one plane. planeId must remain valid until the next call to BeginPlaneDetectionEXT or DestroyPlaneDetectorEXT. This id is used by GetPlanePolygonBufferEXT.

    • locationFlags

      public long locationFlags()
      a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data. If none of the bits are set, no other fields in this structure should be considered to be valid or meaningful.

    • pose

      public XrPosef pose()
      an XrPosef defining the position and orientation of the origin of a plane within the reference frame of the corresponding XrPlaneDetectorGetInfoEXT::baseSpace.

    • extents

      public XrExtent2Df extents()
      the extent of the plane along the x-axis (extents.width) and y-axis (extents.height) centered on the pose.

    • orientation

      public int orientation()
      the detected orientation of the plane.

    • semanticType

      public int semanticType()
      semanticType XrPlaneDetectorSemanticTypeEXT type of the plane.

    • polygonBufferCount

      public int polygonBufferCount()
      the number of polygon buffers associated with this plane. If this is zero no polygon buffer was generated. The first polygon buffer is always the outside contour. If contours are requested with PLANE_DETECTOR_ENABLE_CONTOUR_BIT_EXT this value must always be at least 1.

    • type

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

    • type$Default

      public XrPlaneDetectorLocationEXT type$Default()
      Sets the TYPE_PLANE_DETECTOR_LOCATION_EXT value to the type() field.

    • next

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

    • planeId

      public XrPlaneDetectorLocationEXT planeId(long value)
      Sets the specified value to the planeId() field.

    • locationFlags

      public XrPlaneDetectorLocationEXT locationFlags(long value)
      Sets the specified value to the locationFlags() field.

    • pose

      public XrPlaneDetectorLocationEXT pose(XrPosef value)
      Copies the specified XrPosef to the pose() field.

    • pose

      public XrPlaneDetectorLocationEXT pose(Consumer<XrPosef> consumer)
      Passes the pose() field to the specified Consumer.

    • extents

      public XrPlaneDetectorLocationEXT extents(XrExtent2Df value)
      Copies the specified XrExtent2Df to the extents() field.

    • extents

      public XrPlaneDetectorLocationEXT extents(Consumer<XrExtent2Df> consumer)
      Passes the extents() field to the specified Consumer.

    • orientation

      public XrPlaneDetectorLocationEXT orientation(int value)
      Sets the specified value to the orientation() field.

    • semanticType

      public XrPlaneDetectorLocationEXT semanticType(int value)
      Sets the specified value to the semanticType() field.

    • polygonBufferCount

      public XrPlaneDetectorLocationEXT polygonBufferCount(int value)
      Sets the specified value to the polygonBufferCount() field.

    • set

      public XrPlaneDetectorLocationEXT set(int type, long next, long planeId, long locationFlags, XrPosef pose, XrExtent2Df extents, int orientation, int semanticType, int polygonBufferCount)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nplaneId

      public static long nplaneId(long struct)
      Unsafe version of planeId().

    • nlocationFlags

      public static long nlocationFlags(long struct)
      Unsafe version of locationFlags().

    • npose

      public static XrPosef npose(long struct)
      Unsafe version of pose().

    • nextents

      public static XrExtent2Df nextents(long struct)
      Unsafe version of extents().

    • norientation

      public static int norientation(long struct)
      Unsafe version of orientation().

    • nsemanticType

      public static int nsemanticType(long struct)
      Unsafe version of semanticType().

    • npolygonBufferCount

      public static int npolygonBufferCount(long struct)
      Unsafe version of polygonBufferCount().

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

    • nplaneId

      public static void nplaneId(long struct, long value)
      Unsafe version of planeId.

    • nlocationFlags

      public static void nlocationFlags(long struct, long value)
      Unsafe version of locationFlags.

    • npose

      public static void npose(long struct, XrPosef value)
      Unsafe version of pose.

    • nextents

      public static void nextents(long struct, XrExtent2Df value)
      Unsafe version of extents.

    • norientation

      public static void norientation(long struct, int value)
      Unsafe version of orientation.

    • nsemanticType

      public static void nsemanticType(long struct, int value)
      Unsafe version of semanticType.

    • npolygonBufferCount

      public static void npolygonBufferCount(long struct, int value)
      Unsafe version of polygonBufferCount.