Package org.lwjgl.openxr

Class XrCompositionLayerPassthroughFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerPassthroughFB>

org.lwjgl.openxr.XrCompositionLayerPassthroughFB

All Implemented Interfaces:

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

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

A composition layer for passthrough.

Description

It is a composition layer type that may be submitted in EndFrame where an XrCompositionLayerBaseHeader is specified, as a stand-in for the actual passthrough contents.

Errata: the third field of this structure is named flags rather than layerFlags as expected and as documented for for the parent type XrCompositionLayerBaseHeader.

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

See Also

XrCompositionLayerBaseHeader

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerPassthroughFB.Buffer	An array of XrCompositionLayerPassthroughFB 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	LAYERHANDLE	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE	The struct member offsets.
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
XrCompositionLayerPassthroughFB(ByteBuffer container)	Creates a XrCompositionLayerPassthroughFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerPassthroughFB	calloc()	Returns a new XrCompositionLayerPassthroughFB instance allocated with memCalloc.
static XrCompositionLayerPassthroughFB.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerPassthroughFB.Buffer instance allocated with memCalloc.
static XrCompositionLayerPassthroughFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerPassthroughFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerPassthroughFB	create()	Returns a new XrCompositionLayerPassthroughFB instance allocated with BufferUtils.
static XrCompositionLayerPassthroughFB.Buffer	create(int capacity)	Returns a new XrCompositionLayerPassthroughFB.Buffer instance allocated with BufferUtils.
static XrCompositionLayerPassthroughFB	create(long address)	Returns a new XrCompositionLayerPassthroughFB instance for the specified memory address.
static XrCompositionLayerPassthroughFB.Buffer	create(long address, int capacity)	Create a XrCompositionLayerPassthroughFB.Buffer instance at the specified memory.
static XrCompositionLayerPassthroughFB	create(XrCompositionLayerBaseHeader value)	Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerPassthroughFB.
static XrCompositionLayerPassthroughFB.Buffer	create(XrCompositionLayerBaseHeader.Buffer value)	Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerPassthroughFB.Buffer.
static @Nullable XrCompositionLayerPassthroughFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerPassthroughFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	a bitmask of XrCompositionLayerFlagBits that specify additional behavior.
XrCompositionLayerPassthroughFB	flags(long value)	Sets the specified value to the flags() field.
long	layerHandle()	the XrPassthroughLayerFB that defines this layer’s behavior.
XrCompositionLayerPassthroughFB	layerHandle(XrPassthroughLayerFB value)	Sets the specified value to the layerHandle() field.
static XrCompositionLayerPassthroughFB	malloc()	Returns a new XrCompositionLayerPassthroughFB instance allocated with memAlloc.
static XrCompositionLayerPassthroughFB.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerPassthroughFB.Buffer instance allocated with memAlloc.
static XrCompositionLayerPassthroughFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughFB.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerPassthroughFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerPassthroughFB	next(long value)	Sets the specified value to the next() field.
static long	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, long value)	Unsafe version of flags.
static long	nlayerHandle(long struct)	Unsafe version of layerHandle().
static void	nlayerHandle(long struct, XrPassthroughLayerFB value)	Unsafe version of layerHandle.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrCompositionLayerPassthroughFB	set(int type, long next, long flags, XrSpace space, XrPassthroughLayerFB layerHandle)	Initializes this struct with the specified values.
XrCompositionLayerPassthroughFB	set(XrCompositionLayerPassthroughFB src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace that specifies the layer’s space - must be NULL_HANDLE.
XrCompositionLayerPassthroughFB	space(XrSpace value)	Sets the specified value to the space() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerPassthroughFB	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerPassthroughFB	type$Default()	Sets the TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

SPACE

public static final int SPACE

The struct member offsets.

LAYERHANDLE

public static final int LAYERHANDLE

The struct member offsets.

Constructor Details

XrCompositionLayerPassthroughFB

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrCompositionLayerPassthroughFB>

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 XrCompositionLayerFlagBits that specify additional behavior.

space

public long space()

the XrSpace that specifies the layer’s space - must be NULL_HANDLE.

layerHandle

public long layerHandle()

the XrPassthroughLayerFB that defines this layer’s behavior.

type

public XrCompositionLayerPassthroughFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerPassthroughFB type$Default()

Sets the TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB value to the type() field.

next

public XrCompositionLayerPassthroughFB next(long value)

Sets the specified value to the next() field.

flags

public XrCompositionLayerPassthroughFB flags(long value)

Sets the specified value to the flags() field.

space

public XrCompositionLayerPassthroughFB space(XrSpace value)

Sets the specified value to the space() field.

layerHandle

public XrCompositionLayerPassthroughFB layerHandle(XrPassthroughLayerFB value)

Sets the specified value to the layerHandle() field.

set

public XrCompositionLayerPassthroughFB set(int type,
 long next,
 long flags,
 XrSpace space,
 XrPassthroughLayerFB layerHandle)

Initializes this struct with the specified values.

set

public XrCompositionLayerPassthroughFB set(XrCompositionLayerPassthroughFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerPassthroughFB malloc()

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

calloc

public static XrCompositionLayerPassthroughFB calloc()

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

create

public static XrCompositionLayerPassthroughFB create()

Returns a new XrCompositionLayerPassthroughFB instance allocated with BufferUtils.

create

public static XrCompositionLayerPassthroughFB create(long address)

Returns a new XrCompositionLayerPassthroughFB instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerPassthroughFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerPassthroughFB create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerPassthroughFB.

malloc

public static XrCompositionLayerPassthroughFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerPassthroughFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerPassthroughFB.Buffer create(int capacity)

Returns a new XrCompositionLayerPassthroughFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerPassthroughFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerPassthroughFB.Buffer create(XrCompositionLayerBaseHeader.Buffer value)

Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerPassthroughFB.Buffer.

malloc

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

Returns a new XrCompositionLayerPassthroughFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nspace

public static long nspace(long struct)

Unsafe version of space().

nlayerHandle

public static long nlayerHandle(long struct)

Unsafe version of layerHandle().

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.

nflags

public static void nflags(long struct,
 long value)

Unsafe version of flags.

nspace

public static void nspace(long struct,
 XrSpace value)

Unsafe version of space.

nlayerHandle

public static void nlayerHandle(long struct,
 XrPassthroughLayerFB value)

Unsafe version of layerHandle.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate