Package org.lwjgl.openxr

Class XrSceneMarkerTypeFilterMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneMarkerTypeFilterMSFT>

org.lwjgl.openxr.XrSceneMarkerTypeFilterMSFT

All Implemented Interfaces:

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

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

The information to filter marker query results.

Description

The application can filter the returned scene components to specific marker types by chaining XrSceneMarkerTypeFilterMSFT to the next pointer of XrSceneComponentsGetInfoMSFT when calling GetSceneComponentsMSFT.

When XrSceneMarkerTypeFilterMSFT is provided to GetSceneComponentsMSFT, the runtime must only return scene components that match the requested types.

The application must provide a non-empty array of unique markerTypes, i.e. the markerTypeCount must be positive and the elements in the markerTypes array must not have duplicated values. Otherwise, the runtime must return ERROR_VALIDATION_FAILURE for GetSceneComponentsMSFT function.

Valid Usage (Implicit)

• The XR_MSFT_scene_marker extension must be enabled prior to using XrSceneMarkerTypeFilterMSFT
• type must be TYPE_SCENE_MARKER_TYPE_FILTER_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If markerTypeCount is not 0, markerTypes must be a pointer to an array of markerTypeCount XrSceneMarkerTypeMSFT values

See Also

GetSceneComponentsMSFT

Layout

 struct XrSceneMarkerTypeFilterMSFT {
     XrStructureType type();
     void const * next();
     uint32_t markerTypeCount();
     XrSceneMarkerTypeMSFT * markerTypes();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

MARKERTYPECOUNT

public static final int MARKERTYPECOUNT

The struct member offsets.

MARKERTYPES

public static final int MARKERTYPES

The struct member offsets.

Constructor Details

XrSceneMarkerTypeFilterMSFT

public XrSceneMarkerTypeFilterMSFT(ByteBuffer container)

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

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.

markerTypeCount

public int markerTypeCount()

a uint32_t indicating the count of elements in the markerTypes array.

markerTypes

public @Nullable IntBuffer markerTypes()

an array of XrSceneMarkerTypeMSFT indicating the types of markers to return.

type

public XrSceneMarkerTypeFilterMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneMarkerTypeFilterMSFT type$Default()

Sets the TYPE_SCENE_MARKER_TYPE_FILTER_MSFT value to the type() field.

next

public XrSceneMarkerTypeFilterMSFT next(long value)

Sets the specified value to the next() field.

markerTypeCount

public XrSceneMarkerTypeFilterMSFT markerTypeCount(int value)

Sets the specified value to the markerTypeCount() field.

markerTypes

public XrSceneMarkerTypeFilterMSFT markerTypes(@Nullable IntBuffer value)

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

set

public XrSceneMarkerTypeFilterMSFT set(int type,
 long next,
 int markerTypeCount,
 @Nullable IntBuffer markerTypes)

Initializes this struct with the specified values.

set

public XrSceneMarkerTypeFilterMSFT set(XrSceneMarkerTypeFilterMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneMarkerTypeFilterMSFT malloc()

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

calloc

public static XrSceneMarkerTypeFilterMSFT calloc()

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

create

public static XrSceneMarkerTypeFilterMSFT create()

Returns a new XrSceneMarkerTypeFilterMSFT instance allocated with BufferUtils.

create

public static XrSceneMarkerTypeFilterMSFT create(long address)

Returns a new XrSceneMarkerTypeFilterMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneMarkerTypeFilterMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneMarkerTypeFilterMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneMarkerTypeFilterMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneMarkerTypeFilterMSFT.Buffer create(int capacity)

Returns a new XrSceneMarkerTypeFilterMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneMarkerTypeFilterMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneMarkerTypeFilterMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmarkerTypeCount

public static int nmarkerTypeCount(long struct)

Unsafe version of markerTypeCount().

nmarkerTypes

public static @Nullable IntBuffer nmarkerTypes(long struct)

Unsafe version of markerTypes.

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.

nmarkerTypeCount

public static void nmarkerTypeCount(long struct,
 int value)

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

nmarkerTypes

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

Unsafe version of markerTypes.