Package org.lwjgl.openxr

Class XrSystemSpatialEntityPropertiesFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSystemSpatialEntityPropertiesFB>

org.lwjgl.openxr.XrSystemSpatialEntityPropertiesFB

All Implemented Interfaces:

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

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

Properties object retrieved as part of next chain from xrGetSystemProperties.

Description

An application can inspect whether the system is capable of spatial entity operations by extending the XrSystemProperties with XrSystemSpatialEntityPropertiesFB structure when calling GetSystemProperties.

If a runtime returns FALSE for supportsSpatialEntity, the runtime must return ERROR_FEATURE_UNSUPPORTED from GetSpaceUuidFB.

Valid Usage (Implicit)

• The XR_FB_spatial_entity extension must be enabled prior to using XrSystemSpatialEntityPropertiesFB
• type must be TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

GetSystemProperties

Layout

 struct XrSystemSpatialEntityPropertiesFB {
     XrStructureType type();
     void const * next();
     XrBool32 supportsSpatialEntity();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

SUPPORTSSPATIALENTITY

public static final int SUPPORTSSPATIALENTITY

The struct member offsets.

Constructor Details

XrSystemSpatialEntityPropertiesFB

public XrSystemSpatialEntityPropertiesFB(ByteBuffer container)

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

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.

supportsSpatialEntity

public boolean supportsSpatialEntity()

a boolean value that determines if spatial entities are supported by the system.

type

public XrSystemSpatialEntityPropertiesFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSystemSpatialEntityPropertiesFB type$Default()

Sets the TYPE_SYSTEM_SPATIAL_ENTITY_PROPERTIES_FB value to the type() field.

next

public XrSystemSpatialEntityPropertiesFB next(long value)

Sets the specified value to the next() field.

set

public XrSystemSpatialEntityPropertiesFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSystemSpatialEntityPropertiesFB set(XrSystemSpatialEntityPropertiesFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSystemSpatialEntityPropertiesFB malloc()

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

calloc

public static XrSystemSpatialEntityPropertiesFB calloc()

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

create

public static XrSystemSpatialEntityPropertiesFB create()

Returns a new XrSystemSpatialEntityPropertiesFB instance allocated with BufferUtils.

create

public static XrSystemSpatialEntityPropertiesFB create(long address)

Returns a new XrSystemSpatialEntityPropertiesFB instance for the specified memory address.

createSafe

public static @Nullable XrSystemSpatialEntityPropertiesFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSystemSpatialEntityPropertiesFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSystemSpatialEntityPropertiesFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSystemSpatialEntityPropertiesFB.Buffer create(int capacity)

Returns a new XrSystemSpatialEntityPropertiesFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSystemSpatialEntityPropertiesFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSystemSpatialEntityPropertiesFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportsSpatialEntity

public static int nsupportsSpatialEntity(long struct)

Unsafe version of supportsSpatialEntity().

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.