Package org.lwjgl.openxr

Class XrSpaceStorageLocationFilterInfoFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSpaceStorageLocationFilterInfoFB>

org.lwjgl.openxr.XrSpaceStorageLocationFilterInfoFB

All Implemented Interfaces:

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

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

Describes where a spatial entity is stored.

Description

Extends a query filter to limit a query to a specific storage location. Set the next pointer of an XrSpaceFilterInfoBaseHeaderFB to chain this extra filtering functionality.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_query extension must be enabled prior to using XrSpaceStorageLocationFilterInfoFB
• type must be TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• location must be a valid XrSpaceStorageLocationFB value

Layout

 struct XrSpaceStorageLocationFilterInfoFB {
     XrStructureType type();
     void const * next();
     XrSpaceStorageLocationFB location();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSpaceStorageLocationFilterInfoFB.Buffer	An array of XrSpaceStorageLocationFilterInfoFB 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	LOCATION	The struct member offsets.
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
XrSpaceStorageLocationFilterInfoFB(ByteBuffer container)	Creates a XrSpaceStorageLocationFilterInfoFB instance at the current position of the specified ByteBuffer container.

Method Summary

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

LOCATION

public static final int LOCATION

The struct member offsets.

Constructor Details

XrSpaceStorageLocationFilterInfoFB

public XrSpaceStorageLocationFilterInfoFB(ByteBuffer container)

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

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.

location

public int location()

the location to limit the query to.

type

public XrSpaceStorageLocationFilterInfoFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSpaceStorageLocationFilterInfoFB type$Default()

Sets the TYPE_SPACE_STORAGE_LOCATION_FILTER_INFO_FB value to the type() field.

next

public XrSpaceStorageLocationFilterInfoFB next(long value)

Sets the specified value to the next() field.

location

public XrSpaceStorageLocationFilterInfoFB location(int value)

Sets the specified value to the location() field.

set

public XrSpaceStorageLocationFilterInfoFB set(int type,
 long next,
 int location)

Initializes this struct with the specified values.

set

public XrSpaceStorageLocationFilterInfoFB set(XrSpaceStorageLocationFilterInfoFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSpaceStorageLocationFilterInfoFB malloc()

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

calloc

public static XrSpaceStorageLocationFilterInfoFB calloc()

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

create

public static XrSpaceStorageLocationFilterInfoFB create()

Returns a new XrSpaceStorageLocationFilterInfoFB instance allocated with BufferUtils.

create

public static XrSpaceStorageLocationFilterInfoFB create(long address)

Returns a new XrSpaceStorageLocationFilterInfoFB instance for the specified memory address.

createSafe

public static @Nullable XrSpaceStorageLocationFilterInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSpaceStorageLocationFilterInfoFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSpaceStorageLocationFilterInfoFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSpaceStorageLocationFilterInfoFB.Buffer create(int capacity)

Returns a new XrSpaceStorageLocationFilterInfoFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSpaceStorageLocationFilterInfoFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSpaceStorageLocationFilterInfoFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlocation

public static int nlocation(long struct)

Unsafe version of location().

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.

nlocation

public static void nlocation(long struct,
 int value)

Unsafe version of location.