Package org.lwjgl.openxr

Class XrPassthroughPreferencesMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPassthroughPreferencesMETA>

org.lwjgl.openxr.XrPassthroughPreferencesMETA

All Implemented Interfaces:

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

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

Passthrough preferences.

Description

The runtime must populate the XrPassthroughPreferencesMETA structure with the relevant information when the app calls GetPassthroughPreferencesMETA.

Presence of the bit flag PASSTHROUGH_PREFERENCE_DEFAULT_TO_ACTIVE_BIT_META does not indicate a guarantee that applications can enable and use passthrough in practice. The runtime may impose restrictions on passthrough usage (e.g. based on hardware availability or permission models) independently of the state of this flag bit. Apps should test for this flag explicitly, as more flag bits may be introduced in the future.

Valid Usage (Implicit)

• The XR_META_passthrough_preferences extension must be enabled prior to using XrPassthroughPreferencesMETA
• type must be TYPE_PASSTHROUGH_PREFERENCES_META
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

GetPassthroughPreferencesMETA

Layout

 struct XrPassthroughPreferencesMETA {
     XrStructureType type();
     void const * next();
     XrPassthroughPreferenceFlagsMETA flags();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

XrPassthroughPreferencesMETA

public XrPassthroughPreferencesMETA(ByteBuffer container)

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

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.

flags

public long flags()

a bitmask of XrPassthroughPreferenceFlagBitsMETA describing boolean passthrough preferences.

type

public XrPassthroughPreferencesMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrPassthroughPreferencesMETA type$Default()

Sets the TYPE_PASSTHROUGH_PREFERENCES_META value to the type() field.

next

public XrPassthroughPreferencesMETA next(long value)

Sets the specified value to the next() field.

set

public XrPassthroughPreferencesMETA set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrPassthroughPreferencesMETA set(XrPassthroughPreferencesMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPassthroughPreferencesMETA malloc()

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

calloc

public static XrPassthroughPreferencesMETA calloc()

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

create

public static XrPassthroughPreferencesMETA create()

Returns a new XrPassthroughPreferencesMETA instance allocated with BufferUtils.

create

public static XrPassthroughPreferencesMETA create(long address)

Returns a new XrPassthroughPreferencesMETA instance for the specified memory address.

createSafe

public static @Nullable XrPassthroughPreferencesMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPassthroughPreferencesMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPassthroughPreferencesMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPassthroughPreferencesMETA.Buffer create(int capacity)

Returns a new XrPassthroughPreferencesMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPassthroughPreferencesMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPassthroughPreferencesMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static long nflags(long struct)

Unsafe version of flags().

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.