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

Layout


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

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	LAYERFLAGS 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	XrCompositionLayerSettingsFB(long address, ByteBuffer container)
public	XrCompositionLayerSettingsFB(ByteBuffer container) Creates a `XrCompositionLayerSettingsFB` instance at the current position of the specified `ByteBuffer` container.

Method Summary

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

Field Detail

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

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

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

XrCompositionLayerSettingsFB back to summary

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

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 Detail

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

calloc back to summary

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

public static XrCompositionLayerSettingsFB.Buffer calloc(int capacity)

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

public static XrCompositionLayerSettingsFB calloc(MemoryStack stack)

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

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

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

create back to summary

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

public static XrCompositionLayerSettingsFB.Buffer create(int capacity)

Returns a new XrCompositionLayerSettingsFB.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static XrCompositionLayerSettingsFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

layerFlags	back to summary
public XrCompositionLayerSettingsFB layerFlags(long value) Sets the specified value to the `layerFlags` field.

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

malloc back to summary

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

public static XrCompositionLayerSettingsFB.Buffer malloc(int capacity)

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

public static XrCompositionLayerSettingsFB malloc(MemoryStack stack)

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

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

Returns a new XrCompositionLayerSettingsFB.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 XrCompositionLayerSettingsFB next(long value) Sets the specified value to the `next` field.

nlayerFlags	back to summary
public static long nlayerFlags(long struct) Unsafe version of `layerFlags`.

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

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 XrCompositionLayerSettingsFB set(int type, long next, long layerFlags) Initializes this struct with the specified values.

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

set

back to summary

public XrCompositionLayerSettingsFB set(XrCompositionLayerSettingsFB src)

Copies the specified struct data to this struct.

Parameters

src:XrCompositionLayerSettingsFB: the source struct

Returns:XrCompositionLayerSettingsFB

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 XrCompositionLayerSettingsFB type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrCompositionLayerSettingsFB type$Default() Sets the `TYPE_COMPOSITION_LAYER_SETTINGS_FB` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrCompositionLayerSettingsFB.Buffer

Class Inheritance

extends StructBuffer<XrCompositionLayerSettingsFB, XrCompositionLayerSettingsFB.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of XrCompositionLayerSettingsFB structs.

Field Summary

Modifier and Type	Field and Description
private static final XrCompositionLayerSettingsFB	ELEMENT_FACTORY

Constructor Summary

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

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrCompositionLayerSettingsFB.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 `XrCompositionLayerSettingsFB#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 XrCompositionLayerSettingsFB.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 XrCompositionLayerSettingsFB#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

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

getElementFactory

back to summary

protected XrCompositionLayerSettingsFB getElementFactory()

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

Annotations

@Override

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

layerFlags	back to summary
public XrCompositionLayerSettingsFB.Buffer layerFlags(long value) Sets the specified value to the `layerFlags` field.

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

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

self

back to summary

protected XrCompositionLayerSettingsFB.Buffer self()

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

Annotations

@Override

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

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

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

public Class XrCompositionLayerSettingsFB

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

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail