Package org.lwjgl.openxr

Class XrBoundary2DFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrBoundary2DFB>
org.lwjgl.openxr.XrBoundary2DFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrBoundary2DFB extends org.lwjgl.system.Struct<XrBoundary2DFB> implements org.lwjgl.system.NativeResource
Provides additional context of a spatial entity representing a room.
Description

This structure is used by the GetSpaceBoundary2DFB function to provide the application with the XrVector2f vertices representing the a spatial entity with a boundary.

Valid Usage (Implicit)
See Also

XrVector2f, GetSpaceBoundary2DFB

Layout


 struct XrBoundary2DFB {
     XrStructureType type();
     void const * next();
     uint32_t vertexCapacityInput();
     uint32_t vertexCountOutput();
     XrVector2f * vertices();
 }

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

    • VERTEXCAPACITYINPUT

      public static final int VERTEXCAPACITYINPUT
      The struct member offsets.

    • VERTEXCOUNTOUTPUT

      public static final int VERTEXCOUNTOUTPUT
      The struct member offsets.

    • VERTICES

      public static final int VERTICES
      The struct member offsets.

  • Constructor Details

    • XrBoundary2DFB

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

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

    • vertexCapacityInput

      public int vertexCapacityInput()
      the capacity of the vertices array, in number of vertices, or 0 to indicate a request to retrieve the required capacity.

    • vertexCountOutput

      public int vertexCountOutput()
      the count of XrVector2f written, or the required capacity in the case that vertexCapacityInput is insufficient.

    • vertices

      public @Nullable XrVector2f.Buffer vertices()
      a pointer to an array of XrVector2f, but can be NULL if vertexCapacityInput is 0.

    • type

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

    • type$Default

      public XrBoundary2DFB type$Default()
      Sets the TYPE_BOUNDARY_2D_FB value to the type() field.

    • next

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

    • vertexCapacityInput

      public XrBoundary2DFB vertexCapacityInput(int value)
      Sets the specified value to the vertexCapacityInput() field.

    • vertexCountOutput

      public XrBoundary2DFB vertexCountOutput(int value)
      Sets the specified value to the vertexCountOutput() field.

    • vertices

      public XrBoundary2DFB vertices(@Nullable XrVector2f.Buffer value)
      Sets the address of the specified XrVector2f.Buffer to the vertices() field.

    • set

      public XrBoundary2DFB set(int type, long next, int vertexCapacityInput, int vertexCountOutput, @Nullable XrVector2f.Buffer vertices)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nvertexCapacityInput

      public static int nvertexCapacityInput(long struct)
      Unsafe version of vertexCapacityInput().

    • nvertexCountOutput

      public static int nvertexCountOutput(long struct)
      Unsafe version of vertexCountOutput().

    • nvertices

      public static @Nullable XrVector2f.Buffer nvertices(long struct)
      Unsafe version of vertices().

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

    • nvertexCapacityInput

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

    • nvertexCountOutput

      public static void nvertexCountOutput(long struct, int value)
      Unsafe version of vertexCountOutput.

    • nvertices

      public static void nvertices(long struct, @Nullable XrVector2f.Buffer value)
      Unsafe version of vertices.