Package org.lwjgl.openxr

Class XrPassthroughLayerCreateInfoFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPassthroughLayerCreateInfoFB>

org.lwjgl.openxr.XrPassthroughLayerCreateInfoFB

All Implemented Interfaces:

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

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

A create structure for passthrough layers.

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.
• passthrough an XrPassthroughFB handle.
• flags XrPassthroughFlagsFB that specify additional behavior.
• purpose XrPassthroughLayerPurposeFB that specifies the layer’s purpose.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to using XrPassthroughLayerCreateInfoFB
• type must be TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• passthrough must be a valid XrPassthroughFB handle
• flags must be a valid combination of XrPassthroughFlagBitsFB values
• flags must not be 0
• purpose must be a valid XrPassthroughLayerPurposeFB value

See Also

CreatePassthroughLayerFB

Layout

 struct XrPassthroughLayerCreateInfoFB {
     XrStructureType type;
     void const * next;
     XrPassthroughFB passthrough;
     XrPassthroughFlagsFB flags;
     XrPassthroughLayerPurposeFB purpose;
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrPassthroughLayerCreateInfoFB	calloc()	Returns a new XrPassthroughLayerCreateInfoFB instance allocated with memCalloc.
static XrPassthroughLayerCreateInfoFB.Buffer	calloc(int capacity)	Returns a new XrPassthroughLayerCreateInfoFB.Buffer instance allocated with memCalloc.
static XrPassthroughLayerCreateInfoFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughLayerCreateInfoFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughLayerCreateInfoFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughLayerCreateInfoFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughLayerCreateInfoFB	create()	Returns a new XrPassthroughLayerCreateInfoFB instance allocated with BufferUtils.
static XrPassthroughLayerCreateInfoFB.Buffer	create(int capacity)	Returns a new XrPassthroughLayerCreateInfoFB.Buffer instance allocated with BufferUtils.
static XrPassthroughLayerCreateInfoFB	create(long address)	Returns a new XrPassthroughLayerCreateInfoFB instance for the specified memory address.
static XrPassthroughLayerCreateInfoFB.Buffer	create(long address, int capacity)	Create a XrPassthroughLayerCreateInfoFB.Buffer instance at the specified memory.
static @Nullable XrPassthroughLayerCreateInfoFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrPassthroughLayerCreateInfoFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()
XrPassthroughLayerCreateInfoFB	flags(long value)	Sets the specified value to the flags field.
static XrPassthroughLayerCreateInfoFB	malloc()	Returns a new XrPassthroughLayerCreateInfoFB instance allocated with memAlloc.
static XrPassthroughLayerCreateInfoFB.Buffer	malloc(int capacity)	Returns a new XrPassthroughLayerCreateInfoFB.Buffer instance allocated with memAlloc.
static XrPassthroughLayerCreateInfoFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughLayerCreateInfoFB.Buffer instance allocated on the specified MemoryStack.
static XrPassthroughLayerCreateInfoFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughLayerCreateInfoFB instance allocated on the specified MemoryStack.
long	next()
XrPassthroughLayerCreateInfoFB	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	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	npassthrough(long struct)	Unsafe version of passthrough().
static void	npassthrough(long struct, XrPassthroughFB value)	Unsafe version of passthrough.
static int	npurpose(long struct)	Unsafe version of purpose().
static void	npurpose(long struct, int value)	Unsafe version of purpose.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	passthrough()
XrPassthroughLayerCreateInfoFB	passthrough(XrPassthroughFB value)	Sets the specified value to the passthrough field.
int	purpose()
XrPassthroughLayerCreateInfoFB	purpose(int value)	Sets the specified value to the purpose field.
XrPassthroughLayerCreateInfoFB	set(int type, long next, XrPassthroughFB passthrough, long flags, int purpose)	Initializes this struct with the specified values.
XrPassthroughLayerCreateInfoFB	set(XrPassthroughLayerCreateInfoFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()
XrPassthroughLayerCreateInfoFB	type(int value)	Sets the specified value to the type field.
XrPassthroughLayerCreateInfoFB	type$Default()	Sets the TYPE_PASSTHROUGH_LAYER_CREATE_INFO_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.

PASSTHROUGH

public static final int PASSTHROUGH

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

PURPOSE

public static final int PURPOSE

The struct member offsets.

Constructor Details

XrPassthroughLayerCreateInfoFB

public XrPassthroughLayerCreateInfoFB(ByteBuffer container)

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

type

public int type()

Returns:

the value of the type field.

next

public long next()

Returns:

the value of the next field.

passthrough

public long passthrough()

Returns:

the value of the passthrough field.

flags

public long flags()

Returns:

the value of the flags field.

purpose

public int purpose()

Returns:

the value of the purpose field.

type

public XrPassthroughLayerCreateInfoFB type(int value)

Sets the specified value to the type field.

type$Default

public XrPassthroughLayerCreateInfoFB type$Default()

Sets the TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB value to the type field.

next

public XrPassthroughLayerCreateInfoFB next(long value)

Sets the specified value to the next field.

passthrough

public XrPassthroughLayerCreateInfoFB passthrough(XrPassthroughFB value)

Sets the specified value to the passthrough field.

flags

public XrPassthroughLayerCreateInfoFB flags(long value)

Sets the specified value to the flags field.

purpose

public XrPassthroughLayerCreateInfoFB purpose(int value)

Sets the specified value to the purpose field.

set

public XrPassthroughLayerCreateInfoFB set(int type,
 long next,
 XrPassthroughFB passthrough,
 long flags,
 int purpose)

Initializes this struct with the specified values.

set

public XrPassthroughLayerCreateInfoFB set(XrPassthroughLayerCreateInfoFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPassthroughLayerCreateInfoFB malloc()

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

calloc

public static XrPassthroughLayerCreateInfoFB calloc()

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

create

public static XrPassthroughLayerCreateInfoFB create()

Returns a new XrPassthroughLayerCreateInfoFB instance allocated with BufferUtils.

create

public static XrPassthroughLayerCreateInfoFB create(long address)

Returns a new XrPassthroughLayerCreateInfoFB instance for the specified memory address.

createSafe

public static @Nullable XrPassthroughLayerCreateInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPassthroughLayerCreateInfoFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPassthroughLayerCreateInfoFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPassthroughLayerCreateInfoFB.Buffer create(int capacity)

Returns a new XrPassthroughLayerCreateInfoFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPassthroughLayerCreateInfoFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPassthroughLayerCreateInfoFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npassthrough

public static long npassthrough(long struct)

Unsafe version of passthrough().

nflags

public static long nflags(long struct)

Unsafe version of flags().

npurpose

public static int npurpose(long struct)

Unsafe version of purpose().

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.

npassthrough

public static void npassthrough(long struct,
 XrPassthroughFB value)

Unsafe version of passthrough.

nflags

public static void nflags(long struct,
 long value)

Unsafe version of flags.

npurpose

public static void npurpose(long struct,
 int value)

Unsafe version of purpose.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate