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

Layout


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

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrPassthroughPreferencesMETA.Buffer An array of `XrPassthroughPreferencesMETA` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FLAGS The struct member offsets.
public static final int	NEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	TYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrPassthroughPreferencesMETA(long address, ByteBuffer container)
public	XrPassthroughPreferencesMETA(ByteBuffer container) Creates a `XrPassthroughPreferencesMETA` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrPassthroughPreferencesMETA	calloc() Returns a new `XrPassthroughPreferencesMETA` instance allocated with `memCalloc`.
public static XrPassthroughPreferencesMETA.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated with `memCalloc`.
public static XrPassthroughPreferencesMETA	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughPreferencesMETA` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrPassthroughPreferencesMETA.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrPassthroughPreferencesMETA	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static XrPassthroughPreferencesMETA	create() Returns a new `XrPassthroughPreferencesMETA` instance allocated with `BufferUtils`.
public static XrPassthroughPreferencesMETA	create(long address) Returns a new `XrPassthroughPreferencesMETA` instance for the specified memory address.
public static XrPassthroughPreferencesMETA.Buffer	create(int the buffer capacity capacity) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated with `BufferUtils`.
public static XrPassthroughPreferencesMETA.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrPassthroughPreferencesMETA.Buffer` instance at the specified memory.
public static XrPassthroughPreferencesMETA	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrPassthroughPreferencesMETA.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	flags() a bitmask of `XrPassthroughPreferenceFlagBitsMETA` describing boolean passthrough preferences.
public static XrPassthroughPreferencesMETA	malloc() Returns a new `XrPassthroughPreferencesMETA` instance allocated with `memAlloc`.
public static XrPassthroughPreferencesMETA.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated with `memAlloc`.
public static XrPassthroughPreferencesMETA	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughPreferencesMETA` instance allocated on the specified `MemoryStack`.
public static XrPassthroughPreferencesMETA.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrPassthroughPreferencesMETA	next(long value) Sets the specified value to the `next` field.
public static long	nflags(long struct) Unsafe version of `flags`.
public static long	nnext(long struct) Unsafe version of `next`.
public static void	nnext(long struct, long value) Unsafe version of `next`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public XrPassthroughPreferencesMETA	set(int type, long next) Initializes this struct with the specified values.
public XrPassthroughPreferencesMETA	Returns: this struct set(XrPassthroughPreferencesMETA the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	type() the `XrStructureType` of this structure.
public XrPassthroughPreferencesMETA	type(int value) Sets the specified value to the `type` field.
public XrPassthroughPreferencesMETA	type$Default() Sets the `TYPE_PASSTHROUGH_PREFERENCES_META` value to the `type` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

FLAGS	back to summary
public static final int FLAGS The struct member offsets.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

XrPassthroughPreferencesMETA	back to summary
protected XrPassthroughPreferencesMETA(long address, ByteBuffer container)

XrPassthroughPreferencesMETA back to summary

XrPassthroughPreferencesMETA	back to summary
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.

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 Detail

calloc	back to summary
public static XrPassthroughPreferencesMETA calloc() Returns a new `XrPassthroughPreferencesMETA` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrPassthroughPreferencesMETA.Buffer calloc(int capacity) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrPassthroughPreferencesMETA.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrPassthroughPreferencesMETA calloc(MemoryStack stack) Returns a new `XrPassthroughPreferencesMETA` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrPassthroughPreferencesMETA calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrPassthroughPreferencesMETA.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected XrPassthroughPreferencesMETA create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected XrPassthroughPreferencesMETA create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static XrPassthroughPreferencesMETA create() Returns a new `XrPassthroughPreferencesMETA` instance allocated with `BufferUtils`.

create	back to summary
public static XrPassthroughPreferencesMETA create(long address) Returns a new `XrPassthroughPreferencesMETA` instance for the specified memory address.

create back to summary

create	back to summary
public static XrPassthroughPreferencesMETA.Buffer create(int capacity) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrPassthroughPreferencesMETA.Buffer create(int capacity)

Returns a new XrPassthroughPreferencesMETA.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrPassthroughPreferencesMETA.Buffer create(long address, int capacity) Create a `XrPassthroughPreferencesMETA.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrPassthroughPreferencesMETA.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrPassthroughPreferencesMETA createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrPassthroughPreferencesMETA createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrPassthroughPreferencesMETA.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags back to summary

flags	back to summary
public long flags() a bitmask of `XrPassthroughPreferenceFlagBitsMETA` describing boolean passthrough preferences. Annotations @NativeType:XrPassthroughPreferenceFlagsMETA

public long flags()

a bitmask of XrPassthroughPreferenceFlagBitsMETA describing boolean passthrough preferences.

Annotations

@NativeType:XrPassthroughPreferenceFlagsMETA

malloc	back to summary
public static XrPassthroughPreferencesMETA malloc() Returns a new `XrPassthroughPreferencesMETA` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrPassthroughPreferencesMETA.Buffer malloc(int capacity) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrPassthroughPreferencesMETA.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrPassthroughPreferencesMETA malloc(MemoryStack stack) Returns a new `XrPassthroughPreferencesMETA` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrPassthroughPreferencesMETA malloc(MemoryStack stack)

Returns a new XrPassthroughPreferencesMETA instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrPassthroughPreferencesMETA.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrPassthroughPreferencesMETA.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back to summary
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. Annotations @NativeType:void const *

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.

Annotations

@NativeType:void const *

next	back to summary
public XrPassthroughPreferencesMETA next(long value) Sets the specified value to the `next` field.

nflags	back to summary
public static long nflags(long struct) Unsafe version of `flags`.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

set	back to summary
public XrPassthroughPreferencesMETA set(int type, long next) Initializes this struct with the specified values.

set	back to summary
public XrPassthroughPreferencesMETA set(XrPassthroughPreferencesMETA src) Copies the specified struct data to this struct. Parameters src:XrPassthroughPreferencesMETA the source struct Returns:XrPassthroughPreferencesMETA this struct

set

back to summary

public XrPassthroughPreferencesMETA set(XrPassthroughPreferencesMETA src)

Copies the specified struct data to this struct.

Parameters

src:XrPassthroughPreferencesMETA: the source struct

Returns:XrPassthroughPreferencesMETA

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrPassthroughPreferencesMETA type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrPassthroughPreferencesMETA type$Default() Sets the `TYPE_PASSTHROUGH_PREFERENCES_META` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrPassthroughPreferencesMETA.Buffer

Class Inheritance

extends StructBuffer<XrPassthroughPreferencesMETA, XrPassthroughPreferencesMETA.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrPassthroughPreferencesMETA.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrPassthroughPreferencesMETA structs.

Field Summary

Modifier and Type	Field and Description
private static final XrPassthroughPreferencesMETA	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrPassthroughPreferencesMETA.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public long	Returns: the value of the `XrPassthroughPreferencesMETA#flags` field. flags()
protected XrPassthroughPreferencesMETA	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrPassthroughPreferencesMETA#next` field. next()
public XrPassthroughPreferencesMETA.Buffer	next(long value) Sets the specified value to the `XrPassthroughPreferencesMETA#next` field.
protected XrPassthroughPreferencesMETA.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrPassthroughPreferencesMETA#type` field. type()
public XrPassthroughPreferencesMETA.Buffer	type(int value) Sets the specified value to the `XrPassthroughPreferencesMETA#type` field.
public XrPassthroughPreferencesMETA.Buffer	type$Default() Sets the `TYPE_PASSTHROUGH_PREFERENCES_META` value to the `XrPassthroughPreferencesMETA#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrPassthroughPreferencesMETA ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrPassthroughPreferencesMETA.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `XrPassthroughPreferencesMETA#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrPassthroughPreferencesMETA.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrPassthroughPreferencesMETA#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flags	back to summary
public long flags() Returns:long the value of the `XrPassthroughPreferencesMETA#flags` field. Annotations @NativeType:XrPassthroughPreferenceFlagsMETA

getElementFactory	back to summary
protected XrPassthroughPreferencesMETA getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected XrPassthroughPreferencesMETA getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

next	back to summary
public long next() Returns:long the value of the `XrPassthroughPreferencesMETA#next` field. Annotations @NativeType:void const *

next	back to summary
public XrPassthroughPreferencesMETA.Buffer next(long value) Sets the specified value to the `XrPassthroughPreferencesMETA#next` field.

self

back to summary

protected XrPassthroughPreferencesMETA.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

type	back to summary
public int type() Returns:int the value of the `XrPassthroughPreferencesMETA#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrPassthroughPreferencesMETA.Buffer type(int value) Sets the specified value to the `XrPassthroughPreferencesMETA#type` field.

type$Default	back to summary
public XrPassthroughPreferencesMETA.Buffer type$Default() Sets the `TYPE_PASSTHROUGH_PREFERENCES_META` value to the `XrPassthroughPreferencesMETA#type` field.

public Class XrPassthroughPreferencesMETA

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrPassthroughPreferencesMETA.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail