A composition layer for passthrough.

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
flags is a bitmask of XrCompositionLayerFlagBits that specify additional behavior.
space is the XrSpace that specifies the layer’s space - must be NULL_HANDLE.
layer is the XrPassthroughLayerFB that defines this layer’s behavior.

Valid Usage (Implicit)

The XR_FB_passthrough extension must be enabled prior to using XrCompositionLayerPassthroughFB
type must be TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
next must be NULL or a valid pointer to the next structure in a structure chain
flags must be a valid combination of XrCompositionLayerFlagBits values
flags must not be 0
space must be a valid XrSpace handle
layerHandle must be a valid XrPassthroughLayerFB handle
Both of layerHandle and space must have been created, allocated, or retrieved from the same XrSession

Layout


struct XrCompositionLayerPassthroughFB {
    XrStructureType type;
    void const * next;
    XrCompositionLayerFlags flags;
    XrSpace space;
    XrPassthroughLayerFB layerHandle;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrCompositionLayerPassthroughFB.Buffer An array of `XrCompositionLayerPassthroughFB` 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	LAYERHANDLE 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	SPACE The struct member offsets.
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	XrCompositionLayerPassthroughFB(long address, ByteBuffer container)
public	XrCompositionLayerPassthroughFB(ByteBuffer container) Creates a `XrCompositionLayerPassthroughFB` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrCompositionLayerPassthroughFB	calloc() Returns a new `XrCompositionLayerPassthroughFB` instance allocated with `memCalloc`.
public static XrCompositionLayerPassthroughFB.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrCompositionLayerPassthroughFB.Buffer` instance allocated with `memCalloc`.
public static XrCompositionLayerPassthroughFB	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerPassthroughFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrCompositionLayerPassthroughFB.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerPassthroughFB.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrCompositionLayerPassthroughFB	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 XrCompositionLayerPassthroughFB	create() Returns a new `XrCompositionLayerPassthroughFB` instance allocated with `BufferUtils`.
public static XrCompositionLayerPassthroughFB	create(long address) Returns a new `XrCompositionLayerPassthroughFB` instance for the specified memory address.
public static XrCompositionLayerPassthroughFB.Buffer	create(int the buffer capacity capacity) Returns a new `XrCompositionLayerPassthroughFB.Buffer` instance allocated with `BufferUtils`.
public static XrCompositionLayerPassthroughFB.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrCompositionLayerPassthroughFB.Buffer` instance at the specified memory.
public static XrCompositionLayerPassthroughFB	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrCompositionLayerPassthroughFB.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	Returns: the value of the `flags` field. flags()
public XrCompositionLayerPassthroughFB	flags(long value) Sets the specified value to the `flags` field.
public long	Returns: the value of the `layerHandle` field. layerHandle()
public XrCompositionLayerPassthroughFB	layerHandle(XrPassthroughLayerFB value) Sets the specified value to the `layerHandle` field.
public static XrCompositionLayerPassthroughFB	malloc() Returns a new `XrCompositionLayerPassthroughFB` instance allocated with `memAlloc`.
public static XrCompositionLayerPassthroughFB.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrCompositionLayerPassthroughFB.Buffer` instance allocated with `memAlloc`.
public static XrCompositionLayerPassthroughFB	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerPassthroughFB` instance allocated on the specified `MemoryStack`.
public static XrCompositionLayerPassthroughFB.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrCompositionLayerPassthroughFB.Buffer` instance allocated on the specified `MemoryStack`.
public long	Returns: the value of the `next` field. next()
public XrCompositionLayerPassthroughFB	next(long value) Sets the specified value to the `next` field.
public static long	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, long value) Unsafe version of `flags`.
public static long	nlayerHandle(long struct) Unsafe version of `layerHandle`.
public static void	nlayerHandle(long struct, XrPassthroughLayerFB value) Unsafe version of `layerHandle`.
public static long	nnext(long struct) Unsafe version of `next`.
public static void	nnext(long struct, long value) Unsafe version of `next`.
public static long	nspace(long struct) Unsafe version of `space`.
public static void	nspace(long struct, XrSpace value) Unsafe version of `space`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public XrCompositionLayerPassthroughFB	set(int type, long next, long flags, XrSpace space, XrPassthroughLayerFB layerHandle) Initializes this struct with the specified values.
public XrCompositionLayerPassthroughFB	Returns: this struct set(XrCompositionLayerPassthroughFB 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 long	Returns: the value of the `space` field. space()
public XrCompositionLayerPassthroughFB	space(XrSpace value) Sets the specified value to the `space` field.
public int	Returns: the value of the `type` field. type()
public XrCompositionLayerPassthroughFB	type(int value) Sets the specified value to the `type` field.
public XrCompositionLayerPassthroughFB	type$Default() Sets the `TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB` value to the `type` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

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.

LAYERHANDLE	back to summary
public static final int LAYERHANDLE 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.

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

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

Constructor Detail

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

XrCompositionLayerPassthroughFB back to summary

XrCompositionLayerPassthroughFB	back to summary
public XrCompositionLayerPassthroughFB(ByteBuffer container) Creates a `XrCompositionLayerPassthroughFB` 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 XrCompositionLayerPassthroughFB(ByteBuffer container)

Creates a XrCompositionLayerPassthroughFB 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 XrCompositionLayerPassthroughFB calloc() Returns a new `XrCompositionLayerPassthroughFB` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static XrCompositionLayerPassthroughFB.Buffer calloc(int capacity)

Returns a new XrCompositionLayerPassthroughFB.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 XrCompositionLayerPassthroughFB calloc(MemoryStack stack) Returns a new `XrCompositionLayerPassthroughFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrCompositionLayerPassthroughFB calloc(MemoryStack stack)

Returns a new XrCompositionLayerPassthroughFB 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 XrCompositionLayerPassthroughFB.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrCompositionLayerPassthroughFB.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 XrCompositionLayerPassthroughFB.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrCompositionLayerPassthroughFB.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 XrCompositionLayerPassthroughFB 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 XrCompositionLayerPassthroughFB 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 XrCompositionLayerPassthroughFB create() Returns a new `XrCompositionLayerPassthroughFB` instance allocated with `BufferUtils`.

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

create back to summary

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

public static XrCompositionLayerPassthroughFB.Buffer create(int capacity)

Returns a new XrCompositionLayerPassthroughFB.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a XrCompositionLayerPassthroughFB.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 XrCompositionLayerPassthroughFB createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrCompositionLayerPassthroughFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

flags	back to summary
public XrCompositionLayerPassthroughFB flags(long value) Sets the specified value to the `flags` field.

layerHandle	back to summary
public long layerHandle() Returns:long the value of the `layerHandle` field. Annotations @NativeType:XrPassthroughLayerFB

layerHandle	back to summary
public XrCompositionLayerPassthroughFB layerHandle(XrPassthroughLayerFB value) Sets the specified value to the `layerHandle` field.

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

malloc back to summary

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

public static XrCompositionLayerPassthroughFB.Buffer malloc(int capacity)

Returns a new XrCompositionLayerPassthroughFB.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 XrCompositionLayerPassthroughFB malloc(MemoryStack stack) Returns a new `XrCompositionLayerPassthroughFB` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrCompositionLayerPassthroughFB malloc(MemoryStack stack)

Returns a new XrCompositionLayerPassthroughFB 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 XrCompositionLayerPassthroughFB.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrCompositionLayerPassthroughFB.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

Returns a new XrCompositionLayerPassthroughFB.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
public long next() Returns:long the value of the `next` field. Annotations @NativeType:void const *

next	back to summary
public XrCompositionLayerPassthroughFB 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`.

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

nlayerHandle	back to summary
public static long nlayerHandle(long struct) Unsafe version of `layerHandle`.

nlayerHandle	back to summary
public static void nlayerHandle(long struct, XrPassthroughLayerFB value) Unsafe version of `layerHandle`.

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`.

nspace	back to summary
public static long nspace(long struct) Unsafe version of `space`.

nspace	back to summary
public static void nspace(long struct, XrSpace value) Unsafe version of `space`.

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 XrCompositionLayerPassthroughFB set(int type, long next, long flags, XrSpace space, XrPassthroughLayerFB layerHandle) Initializes this struct with the specified values.

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

set

back to summary

public XrCompositionLayerPassthroughFB set(XrCompositionLayerPassthroughFB src)

Copies the specified struct data to this struct.

Parameters

src:XrCompositionLayerPassthroughFB: the source struct

Returns:XrCompositionLayerPassthroughFB

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

space	back to summary
public long space() Returns:long the value of the `space` field. Annotations @NativeType:XrSpace

space	back to summary
public XrCompositionLayerPassthroughFB space(XrSpace value) Sets the specified value to the `space` field.

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

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

type$Default	back to summary
public XrCompositionLayerPassthroughFB type$Default() Sets the `TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB` value to the `type` field.

validate back to summary

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.openxr back to summary

public Class XrCompositionLayerPassthroughFB.Buffer

Class Inheritance

extends StructBuffer<XrCompositionLayerPassthroughFB, XrCompositionLayerPassthroughFB.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of XrCompositionLayerPassthroughFB structs.

Field Summary

Modifier and Type	Field and Description
private static final XrCompositionLayerPassthroughFB	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrCompositionLayerPassthroughFB.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 `flags` field. flags()
public XrCompositionLayerPassthroughFB.Buffer	flags(long value) Sets the specified value to the `flags` field.
protected XrCompositionLayerPassthroughFB	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `layerHandle` field. layerHandle()
public XrCompositionLayerPassthroughFB.Buffer	layerHandle(XrPassthroughLayerFB value) Sets the specified value to the `layerHandle` field.
public long	Returns: the value of the `next` field. next()
public XrCompositionLayerPassthroughFB.Buffer	next(long value) Sets the specified value to the `next` field.
protected XrCompositionLayerPassthroughFB.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `space` field. space()
public XrCompositionLayerPassthroughFB.Buffer	space(XrSpace value) Sets the specified value to the `space` field.
public int	Returns: the value of the `type` field. type()
public XrCompositionLayerPassthroughFB.Buffer	type(int value) Sets the specified value to the `type` field.
public XrCompositionLayerPassthroughFB.Buffer	type$Default() Sets the `TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB` value to the `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 XrCompositionLayerPassthroughFB ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new XrCompositionLayerPassthroughFB.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 XrCompositionLayerPassthroughFB#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 `flags` field. Annotations @NativeType:XrCompositionLayerFlags

flags	back to summary
public XrCompositionLayerPassthroughFB.Buffer flags(long value) Sets the specified value to the `flags` field.

getElementFactory

back to summary

protected XrCompositionLayerPassthroughFB getElementFactory()

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

Annotations

@Override

layerHandle	back to summary
public long layerHandle() Returns:long the value of the `layerHandle` field. Annotations @NativeType:XrPassthroughLayerFB

layerHandle	back to summary
public XrCompositionLayerPassthroughFB.Buffer layerHandle(XrPassthroughLayerFB value) Sets the specified value to the `layerHandle` field.

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

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

self

back to summary

protected XrCompositionLayerPassthroughFB.Buffer self()

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

Annotations

@Override

space	back to summary
public long space() Returns:long the value of the `space` field. Annotations @NativeType:XrSpace

space	back to summary
public XrCompositionLayerPassthroughFB.Buffer space(XrSpace value) Sets the specified value to the `space` field.

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

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

type$Default	back to summary
public XrCompositionLayerPassthroughFB.Buffer type$Default() Sets the `TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB` value to the `type` field.

public Class XrCompositionLayerPassthroughFB

Member Descriptions

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 XrCompositionLayerPassthroughFB.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail