Package org.lwjgl.openxr

Class XrCompositionLayerSettingsFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerSettingsFB>

org.lwjgl.openxr.XrCompositionLayerSettingsFB

All Implemented Interfaces:

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

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

specifies processing options for composition layers.

Description

XrCompositionLayerSettingsFB contains additional flags to indicate which processing steps to perform on a composition layer.

If both COMPOSITION_LAYER_SETTINGS_NORMAL_SUPER_SAMPLING_BIT_FB and COMPOSITION_LAYER_SETTINGS_QUALITY_SUPER_SAMPLING_BIT_FB are set, COMPOSITION_LAYER_SETTINGS_NORMAL_SUPER_SAMPLING_BIT_FB will take precedence.

If both COMPOSITION_LAYER_SETTINGS_NORMAL_SHARPENING_BIT_FB and COMPOSITION_LAYER_SETTINGS_QUALITY_SHARPENING_BIT_FB are set, COMPOSITION_LAYER_SETTINGS_NORMAL_SHARPENING_BIT_FB will take precedence.

To specify the additional flags, create an XrCompositionLayerSettingsFB structure and pass it via the XrCompositionLayerBaseHeader structure’s next parameter.

Valid Usage (Implicit)

• The XR_FB_composition_layer_settings extension must be enabled prior to using XrCompositionLayerSettingsFB
• type must be TYPE_COMPOSITION_LAYER_SETTINGS_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• layerFlags must be a valid combination of XrCompositionLayerSettingsFlagBitsFB values
• layerFlags must not be 0

See Also

XrCompositionLayerBaseHeader

Layout

 struct XrCompositionLayerSettingsFB {
     XrStructureType type();
     void const * next();
     XrCompositionLayerSettingsFlagsFB layerFlags();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

LAYERFLAGS

public static final int LAYERFLAGS

The struct member offsets.

Constructor Details

XrCompositionLayerSettingsFB

public XrCompositionLayerSettingsFB(ByteBuffer container)

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

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.

layerFlags

public long layerFlags()

a bitmask of XrCompositionLayerSettingsFlagBitsFB.

type

public XrCompositionLayerSettingsFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerSettingsFB type$Default()

Sets the TYPE_COMPOSITION_LAYER_SETTINGS_FB value to the type() field.

next

public XrCompositionLayerSettingsFB next(long value)

Sets the specified value to the next() field.

layerFlags

public XrCompositionLayerSettingsFB layerFlags(long value)

Sets the specified value to the layerFlags() field.

set

public XrCompositionLayerSettingsFB set(int type,
 long next,
 long layerFlags)

Initializes this struct with the specified values.

set

public XrCompositionLayerSettingsFB set(XrCompositionLayerSettingsFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerSettingsFB malloc()

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

calloc

public static XrCompositionLayerSettingsFB calloc()

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

create

public static XrCompositionLayerSettingsFB create()

Returns a new XrCompositionLayerSettingsFB instance allocated with BufferUtils.

create

public static XrCompositionLayerSettingsFB create(long address)

Returns a new XrCompositionLayerSettingsFB instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerSettingsFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerSettingsFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerSettingsFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerSettingsFB.Buffer create(int capacity)

Returns a new XrCompositionLayerSettingsFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerSettingsFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerSettingsFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlayerFlags

public static long nlayerFlags(long struct)

Unsafe version of layerFlags().

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.

nlayerFlags

public static void nlayerFlags(long struct,
 long value)

Unsafe version of layerFlags.