Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSpaceQueryResultsFB

extends Struct<XrSpaceQueryResultsFB>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
NEXT

The struct member offsets.

public static final int
RESULTCAPACITYINPUT

The struct member offsets.

public static final int
RESULTCOUNTOUTPUT

The struct member offsets.

public static final int
RESULTS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrSpaceQueryResultsFB(long address, ByteBuffer container)

public
XrSpaceQueryResultsFB(ByteBuffer container)

Creates a XrSpaceQueryResultsFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrSpaceQueryResultsFB
calloc()

Returns a new XrSpaceQueryResultsFB instance allocated with memCalloc.

public static XrSpaceQueryResultsFB.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated with memCalloc.

public static XrSpaceQueryResultsFB
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSpaceQueryResultsFB instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static XrSpaceQueryResultsFB.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected XrSpaceQueryResultsFB
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrSpaceQueryResultsFB
create()

Returns a new XrSpaceQueryResultsFB instance allocated with BufferUtils.

public static XrSpaceQueryResultsFB
create(long address)

Returns a new XrSpaceQueryResultsFB instance for the specified memory address.

public static XrSpaceQueryResultsFB.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated with BufferUtils.

public static XrSpaceQueryResultsFB.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a XrSpaceQueryResultsFB.Buffer instance at the specified memory.

public static XrSpaceQueryResultsFB
createSafe(long address)

Like create, but returns null if address is NULL.

public static XrSpaceQueryResultsFB.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static XrSpaceQueryResultsFB
malloc()

Returns a new XrSpaceQueryResultsFB instance allocated with memAlloc.

public static XrSpaceQueryResultsFB.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated with memAlloc.

public static XrSpaceQueryResultsFB
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSpaceQueryResultsFB instance allocated on the specified MemoryStack.

public static XrSpaceQueryResultsFB.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated on the specified MemoryStack.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrSpaceQueryResultsFB
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
nresultCapacityInput(long struct)

Unsafe version of resultCapacityInput.

public static void
nresultCapacityInput(long struct, int value)

Sets the specified value to the resultCapacityInput field of the specified struct.

public static int
nresultCountOutput(long struct)

Unsafe version of resultCountOutput.

public static void
nresultCountOutput(long struct, int value)

Unsafe version of resultCountOutput.

public static XrSpaceQueryResultFB.Buffer
nresults(long struct)

Unsafe version of results.

public static void
nresults(long struct, XrSpaceQueryResultFB.Buffer value)

Unsafe version of results.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public int
resultCapacityInput()

the capacity of the results array, or 0 to indicate a request to retrieve the required capacity.

public XrSpaceQueryResultsFB
resultCapacityInput(int value)

Sets the specified value to the resultCapacityInput field.

public int
resultCountOutput()

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

public XrSpaceQueryResultsFB
resultCountOutput(int value)

Sets the specified value to the resultCountOutput field.

public XrSpaceQueryResultFB.Buffer
results()

a pointer to an array of results, but can be NULL if resultCapacityInput is 0.

public XrSpaceQueryResultsFB
results(XrSpaceQueryResultFB.Buffer value)

Sets the address of the specified XrSpaceQueryResultFB.Buffer to the results field.

public XrSpaceQueryResultsFB
set(int type, long next, int resultCapacityInput, int resultCountOutput, XrSpaceQueryResultFB.Buffer results)

Initializes this struct with the specified values.

public XrSpaceQueryResultsFB

Returns:

this struct
set
(XrSpaceQueryResultsFB
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

the XrStructureType of this structure.

public XrSpaceQueryResultsFB
type(int value)

Sets the specified value to the type field.

public XrSpaceQueryResultsFB
type$Default()

Sets the TYPE_SPACE_QUERY_RESULTS_FB value to the type field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

NEXTback to summary
public static final int NEXT

The struct member offsets.

RESULTCAPACITYINPUTback to summary
public static final int RESULTCAPACITYINPUT

The struct member offsets.

RESULTCOUNTOUTPUTback to summary
public static final int RESULTCOUNTOUTPUT

The struct member offsets.

RESULTSback to summary
public static final int RESULTS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrSpaceQueryResultsFBback to summary
protected XrSpaceQueryResultsFB(long address, ByteBuffer container)
XrSpaceQueryResultsFBback to summary
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 Detail

callocback to summary
public static XrSpaceQueryResultsFB calloc()

Returns a new XrSpaceQueryResultsFB instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static XrSpaceQueryResultsFB.Buffer calloc(int capacity)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSpaceQueryResultsFB calloc(MemoryStack stack)

Returns a new XrSpaceQueryResultsFB instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrSpaceQueryResultsFB.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrSpaceQueryResultsFB create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrSpaceQueryResultsFB create()

Returns a new XrSpaceQueryResultsFB instance allocated with BufferUtils.

createback to summary
public static XrSpaceQueryResultsFB create(long address)

Returns a new XrSpaceQueryResultsFB instance for the specified memory address.

createback to summary
public static XrSpaceQueryResultsFB.Buffer create(int capacity)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrSpaceQueryResultsFB.Buffer create(long address, int capacity)

Create a XrSpaceQueryResultsFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSpaceQueryResultsFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrSpaceQueryResultsFB.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrSpaceQueryResultsFB malloc()

Returns a new XrSpaceQueryResultsFB instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static XrSpaceQueryResultsFB.Buffer malloc(int capacity)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSpaceQueryResultsFB malloc(MemoryStack stack)

Returns a new XrSpaceQueryResultsFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrSpaceQueryResultsFB.Buffer malloc(int capacity, MemoryStack stack)

Returns a new XrSpaceQueryResultsFB.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
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.

Annotations
@NativeType:void *
nextback to summary
public XrSpaceQueryResultsFB next(long value)

Sets the specified value to the next field.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nresultCapacityInputback to summary
public static int nresultCapacityInput(long struct)

Unsafe version of resultCapacityInput.

nresultCapacityInputback to summary
public static void nresultCapacityInput(long struct, int value)

Sets the specified value to the resultCapacityInput field of the specified struct.

nresultCountOutputback to summary
public static int nresultCountOutput(long struct)

Unsafe version of resultCountOutput.

nresultCountOutputback to summary
public static void nresultCountOutput(long struct, int value)

Unsafe version of resultCountOutput.

nresultsback to summary
public static XrSpaceQueryResultFB.Buffer nresults(long struct)

Unsafe version of results.

Annotations
@Nullable
nresultsback to summary
public static void nresults(long struct, XrSpaceQueryResultFB.Buffer value)

Unsafe version of results.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

resultCapacityInputback to summary
public int resultCapacityInput()

the capacity of the results array, or 0 to indicate a request to retrieve the required capacity.

Annotations
@NativeType:uint32_t
resultCapacityInputback to summary
public XrSpaceQueryResultsFB resultCapacityInput(int value)

Sets the specified value to the resultCapacityInput field.

resultCountOutputback to summary
public int resultCountOutput()

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

Annotations
@NativeType:uint32_t
resultCountOutputback to summary
public XrSpaceQueryResultsFB resultCountOutput(int value)

Sets the specified value to the resultCountOutput field.

resultsback to summary
public XrSpaceQueryResultFB.Buffer results()

a pointer to an array of results, but can be NULL if resultCapacityInput is 0.

Annotations
@Nullable
@NativeType:XrSpaceQueryResultFB *
resultsback to summary
public XrSpaceQueryResultsFB results(XrSpaceQueryResultFB.Buffer value)

Sets the address of the specified XrSpaceQueryResultFB.Buffer to the results field.

setback to summary
public XrSpaceQueryResultsFB set(int type, long next, int resultCapacityInput, int resultCountOutput, XrSpaceQueryResultFB.Buffer results)

Initializes this struct with the specified values.

setback to summary
public XrSpaceQueryResultsFB set(XrSpaceQueryResultsFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSpaceQueryResultsFB

the source struct

Returns:XrSpaceQueryResultsFB

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSpaceQueryResultsFB type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrSpaceQueryResultsFB type$Default()

Sets the TYPE_SPACE_QUERY_RESULTS_FB value to the type field.

org.lwjgl.openxr back to summary

public Class XrSpaceQueryResultsFB.Buffer

extends StructBuffer<XrSpaceQueryResultsFB, XrSpaceQueryResultsFB.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSpaceQueryResultsFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSpaceQueryResultsFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSpaceQueryResultsFB.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected XrSpaceQueryResultsFB
public long

Returns:

the value of the XrSpaceQueryResultsFB#next field.
next
()

public XrSpaceQueryResultsFB.Buffer
next(long value)

Sets the specified value to the XrSpaceQueryResultsFB#next field.

public int
public XrSpaceQueryResultsFB.Buffer
resultCapacityInput(int value)

Sets the specified value to the XrSpaceQueryResultsFB#resultCapacityInput field.

public int
public XrSpaceQueryResultsFB.Buffer
resultCountOutput(int value)

Sets the specified value to the XrSpaceQueryResultsFB#resultCountOutput field.

public XrSpaceQueryResultFB.Buffer

Returns:

a XrSpaceQueryResultFB.Buffer view of the struct array pointed to by the XrSpaceQueryResultsFB#results field.
results
()

public XrSpaceQueryResultsFB.Buffer
protected XrSpaceQueryResultsFB.Buffer
public int

Returns:

the value of the XrSpaceQueryResultsFB#type field.
type
()

public XrSpaceQueryResultsFB.Buffer
type(int value)

Sets the specified value to the XrSpaceQueryResultsFB#type field.

public XrSpaceQueryResultsFB.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSpaceQueryResultsFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSpaceQueryResultsFB.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrSpaceQueryResultsFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected XrSpaceQueryResultsFB getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrSpaceQueryResultsFB#next field.

Annotations
@NativeType:void *
nextback to summary
public XrSpaceQueryResultsFB.Buffer next(long value)

Sets the specified value to the XrSpaceQueryResultsFB#next field.

resultCapacityInputback to summary
public int resultCapacityInput()
Returns:int

the value of the XrSpaceQueryResultsFB#resultCapacityInput field.

Annotations
@NativeType:uint32_t
resultCapacityInputback to summary
public XrSpaceQueryResultsFB.Buffer resultCapacityInput(int value)

Sets the specified value to the XrSpaceQueryResultsFB#resultCapacityInput field.

resultCountOutputback to summary
public int resultCountOutput()
Returns:int

the value of the XrSpaceQueryResultsFB#resultCountOutput field.

Annotations
@NativeType:uint32_t
resultCountOutputback to summary
public XrSpaceQueryResultsFB.Buffer resultCountOutput(int value)

Sets the specified value to the XrSpaceQueryResultsFB#resultCountOutput field.

resultsback to summary
public XrSpaceQueryResultFB.Buffer results()
Returns:XrSpaceQueryResultFB.Buffer

a XrSpaceQueryResultFB.Buffer view of the struct array pointed to by the XrSpaceQueryResultsFB#results field.

Annotations
@Nullable
@NativeType:XrSpaceQueryResultFB *
resultsback to summary
public XrSpaceQueryResultsFB.Buffer results(XrSpaceQueryResultFB.Buffer value)

Sets the address of the specified XrSpaceQueryResultFB.Buffer to the XrSpaceQueryResultsFB#results field.

selfback to summary
protected XrSpaceQueryResultsFB.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrSpaceQueryResultsFB#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSpaceQueryResultsFB.Buffer type(int value)

Sets the specified value to the XrSpaceQueryResultsFB#type field.

type$Defaultback to summary
public XrSpaceQueryResultsFB.Buffer type$Default()

Sets the TYPE_SPACE_QUERY_RESULTS_FB value to the XrSpaceQueryResultsFB#type field.