Package org.lwjgl.openxr

Class XrSpaceFilterInfoBaseHeaderFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpaceFilterInfoBaseHeaderFB>

org.lwjgl.openxr.XrSpaceFilterInfoBaseHeaderFB

All Implemented Interfaces:

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

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

Base structure for all query filter structures.

Description

The XrSpaceFilterInfoBaseHeaderFB is a base structure that is not intended to be directly used, but forms a basis for specific filter info types. All filter info structures begin with the elements described in the XrSpaceFilterInfoBaseHeaderFB, and a filter info pointer must be cast to a pointer to XrSpaceFilterInfoBaseHeaderFB when populating XrSpaceQueryInfoFB::filter and XrSpaceQueryInfoFB::excludeFilter to pass to the QuerySpacesFB function.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_query extension must be enabled prior to using XrSpaceFilterInfoBaseHeaderFB
• type must be one of the following XrStructureType values: TYPE_SPACE_COMPONENT_FILTER_INFO_FB, TYPE_SPACE_UUID_FILTER_INFO_FB
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrSpaceStorageLocationFilterInfoFB

See Also

XrSpaceQueryInfoFB

Layout

 struct XrSpaceFilterInfoBaseHeaderFB {
     XrStructureType type();
     void const * next();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpaceFilterInfoBaseHeaderFB.Buffer	An array of XrSpaceFilterInfoBaseHeaderFB 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	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
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
XrSpaceFilterInfoBaseHeaderFB(ByteBuffer container)	Creates a XrSpaceFilterInfoBaseHeaderFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSpaceFilterInfoBaseHeaderFB	calloc()	Returns a new XrSpaceFilterInfoBaseHeaderFB instance allocated with memCalloc.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	calloc(int capacity)	Returns a new XrSpaceFilterInfoBaseHeaderFB.Buffer instance allocated with memCalloc.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceFilterInfoBaseHeaderFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpaceFilterInfoBaseHeaderFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceFilterInfoBaseHeaderFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSpaceFilterInfoBaseHeaderFB	create()	Returns a new XrSpaceFilterInfoBaseHeaderFB instance allocated with BufferUtils.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	create(int capacity)	Returns a new XrSpaceFilterInfoBaseHeaderFB.Buffer instance allocated with BufferUtils.
static XrSpaceFilterInfoBaseHeaderFB	create(long address)	Returns a new XrSpaceFilterInfoBaseHeaderFB instance for the specified memory address.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	create(long address, int capacity)	Create a XrSpaceFilterInfoBaseHeaderFB.Buffer instance at the specified memory.
static XrSpaceFilterInfoBaseHeaderFB	create(XrSpaceComponentFilterInfoFB value)	Upcasts the specified XrSpaceComponentFilterInfoFB instance to XrSpaceFilterInfoBaseHeaderFB.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	create(XrSpaceComponentFilterInfoFB.Buffer value)	Upcasts the specified XrSpaceComponentFilterInfoFB.Buffer instance to XrSpaceFilterInfoBaseHeaderFB.Buffer.
static XrSpaceFilterInfoBaseHeaderFB	create(XrSpaceUuidFilterInfoFB value)	Upcasts the specified XrSpaceUuidFilterInfoFB instance to XrSpaceFilterInfoBaseHeaderFB.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	create(XrSpaceUuidFilterInfoFB.Buffer value)	Upcasts the specified XrSpaceUuidFilterInfoFB.Buffer instance to XrSpaceFilterInfoBaseHeaderFB.Buffer.
static @Nullable XrSpaceFilterInfoBaseHeaderFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSpaceFilterInfoBaseHeaderFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSpaceFilterInfoBaseHeaderFB	malloc()	Returns a new XrSpaceFilterInfoBaseHeaderFB instance allocated with memAlloc.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	malloc(int capacity)	Returns a new XrSpaceFilterInfoBaseHeaderFB.Buffer instance allocated with memAlloc.
static XrSpaceFilterInfoBaseHeaderFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceFilterInfoBaseHeaderFB.Buffer instance allocated on the specified MemoryStack.
static XrSpaceFilterInfoBaseHeaderFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSpaceFilterInfoBaseHeaderFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSpaceFilterInfoBaseHeaderFB	next(long value)	Sets the specified value to the next() field.
XrSpaceFilterInfoBaseHeaderFB	next(XrSpaceStorageLocationFilterInfoFB value)	Prepends the specified XrSpaceStorageLocationFilterInfoFB value to the next chain.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSpaceFilterInfoBaseHeaderFB	set(int type, long next)	Initializes this struct with the specified values.
XrSpaceFilterInfoBaseHeaderFB	set(XrSpaceFilterInfoBaseHeaderFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSpaceFilterInfoBaseHeaderFB	type(int value)	Sets the specified 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.

Constructor Details

XrSpaceFilterInfoBaseHeaderFB

public XrSpaceFilterInfoBaseHeaderFB(ByteBuffer container)

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

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. This base structure itself has no associated XrStructureType value.

type

public XrSpaceFilterInfoBaseHeaderFB type(int value)

Sets the specified value to the type() field.

next

public XrSpaceFilterInfoBaseHeaderFB next(long value)

Sets the specified value to the next() field.

next

public XrSpaceFilterInfoBaseHeaderFB next(XrSpaceStorageLocationFilterInfoFB value)

Prepends the specified XrSpaceStorageLocationFilterInfoFB value to the next chain.

set

public XrSpaceFilterInfoBaseHeaderFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSpaceFilterInfoBaseHeaderFB set(XrSpaceFilterInfoBaseHeaderFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpaceFilterInfoBaseHeaderFB malloc()

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

calloc

public static XrSpaceFilterInfoBaseHeaderFB calloc()

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

create

public static XrSpaceFilterInfoBaseHeaderFB create()

Returns a new XrSpaceFilterInfoBaseHeaderFB instance allocated with BufferUtils.

create

public static XrSpaceFilterInfoBaseHeaderFB create(long address)

Returns a new XrSpaceFilterInfoBaseHeaderFB instance for the specified memory address.

createSafe

public static @Nullable XrSpaceFilterInfoBaseHeaderFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSpaceFilterInfoBaseHeaderFB create(XrSpaceUuidFilterInfoFB value)

Upcasts the specified XrSpaceUuidFilterInfoFB instance to XrSpaceFilterInfoBaseHeaderFB.

create

public static XrSpaceFilterInfoBaseHeaderFB create(XrSpaceComponentFilterInfoFB value)

Upcasts the specified XrSpaceComponentFilterInfoFB instance to XrSpaceFilterInfoBaseHeaderFB.

malloc

public static XrSpaceFilterInfoBaseHeaderFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpaceFilterInfoBaseHeaderFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpaceFilterInfoBaseHeaderFB.Buffer create(int capacity)

Returns a new XrSpaceFilterInfoBaseHeaderFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpaceFilterInfoBaseHeaderFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrSpaceFilterInfoBaseHeaderFB.Buffer create(XrSpaceUuidFilterInfoFB.Buffer value)

Upcasts the specified XrSpaceUuidFilterInfoFB.Buffer instance to XrSpaceFilterInfoBaseHeaderFB.Buffer.

create

public static XrSpaceFilterInfoBaseHeaderFB.Buffer create(XrSpaceComponentFilterInfoFB.Buffer value)

Upcasts the specified XrSpaceComponentFilterInfoFB.Buffer instance to XrSpaceFilterInfoBaseHeaderFB.Buffer.

malloc

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

Returns a new XrSpaceFilterInfoBaseHeaderFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.