Package org.lwjgl.openxr

Class XrSceneObjectTypesFilterInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneObjectTypesFilterInfoMSFT>

org.lwjgl.openxr.XrSceneObjectTypesFilterInfoMSFT

All Implemented Interfaces:

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

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

Scene object types filter.

Description

The runtime must return only scene components that match any of the XrSceneObjectTypeMSFT in objectTypes. If a scene component does not have an XrSceneObjectTypeMSFT then the parent’s XrSceneObjectTypeMSFT value will be used for the comparison if it exists.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneObjectTypesFilterInfoMSFT
• type must be TYPE_SCENE_OBJECT_TYPES_FILTER_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If objectTypeCount is not 0, objectTypes must be a pointer to an array of objectTypeCount valid XrSceneObjectTypeMSFT values

See Also

XrSceneComponentsGetInfoMSFT

Layout

 struct XrSceneObjectTypesFilterInfoMSFT {
     XrStructureType type();
     void const * next();
     uint32_t objectTypeCount();
     XrSceneObjectTypeMSFT const * objectTypes();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSceneObjectTypesFilterInfoMSFT	calloc()	Returns a new XrSceneObjectTypesFilterInfoMSFT instance allocated with memCalloc.
static XrSceneObjectTypesFilterInfoMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneObjectTypesFilterInfoMSFT.Buffer instance allocated with memCalloc.
static XrSceneObjectTypesFilterInfoMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneObjectTypesFilterInfoMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneObjectTypesFilterInfoMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneObjectTypesFilterInfoMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneObjectTypesFilterInfoMSFT	create()	Returns a new XrSceneObjectTypesFilterInfoMSFT instance allocated with BufferUtils.
static XrSceneObjectTypesFilterInfoMSFT.Buffer	create(int capacity)	Returns a new XrSceneObjectTypesFilterInfoMSFT.Buffer instance allocated with BufferUtils.
static XrSceneObjectTypesFilterInfoMSFT	create(long address)	Returns a new XrSceneObjectTypesFilterInfoMSFT instance for the specified memory address.
static XrSceneObjectTypesFilterInfoMSFT.Buffer	create(long address, int capacity)	Create a XrSceneObjectTypesFilterInfoMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneObjectTypesFilterInfoMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneObjectTypesFilterInfoMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSceneObjectTypesFilterInfoMSFT	malloc()	Returns a new XrSceneObjectTypesFilterInfoMSFT instance allocated with memAlloc.
static XrSceneObjectTypesFilterInfoMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneObjectTypesFilterInfoMSFT.Buffer instance allocated with memAlloc.
static XrSceneObjectTypesFilterInfoMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneObjectTypesFilterInfoMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneObjectTypesFilterInfoMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneObjectTypesFilterInfoMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSceneObjectTypesFilterInfoMSFT	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	nobjectTypeCount(long struct)	Unsafe version of objectTypeCount().
static void	nobjectTypeCount(long struct, int value)	Sets the specified value to the objectTypeCount field of the specified struct.
static @Nullable IntBuffer	nobjectTypes(long struct)	Unsafe version of objectTypes.
static void	nobjectTypes(long struct, @Nullable IntBuffer value)	Unsafe version of objectTypes.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	objectTypeCount()	a uint32_t describing the count of elements in the objectTypes array.
XrSceneObjectTypesFilterInfoMSFT	objectTypeCount(int value)	Sets the specified value to the objectTypeCount() field.
@Nullable IntBuffer	objectTypes()	an array of XrSceneObjectTypeMSFT to filter by.
XrSceneObjectTypesFilterInfoMSFT	objectTypes(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the objectTypes() field.
XrSceneObjectTypesFilterInfoMSFT	set(int type, long next, int objectTypeCount, @Nullable IntBuffer objectTypes)	Initializes this struct with the specified values.
XrSceneObjectTypesFilterInfoMSFT	set(XrSceneObjectTypesFilterInfoMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSceneObjectTypesFilterInfoMSFT	type(int value)	Sets the specified value to the type() field.
XrSceneObjectTypesFilterInfoMSFT	type$Default()	Sets the TYPE_SCENE_OBJECT_TYPES_FILTER_INFO_MSFT 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.

OBJECTTYPECOUNT

public static final int OBJECTTYPECOUNT

The struct member offsets.

OBJECTTYPES

public static final int OBJECTTYPES

The struct member offsets.

Constructor Details

XrSceneObjectTypesFilterInfoMSFT

public XrSceneObjectTypesFilterInfoMSFT(ByteBuffer container)

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

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.

objectTypeCount

public int objectTypeCount()

a uint32_t describing the count of elements in the objectTypes array.

objectTypes

public @Nullable IntBuffer objectTypes()

an array of XrSceneObjectTypeMSFT to filter by.

type

public XrSceneObjectTypesFilterInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneObjectTypesFilterInfoMSFT type$Default()

Sets the TYPE_SCENE_OBJECT_TYPES_FILTER_INFO_MSFT value to the type() field.

next

public XrSceneObjectTypesFilterInfoMSFT next(long value)

Sets the specified value to the next() field.

objectTypeCount

public XrSceneObjectTypesFilterInfoMSFT objectTypeCount(int value)

Sets the specified value to the objectTypeCount() field.

objectTypes

public XrSceneObjectTypesFilterInfoMSFT objectTypes(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the objectTypes() field.

set

public XrSceneObjectTypesFilterInfoMSFT set(int type,
 long next,
 int objectTypeCount,
 @Nullable IntBuffer objectTypes)

Initializes this struct with the specified values.

set

public XrSceneObjectTypesFilterInfoMSFT set(XrSceneObjectTypesFilterInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneObjectTypesFilterInfoMSFT malloc()

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

calloc

public static XrSceneObjectTypesFilterInfoMSFT calloc()

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

create

public static XrSceneObjectTypesFilterInfoMSFT create()

Returns a new XrSceneObjectTypesFilterInfoMSFT instance allocated with BufferUtils.

create

public static XrSceneObjectTypesFilterInfoMSFT create(long address)

Returns a new XrSceneObjectTypesFilterInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneObjectTypesFilterInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneObjectTypesFilterInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneObjectTypesFilterInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneObjectTypesFilterInfoMSFT.Buffer create(int capacity)

Returns a new XrSceneObjectTypesFilterInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneObjectTypesFilterInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneObjectTypesFilterInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nobjectTypeCount

public static int nobjectTypeCount(long struct)

Unsafe version of objectTypeCount().

nobjectTypes

public static @Nullable IntBuffer nobjectTypes(long struct)

Unsafe version of objectTypes.

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.

nobjectTypeCount

public static void nobjectTypeCount(long struct,
 int value)

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

nobjectTypes

public static void nobjectTypes(long struct,
 @Nullable IntBuffer value)

Unsafe version of objectTypes.