Package org.lwjgl.openxr

Class XrSpaceContainerFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSpaceContainerFB>
org.lwjgl.openxr.XrSpaceContainerFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSpaceContainerFB extends org.lwjgl.system.Struct<XrSpaceContainerFB> implements org.lwjgl.system.NativeResource
Represents a collection of other spaces, represented by UUIDs, contained by this space.
Description

The XrSpaceContainerFB structure can be used by an application to perform the two calls required to obtain information about which spatial entities are contained by a specified spatial entity.

Valid Usage (Implicit)
See Also

XrUuidEXT, GetSpaceContainerFB

Layout


 struct XrSpaceContainerFB {
     XrStructureType type();
     void const * next();
     uint32_t uuidCapacityInput();
     uint32_t uuidCountOutput();
     XrUuidEXT * uuids();
 }

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

    • UUIDCAPACITYINPUT

      public static final int UUIDCAPACITYINPUT
      The struct member offsets.

    • UUIDCOUNTOUTPUT

      public static final int UUIDCOUNTOUTPUT
      The struct member offsets.

    • UUIDS

      public static final int UUIDS
      The struct member offsets.

  • Constructor Details

    • XrSpaceContainerFB

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

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

    • uuidCapacityInput

      public int uuidCapacityInput()
      the capacity of the uuids array, or 0 to indicate a request to retrieve the required capacity.

    • uuidCountOutput

      public int uuidCountOutput()
      an output parameter which will hold the number of UUIDs included in the output list, or the required capacity in the case that uuidCapacityInput is insufficient

    • uuids

      public @Nullable XrUuidEXT.Buffer uuids()
      an output parameter which will hold a list of space UUIDs contained by the space to which the component is attached.

    • type

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

    • type$Default

      public XrSpaceContainerFB type$Default()
      Sets the TYPE_SPACE_CONTAINER_FB value to the type() field.

    • next

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

    • uuidCapacityInput

      public XrSpaceContainerFB uuidCapacityInput(int value)
      Sets the specified value to the uuidCapacityInput() field.

    • uuidCountOutput

      public XrSpaceContainerFB uuidCountOutput(int value)
      Sets the specified value to the uuidCountOutput() field.

    • uuids

      public XrSpaceContainerFB uuids(@Nullable XrUuidEXT.Buffer value)
      Sets the address of the specified XrUuidEXT.Buffer to the uuids() field.

    • set

      public XrSpaceContainerFB set(int type, long next, int uuidCapacityInput, int uuidCountOutput, @Nullable XrUuidEXT.Buffer uuids)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nuuidCapacityInput

      public static int nuuidCapacityInput(long struct)
      Unsafe version of uuidCapacityInput().

    • nuuidCountOutput

      public static int nuuidCountOutput(long struct)
      Unsafe version of uuidCountOutput().

    • nuuids

      public static @Nullable XrUuidEXT.Buffer nuuids(long struct)
      Unsafe version of uuids().

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

    • nuuidCapacityInput

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

    • nuuidCountOutput

      public static void nuuidCountOutput(long struct, int value)
      Unsafe version of uuidCountOutput.

    • nuuids

      public static void nuuids(long struct, @Nullable XrUuidEXT.Buffer value)
      Unsafe version of uuids.