Package org.lwjgl.openxr

Class XrSpaceQueryResultsFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrSpaceQueryResultsFB>
org.lwjgl.openxr.XrSpaceQueryResultsFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrSpaceQueryResultsFB extends org.lwjgl.system.Struct<XrSpaceQueryResultsFB> implements org.lwjgl.system.NativeResource
Used to retrieve query results.
Description

The XrSpaceQueryResultsFB structure is used by the RetrieveSpaceQueryResultsFB function to retrieve query results.

Valid Usage (Implicit)
See Also

XrSpaceQueryResultFB, RetrieveSpaceQueryResultsFB

Layout


 struct XrSpaceQueryResultsFB {
     XrStructureType type();
     void * next();
     uint32_t resultCapacityInput();
     uint32_t resultCountOutput();
     XrSpaceQueryResultFB * results();
 }

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

    • RESULTCAPACITYINPUT

      public static final int RESULTCAPACITYINPUT
      The struct member offsets.

    • RESULTCOUNTOUTPUT

      public static final int RESULTCOUNTOUTPUT
      The struct member offsets.

    • RESULTS

      public static final int RESULTS
      The struct member offsets.

  • Constructor Details

    • XrSpaceQueryResultsFB

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

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

    • resultCapacityInput

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

    • resultCountOutput

      public int resultCountOutput()
      an output parameter containing the count of results retrieved, or returns the required capacity in the case that resultCapacityInput is insufficient.

    • results

      public @Nullable XrSpaceQueryResultFB.Buffer results()
      a pointer to an array of results, but can be NULL if resultCapacityInput is 0.

    • type

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

    • type$Default

      public XrSpaceQueryResultsFB type$Default()
      Sets the TYPE_SPACE_QUERY_RESULTS_FB value to the type() field.

    • next

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

    • resultCapacityInput

      public XrSpaceQueryResultsFB resultCapacityInput(int value)
      Sets the specified value to the resultCapacityInput() field.

    • resultCountOutput

      public XrSpaceQueryResultsFB resultCountOutput(int value)
      Sets the specified value to the resultCountOutput() field.

    • results

      public XrSpaceQueryResultsFB results(@Nullable XrSpaceQueryResultFB.Buffer value)
      Sets the address of the specified XrSpaceQueryResultFB.Buffer to the results() field.

    • set

      public XrSpaceQueryResultsFB set(int type, long next, int resultCapacityInput, int resultCountOutput, @Nullable XrSpaceQueryResultFB.Buffer results)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nresultCapacityInput

      public static int nresultCapacityInput(long struct)
      Unsafe version of resultCapacityInput().

    • nresultCountOutput

      public static int nresultCountOutput(long struct)
      Unsafe version of resultCountOutput().

    • nresults

      public static @Nullable XrSpaceQueryResultFB.Buffer nresults(long struct)
      Unsafe version of results().

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

    • nresultCapacityInput

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

    • nresultCountOutput

      public static void nresultCountOutput(long struct, int value)
      Unsafe version of resultCountOutput.

    • nresults

      public static void nresults(long struct, @Nullable XrSpaceQueryResultFB.Buffer value)
      Unsafe version of results.