Package org.lwjgl.openxr

Class XrSpaceQueryInfoFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpaceQueryInfoFB>

org.lwjgl.openxr.XrSpaceQueryInfoFB

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrSpaceQueryInfoFB
extends org.lwjgl.system.Struct<XrSpaceQueryInfoFB>
implements org.lwjgl.system.NativeResource

Query for entities and perform an action on any results.

Description

May be used to query for spaces and perform a specific action on the spaces returned. The available actions are enumerated in XrSpaceQueryActionFB. The filter info provided to the filter member of the struct is used as an inclusive filter. The filter info provided to the excludeFilter member of the structure is used to exclude spaces from the results returned from the filter. All spaces that match the criteria in filter, and that do not match the criteria in excludeFilter, must be included in the results returned. This is to allow for a more selective style query.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_query extension must be enabled prior to using XrSpaceQueryInfoFB
• type must be TYPE_SPACE_QUERY_INFO_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• queryAction must be a valid XrSpaceQueryActionFB value
• If filter is not NULL, filter must be a pointer to a valid XrSpaceFilterInfoBaseHeaderFB-based structure. See also: XrSpaceComponentFilterInfoFB, XrSpaceUuidFilterInfoFB
• If excludeFilter is not NULL, excludeFilter must be a pointer to a valid XrSpaceFilterInfoBaseHeaderFB-based structure. See also: XrSpaceComponentFilterInfoFB, XrSpaceUuidFilterInfoFB

See Also

XrSpaceFilterInfoBaseHeaderFB, XrSpaceQueryInfoBaseHeaderFB

Layout

 struct XrSpaceQueryInfoFB {
     XrStructureType type();
     void const * next();
     XrSpaceQueryActionFB queryAction();
     uint32_t maxResultCount();
     XrDuration timeout();
     XrSpaceFilterInfoBaseHeaderFB const * filter();
     XrSpaceFilterInfoBaseHeaderFB const * excludeFilter();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpaceQueryInfoFB.Buffer	An array of XrSpaceQueryInfoFB structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EXCLUDEFILTER	The struct member offsets.
static final int	FILTER	The struct member offsets.
static final int	MAXRESULTCOUNT	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	QUERYACTION	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TIMEOUT	The struct member offsets.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrSpaceQueryInfoFB(ByteBuffer container)	Creates a XrSpaceQueryInfoFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSpaceQueryInfoFB	calloc()	Returns a new XrSpaceQueryInfoFB instance allocated with memCalloc.
static XrSpaceQueryInfoFB.Buffer	calloc(int capacity)	Returns a new XrSpaceQueryInfoFB.Buffer instance allocated with memCalloc.
static XrSpaceQueryInfoFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceQueryInfoFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpaceQueryInfoFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceQueryInfoFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpaceQueryInfoFB	create()	Returns a new XrSpaceQueryInfoFB instance allocated with BufferUtils.
static XrSpaceQueryInfoFB.Buffer	create(int capacity)	Returns a new XrSpaceQueryInfoFB.Buffer instance allocated with BufferUtils.
static XrSpaceQueryInfoFB	create(long address)	Returns a new XrSpaceQueryInfoFB instance for the specified memory address.
static XrSpaceQueryInfoFB.Buffer	create(long address, int capacity)	Create a XrSpaceQueryInfoFB.Buffer instance at the specified memory.
static XrSpaceQueryInfoFB	create(XrSpaceQueryInfoBaseHeaderFB value)	Downcasts the specified XrSpaceQueryInfoBaseHeaderFB instance to XrSpaceQueryInfoFB.
static XrSpaceQueryInfoFB.Buffer	create(XrSpaceQueryInfoBaseHeaderFB.Buffer value)	Downcasts the specified XrSpaceQueryInfoBaseHeaderFB.Buffer instance to XrSpaceQueryInfoFB.Buffer.
static @Nullable XrSpaceQueryInfoFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpaceQueryInfoFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
@Nullable XrSpaceFilterInfoBaseHeaderFB	excludeFilter()	NULL or a pointer to a valid structure based on XrSpaceFilterInfoBaseHeaderFB.
XrSpaceQueryInfoFB	excludeFilter(@Nullable XrSpaceFilterInfoBaseHeaderFB value)	Sets the address of the specified XrSpaceFilterInfoBaseHeaderFB to the excludeFilter() field.
@Nullable XrSpaceFilterInfoBaseHeaderFB	filter()	NULL or a pointer to a valid structure based on XrSpaceFilterInfoBaseHeaderFB.
XrSpaceQueryInfoFB	filter(@Nullable XrSpaceFilterInfoBaseHeaderFB value)	Sets the address of the specified XrSpaceFilterInfoBaseHeaderFB to the filter() field.
static XrSpaceQueryInfoFB	malloc()	Returns a new XrSpaceQueryInfoFB instance allocated with memAlloc.
static XrSpaceQueryInfoFB.Buffer	malloc(int capacity)	Returns a new XrSpaceQueryInfoFB.Buffer instance allocated with memAlloc.
static XrSpaceQueryInfoFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceQueryInfoFB.Buffer instance allocated on the specified MemoryStack.
static XrSpaceQueryInfoFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceQueryInfoFB instance allocated on the specified MemoryStack.
int	maxResultCount()	the maximum number of entities to be found.
XrSpaceQueryInfoFB	maxResultCount(int value)	Sets the specified value to the maxResultCount() field.
static @Nullable XrSpaceFilterInfoBaseHeaderFB	nexcludeFilter(long struct)	Unsafe version of excludeFilter().
static void	nexcludeFilter(long struct, @Nullable XrSpaceFilterInfoBaseHeaderFB value)	Unsafe version of excludeFilter.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpaceQueryInfoFB	next(long value)	Sets the specified value to the next() field.
static @Nullable XrSpaceFilterInfoBaseHeaderFB	nfilter(long struct)	Unsafe version of filter().
static void	nfilter(long struct, @Nullable XrSpaceFilterInfoBaseHeaderFB value)	Unsafe version of filter.
static int	nmaxResultCount(long struct)	Unsafe version of maxResultCount().
static void	nmaxResultCount(long struct, int value)	Unsafe version of maxResultCount.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nqueryAction(long struct)	Unsafe version of queryAction().
static void	nqueryAction(long struct, int value)	Unsafe version of queryAction.
static long	ntimeout(long struct)	Unsafe version of timeout().
static void	ntimeout(long struct, long value)	Unsafe version of timeout.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	queryAction()	the type of query to perform.
XrSpaceQueryInfoFB	queryAction(int value)	Sets the specified value to the queryAction() field.
XrSpaceQueryInfoFB	set(int type, long next, int queryAction, int maxResultCount, long timeout, @Nullable XrSpaceFilterInfoBaseHeaderFB filter, @Nullable XrSpaceFilterInfoBaseHeaderFB excludeFilter)	Initializes this struct with the specified values.
XrSpaceQueryInfoFB	set(XrSpaceQueryInfoFB src)	Copies the specified struct data to this struct.
int	sizeof()
long	timeout()	the number of nanoseconds before the operation should time out.
XrSpaceQueryInfoFB	timeout(long value)	Sets the specified value to the timeout() field.
int	type()	the XrStructureType of this structure.
XrSpaceQueryInfoFB	type(int value)	Sets the specified value to the type() field.
XrSpaceQueryInfoFB	type$Default()	Sets the TYPE_SPACE_QUERY_INFO_FB value to the type() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

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.

QUERYACTION

public static final int QUERYACTION

The struct member offsets.

MAXRESULTCOUNT

public static final int MAXRESULTCOUNT

The struct member offsets.

TIMEOUT

public static final int TIMEOUT

The struct member offsets.

FILTER

public static final int FILTER

The struct member offsets.

EXCLUDEFILTER

public static final int EXCLUDEFILTER

The struct member offsets.

Constructor Details

XrSpaceQueryInfoFB

public XrSpaceQueryInfoFB(ByteBuffer container)

Creates a XrSpaceQueryInfoFB 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<XrSpaceQueryInfoFB>

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.

queryAction

public int queryAction()

the type of query to perform.

maxResultCount

public int maxResultCount()

the maximum number of entities to be found.

timeout

public long timeout()

the number of nanoseconds before the operation should time out. A value of INFINITE_DURATION indicates no timeout.

filter

public @Nullable XrSpaceFilterInfoBaseHeaderFB filter()

NULL or a pointer to a valid structure based on XrSpaceFilterInfoBaseHeaderFB.

excludeFilter

public @Nullable XrSpaceFilterInfoBaseHeaderFB excludeFilter()

NULL or a pointer to a valid structure based on XrSpaceFilterInfoBaseHeaderFB.

type

public XrSpaceQueryInfoFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpaceQueryInfoFB type$Default()

Sets the TYPE_SPACE_QUERY_INFO_FB value to the type() field.

next

public XrSpaceQueryInfoFB next(long value)

Sets the specified value to the next() field.

queryAction

public XrSpaceQueryInfoFB queryAction(int value)

Sets the specified value to the queryAction() field.

maxResultCount

public XrSpaceQueryInfoFB maxResultCount(int value)

Sets the specified value to the maxResultCount() field.

timeout

public XrSpaceQueryInfoFB timeout(long value)

Sets the specified value to the timeout() field.

filter

public XrSpaceQueryInfoFB filter(@Nullable XrSpaceFilterInfoBaseHeaderFB value)

Sets the address of the specified XrSpaceFilterInfoBaseHeaderFB to the filter() field.

excludeFilter

public XrSpaceQueryInfoFB excludeFilter(@Nullable XrSpaceFilterInfoBaseHeaderFB value)

Sets the address of the specified XrSpaceFilterInfoBaseHeaderFB to the excludeFilter() field.

set

public XrSpaceQueryInfoFB set(int type,
 long next,
 int queryAction,
 int maxResultCount,
 long timeout,
 @Nullable XrSpaceFilterInfoBaseHeaderFB filter,
 @Nullable XrSpaceFilterInfoBaseHeaderFB excludeFilter)

Initializes this struct with the specified values.

set

public XrSpaceQueryInfoFB set(XrSpaceQueryInfoFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpaceQueryInfoFB malloc()

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

calloc

public static XrSpaceQueryInfoFB calloc()

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

create

public static XrSpaceQueryInfoFB create()

Returns a new XrSpaceQueryInfoFB instance allocated with BufferUtils.

create

public static XrSpaceQueryInfoFB create(long address)

Returns a new XrSpaceQueryInfoFB instance for the specified memory address.

createSafe

public static @Nullable XrSpaceQueryInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSpaceQueryInfoFB create(XrSpaceQueryInfoBaseHeaderFB value)

Downcasts the specified XrSpaceQueryInfoBaseHeaderFB instance to XrSpaceQueryInfoFB.

malloc

public static XrSpaceQueryInfoFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpaceQueryInfoFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpaceQueryInfoFB.Buffer create(int capacity)

Returns a new XrSpaceQueryInfoFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XrSpaceQueryInfoFB.Buffer create(long address,
 int capacity)

Create a XrSpaceQueryInfoFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrSpaceQueryInfoFB.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

create

public static XrSpaceQueryInfoFB.Buffer create(XrSpaceQueryInfoBaseHeaderFB.Buffer value)

Downcasts the specified XrSpaceQueryInfoBaseHeaderFB.Buffer instance to XrSpaceQueryInfoFB.Buffer.

malloc

public static XrSpaceQueryInfoFB malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrSpaceQueryInfoFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrSpaceQueryInfoFB calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrSpaceQueryInfoFB.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrSpaceQueryInfoFB.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new XrSpaceQueryInfoFB.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().

nqueryAction

public static int nqueryAction(long struct)

Unsafe version of queryAction().

nmaxResultCount

public static int nmaxResultCount(long struct)

Unsafe version of maxResultCount().

ntimeout

public static long ntimeout(long struct)

Unsafe version of timeout().

nfilter

public static @Nullable XrSpaceFilterInfoBaseHeaderFB nfilter(long struct)

Unsafe version of filter().

nexcludeFilter

public static @Nullable XrSpaceFilterInfoBaseHeaderFB nexcludeFilter(long struct)

Unsafe version of excludeFilter().

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.

nqueryAction

public static void nqueryAction(long struct,
 int value)

Unsafe version of queryAction.

nmaxResultCount

public static void nmaxResultCount(long struct,
 int value)

Unsafe version of maxResultCount.

ntimeout

public static void ntimeout(long struct,
 long value)

Unsafe version of timeout.

nfilter

public static void nfilter(long struct,
 @Nullable XrSpaceFilterInfoBaseHeaderFB value)

Unsafe version of filter.

nexcludeFilter

public static void nexcludeFilter(long struct,
 @Nullable XrSpaceFilterInfoBaseHeaderFB value)

Unsafe version of excludeFilter.