Package org.lwjgl.openxr

Class XrPlaneDetectorBeginInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrPlaneDetectorBeginInfoEXT>
org.lwjgl.openxr.XrPlaneDetectorBeginInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrPlaneDetectorBeginInfoEXT extends org.lwjgl.system.Struct<XrPlaneDetectorBeginInfoEXT> implements org.lwjgl.system.NativeResource
Describes the information to detect planes.
Valid Usage (Implicit)
See Also

XrExtent3DfEXT, XrPosef, BeginPlaneDetectionEXT

Layout


 struct XrPlaneDetectorBeginInfoEXT {
     XrStructureType type();
     void const * next();
     XrSpace baseSpace();
     XrTime time();
     uint32_t orientationCount();
     XrPlaneDetectorOrientationEXT const * orientations();
     uint32_t semanticTypeCount();
     XrPlaneDetectorSemanticTypeEXT const * semanticTypes();
     uint32_t maxPlanes();
     float minArea();
     XrPosef boundingBoxPose();
     XrExtent3DfEXT boundingBoxExtent();
 }

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

    • BASESPACE

      public static final int BASESPACE
      The struct member offsets.

    • TIME

      public static final int TIME
      The struct member offsets.

    • ORIENTATIONCOUNT

      public static final int ORIENTATIONCOUNT
      The struct member offsets.

    • ORIENTATIONS

      public static final int ORIENTATIONS
      The struct member offsets.

    • SEMANTICTYPECOUNT

      public static final int SEMANTICTYPECOUNT
      The struct member offsets.

    • SEMANTICTYPES

      public static final int SEMANTICTYPES
      The struct member offsets.

    • MAXPLANES

      public static final int MAXPLANES
      The struct member offsets.

    • MINAREA

      public static final int MINAREA
      The struct member offsets.

    • BOUNDINGBOXPOSE

      public static final int BOUNDINGBOXPOSE
      The struct member offsets.

    • BOUNDINGBOXEXTENT

      public static final int BOUNDINGBOXEXTENT
      The struct member offsets.

  • Constructor Details

    • XrPlaneDetectorBeginInfoEXT

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

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

    • baseSpace

      public long baseSpace()
      the XrSpace that the boundingBoxPose is defined in.

    • time

      public long time()
      an XrTime at which to detect the planes.

    • orientationCount

      public int orientationCount()
      the number of elements in the orientations.

    • orientations

      public @Nullable IntBuffer orientations()
      an array of XrPlaneDetectorOrientationEXT. If this field is null no orientation filtering is applied. If any orientations are present only planes with any of the orientation listed are returned.

    • semanticTypeCount

      public int semanticTypeCount()
      the number of elements in the semanticTypes.

    • semanticTypes

      public @Nullable IntBuffer semanticTypes()
      an array of XrPlaneDetectorSemanticTypeEXT. If this field is null no semantic type filtering is applied. If any semantic types are present only planes with matching semantic types are returned.

    • maxPlanes

      public int maxPlanes()
      the maximum number of planes the runtime may return. This number must be larger than 0. If the number is 0 the runtime must return ERROR_VALIDATION_FAILURE.

    • minArea

      public float minArea()
      the minimum area in square meters a plane must have to be returned. A runtime may have a lower limit under which planes are not detected regardless of minArea and silently drop planes lower than the internal minimum.

    • boundingBoxPose

      public XrPosef boundingBoxPose()
      the pose of the center of the bounding box of the volume to use for detection in baseSpace.

    • boundingBoxExtent

      public XrExtent3DfEXT boundingBoxExtent()
      the extent of the bounding box to use for detection. If any part of a plane falls within the bounding box it should be considered for inclusion subject to the other filters. This means that planes may extend beyond the bounding box. A runtime may have an upper limit on the detection range and silently clip the results to that internally.

    • type

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

    • type$Default

      public XrPlaneDetectorBeginInfoEXT type$Default()
      Sets the TYPE_PLANE_DETECTOR_BEGIN_INFO_EXT value to the type() field.

    • next

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

    • baseSpace

      public XrPlaneDetectorBeginInfoEXT baseSpace(XrSpace value)
      Sets the specified value to the baseSpace() field.

    • time

      public XrPlaneDetectorBeginInfoEXT time(long value)
      Sets the specified value to the time() field.

    • orientationCount

      public XrPlaneDetectorBeginInfoEXT orientationCount(int value)
      Sets the specified value to the orientationCount() field.

    • orientations

      public XrPlaneDetectorBeginInfoEXT orientations(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the orientations() field.

    • semanticTypeCount

      public XrPlaneDetectorBeginInfoEXT semanticTypeCount(int value)
      Sets the specified value to the semanticTypeCount() field.

    • semanticTypes

      public XrPlaneDetectorBeginInfoEXT semanticTypes(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the semanticTypes() field.

    • maxPlanes

      public XrPlaneDetectorBeginInfoEXT maxPlanes(int value)
      Sets the specified value to the maxPlanes() field.

    • minArea

      public XrPlaneDetectorBeginInfoEXT minArea(float value)
      Sets the specified value to the minArea() field.

    • boundingBoxPose

      public XrPlaneDetectorBeginInfoEXT boundingBoxPose(XrPosef value)
      Copies the specified XrPosef to the boundingBoxPose() field.

    • boundingBoxPose

      public XrPlaneDetectorBeginInfoEXT boundingBoxPose(Consumer<XrPosef> consumer)
      Passes the boundingBoxPose() field to the specified Consumer.

    • boundingBoxExtent

      public XrPlaneDetectorBeginInfoEXT boundingBoxExtent(XrExtent3DfEXT value)
      Copies the specified XrExtent3DfEXT to the boundingBoxExtent() field.

    • boundingBoxExtent

      public XrPlaneDetectorBeginInfoEXT boundingBoxExtent(Consumer<XrExtent3DfEXT> consumer)
      Passes the boundingBoxExtent() field to the specified Consumer.

    • set

      public XrPlaneDetectorBeginInfoEXT set(int type, long next, XrSpace baseSpace, long time, int orientationCount, @Nullable IntBuffer orientations, int semanticTypeCount, @Nullable IntBuffer semanticTypes, int maxPlanes, float minArea, XrPosef boundingBoxPose, XrExtent3DfEXT boundingBoxExtent)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nbaseSpace

      public static long nbaseSpace(long struct)
      Unsafe version of baseSpace().

    • ntime

      public static long ntime(long struct)
      Unsafe version of time().

    • norientationCount

      public static int norientationCount(long struct)
      Unsafe version of orientationCount().

    • norientations

      public static @Nullable IntBuffer norientations(long struct)
      Unsafe version of orientations.

    • nsemanticTypeCount

      public static int nsemanticTypeCount(long struct)
      Unsafe version of semanticTypeCount().

    • nsemanticTypes

      public static @Nullable IntBuffer nsemanticTypes(long struct)
      Unsafe version of semanticTypes.

    • nmaxPlanes

      public static int nmaxPlanes(long struct)
      Unsafe version of maxPlanes().

    • nminArea

      public static float nminArea(long struct)
      Unsafe version of minArea().

    • nboundingBoxPose

      public static XrPosef nboundingBoxPose(long struct)
      Unsafe version of boundingBoxPose().

    • nboundingBoxExtent

      public static XrExtent3DfEXT nboundingBoxExtent(long struct)
      Unsafe version of boundingBoxExtent().

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

    • nbaseSpace

      public static void nbaseSpace(long struct, XrSpace value)
      Unsafe version of baseSpace.

    • ntime

      public static void ntime(long struct, long value)
      Unsafe version of time.

    • norientationCount

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

    • norientations

      public static void norientations(long struct, @Nullable IntBuffer value)
      Unsafe version of orientations.

    • nsemanticTypeCount

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

    • nsemanticTypes

      public static void nsemanticTypes(long struct, @Nullable IntBuffer value)
      Unsafe version of semanticTypes.

    • nmaxPlanes

      public static void nmaxPlanes(long struct, int value)
      Unsafe version of maxPlanes.

    • nminArea

      public static void nminArea(long struct, float value)
      Unsafe version of minArea.

    • nboundingBoxPose

      public static void nboundingBoxPose(long struct, XrPosef value)
      Unsafe version of boundingBoxPose.

    • nboundingBoxExtent

      public static void nboundingBoxExtent(long struct, XrExtent3DfEXT value)
      Unsafe version of boundingBoxExtent.

    • validate

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