Package org.lwjgl.openxr

Class XrScenePlaneAlignmentFilterInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrScenePlaneAlignmentFilterInfoMSFT>

org.lwjgl.openxr.XrScenePlaneAlignmentFilterInfoMSFT

All Implemented Interfaces:

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

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

Plane alignment filter.

Description

The runtime must return only scene components that match one of the XrScenePlaneAlignmentTypeMSFT values passed in alignments.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrScenePlaneAlignmentFilterInfoMSFT
• type must be TYPE_SCENE_PLANE_ALIGNMENT_FILTER_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If alignmentCount is not 0, alignments must be a pointer to an array of alignmentCount valid XrScenePlaneAlignmentTypeMSFT values

See Also

XrSceneComponentsGetInfoMSFT

Layout

 struct XrScenePlaneAlignmentFilterInfoMSFT {
     XrStructureType type();
     void const * next();
     uint32_t alignmentCount();
     XrScenePlaneAlignmentTypeMSFT const * alignments();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

ALIGNMENTCOUNT

public static final int ALIGNMENTCOUNT

The struct member offsets.

ALIGNMENTS

public static final int ALIGNMENTS

The struct member offsets.

Constructor Details

XrScenePlaneAlignmentFilterInfoMSFT

public XrScenePlaneAlignmentFilterInfoMSFT(ByteBuffer container)

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

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.

alignmentCount

public int alignmentCount()

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

alignments

public @Nullable IntBuffer alignments()

an array of XrScenePlaneAlignmentTypeMSFT to filter by.

type

public XrScenePlaneAlignmentFilterInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrScenePlaneAlignmentFilterInfoMSFT type$Default()

Sets the TYPE_SCENE_PLANE_ALIGNMENT_FILTER_INFO_MSFT value to the type() field.

next

public XrScenePlaneAlignmentFilterInfoMSFT next(long value)

Sets the specified value to the next() field.

alignmentCount

public XrScenePlaneAlignmentFilterInfoMSFT alignmentCount(int value)

Sets the specified value to the alignmentCount() field.

alignments

public XrScenePlaneAlignmentFilterInfoMSFT alignments(@Nullable IntBuffer value)

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

set

public XrScenePlaneAlignmentFilterInfoMSFT set(int type,
 long next,
 int alignmentCount,
 @Nullable IntBuffer alignments)

Initializes this struct with the specified values.

set

public XrScenePlaneAlignmentFilterInfoMSFT set(XrScenePlaneAlignmentFilterInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrScenePlaneAlignmentFilterInfoMSFT malloc()

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

calloc

public static XrScenePlaneAlignmentFilterInfoMSFT calloc()

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

create

public static XrScenePlaneAlignmentFilterInfoMSFT create()

Returns a new XrScenePlaneAlignmentFilterInfoMSFT instance allocated with BufferUtils.

create

public static XrScenePlaneAlignmentFilterInfoMSFT create(long address)

Returns a new XrScenePlaneAlignmentFilterInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrScenePlaneAlignmentFilterInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrScenePlaneAlignmentFilterInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrScenePlaneAlignmentFilterInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrScenePlaneAlignmentFilterInfoMSFT.Buffer create(int capacity)

Returns a new XrScenePlaneAlignmentFilterInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrScenePlaneAlignmentFilterInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrScenePlaneAlignmentFilterInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nalignmentCount

public static int nalignmentCount(long struct)

Unsafe version of alignmentCount().

nalignments

public static @Nullable IntBuffer nalignments(long struct)

Unsafe version of alignments.

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.

nalignmentCount

public static void nalignmentCount(long struct,
 int value)

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

nalignments

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

Unsafe version of alignments.