Package org.lwjgl.openxr

Class XrPassthroughStyleFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPassthroughStyleFB>

org.lwjgl.openxr.XrPassthroughStyleFB

All Implemented Interfaces:

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

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

A layer style.

Description

XrPassthroughStyleFB lets applications customize the appearance of passthrough layers. In addition to the parameters specified here, applications may add one of the following structures to the structure chain: XrPassthroughColorMapMonoToRgbaFB, XrPassthroughColorMapMonoToMonoFB, XrPassthroughBrightnessContrastSaturationFB. These structures are mutually exclusive. The runtime must return ERROR_VALIDATION_FAILURE if more than one of them are present in the structure chain.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to using XrPassthroughStyleFB
• type must be TYPE_PASSTHROUGH_STYLE_FB
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrPassthroughBrightnessContrastSaturationFB, XrPassthroughColorMapInterpolatedLutMETA, XrPassthroughColorMapLutMETA, XrPassthroughColorMapMonoToMonoFB, XrPassthroughColorMapMonoToRgbaFB

See Also

XrColor4f, PassthroughLayerSetStyleFB

Layout

 struct XrPassthroughStyleFB {
     XrStructureType type();
     void const * next();
     float textureOpacityFactor();
     XrColor4f edgeColor();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrPassthroughStyleFB	calloc()	Returns a new XrPassthroughStyleFB instance allocated with memCalloc.
static XrPassthroughStyleFB.Buffer	calloc(int capacity)	Returns a new XrPassthroughStyleFB.Buffer instance allocated with memCalloc.
static XrPassthroughStyleFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughStyleFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughStyleFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughStyleFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughStyleFB	create()	Returns a new XrPassthroughStyleFB instance allocated with BufferUtils.
static XrPassthroughStyleFB.Buffer	create(int capacity)	Returns a new XrPassthroughStyleFB.Buffer instance allocated with BufferUtils.
static XrPassthroughStyleFB	create(long address)	Returns a new XrPassthroughStyleFB instance for the specified memory address.
static XrPassthroughStyleFB.Buffer	create(long address, int capacity)	Create a XrPassthroughStyleFB.Buffer instance at the specified memory.
static @Nullable XrPassthroughStyleFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrPassthroughStyleFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrColor4f	edgeColor()	the XrColor4f that defines the edge rendering color.
XrPassthroughStyleFB	edgeColor(Consumer<XrColor4f> consumer)	Passes the edgeColor() field to the specified Consumer.
XrPassthroughStyleFB	edgeColor(XrColor4f value)	Copies the specified XrColor4f to the edgeColor() field.
static XrPassthroughStyleFB	malloc()	Returns a new XrPassthroughStyleFB instance allocated with memAlloc.
static XrPassthroughStyleFB.Buffer	malloc(int capacity)	Returns a new XrPassthroughStyleFB.Buffer instance allocated with memAlloc.
static XrPassthroughStyleFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughStyleFB.Buffer instance allocated on the specified MemoryStack.
static XrPassthroughStyleFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughStyleFB instance allocated on the specified MemoryStack.
static XrColor4f	nedgeColor(long struct)	Unsafe version of edgeColor().
static void	nedgeColor(long struct, XrColor4f value)	Unsafe version of edgeColor.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrPassthroughStyleFB	next(long value)	Sets the specified value to the next() field.
XrPassthroughStyleFB	next(XrPassthroughBrightnessContrastSaturationFB value)	Prepends the specified XrPassthroughBrightnessContrastSaturationFB value to the next chain.
XrPassthroughStyleFB	next(XrPassthroughColorMapInterpolatedLutMETA value)	Prepends the specified XrPassthroughColorMapInterpolatedLutMETA value to the next chain.
XrPassthroughStyleFB	next(XrPassthroughColorMapLutMETA value)	Prepends the specified XrPassthroughColorMapLutMETA value to the next chain.
XrPassthroughStyleFB	next(XrPassthroughColorMapMonoToMonoFB value)	Prepends the specified XrPassthroughColorMapMonoToMonoFB value to the next chain.
XrPassthroughStyleFB	next(XrPassthroughColorMapMonoToRgbaFB value)	Prepends the specified XrPassthroughColorMapMonoToRgbaFB value to the next chain.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static float	ntextureOpacityFactor(long struct)	Unsafe version of textureOpacityFactor().
static void	ntextureOpacityFactor(long struct, float value)	Unsafe version of textureOpacityFactor.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrPassthroughStyleFB	set(int type, long next, float textureOpacityFactor, XrColor4f edgeColor)	Initializes this struct with the specified values.
XrPassthroughStyleFB	set(XrPassthroughStyleFB src)	Copies the specified struct data to this struct.
int	sizeof()
float	textureOpacityFactor()	the opacity of the passthrough imagery in the range [0, 1].
XrPassthroughStyleFB	textureOpacityFactor(float value)	Sets the specified value to the textureOpacityFactor() field.
int	type()	the XrStructureType of this structure.
XrPassthroughStyleFB	type(int value)	Sets the specified value to the type() field.
XrPassthroughStyleFB	type$Default()	Sets the TYPE_PASSTHROUGH_STYLE_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.

TEXTUREOPACITYFACTOR

public static final int TEXTUREOPACITYFACTOR

The struct member offsets.

EDGECOLOR

public static final int EDGECOLOR

The struct member offsets.

Constructor Details

XrPassthroughStyleFB

public XrPassthroughStyleFB(ByteBuffer container)

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

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.

textureOpacityFactor

public float textureOpacityFactor()

the opacity of the passthrough imagery in the range [0, 1].

edgeColor

public XrColor4f edgeColor()

the XrColor4f that defines the edge rendering color. Edges are detected in the original passthrough imagery and rendered on top of it. Edge rendering is disabled when the alpha value of edgeColor is zero.

type

public XrPassthroughStyleFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrPassthroughStyleFB type$Default()

Sets the TYPE_PASSTHROUGH_STYLE_FB value to the type() field.

next

public XrPassthroughStyleFB next(long value)

Sets the specified value to the next() field.

next

public XrPassthroughStyleFB next(XrPassthroughBrightnessContrastSaturationFB value)

Prepends the specified XrPassthroughBrightnessContrastSaturationFB value to the next chain.

next

public XrPassthroughStyleFB next(XrPassthroughColorMapInterpolatedLutMETA value)

Prepends the specified XrPassthroughColorMapInterpolatedLutMETA value to the next chain.

next

public XrPassthroughStyleFB next(XrPassthroughColorMapLutMETA value)

Prepends the specified XrPassthroughColorMapLutMETA value to the next chain.

next

public XrPassthroughStyleFB next(XrPassthroughColorMapMonoToMonoFB value)

Prepends the specified XrPassthroughColorMapMonoToMonoFB value to the next chain.

next

public XrPassthroughStyleFB next(XrPassthroughColorMapMonoToRgbaFB value)

Prepends the specified XrPassthroughColorMapMonoToRgbaFB value to the next chain.

textureOpacityFactor

public XrPassthroughStyleFB textureOpacityFactor(float value)

Sets the specified value to the textureOpacityFactor() field.

edgeColor

public XrPassthroughStyleFB edgeColor(XrColor4f value)

Copies the specified XrColor4f to the edgeColor() field.

edgeColor

public XrPassthroughStyleFB edgeColor(Consumer<XrColor4f> consumer)

Passes the edgeColor() field to the specified Consumer.

set

public XrPassthroughStyleFB set(int type,
 long next,
 float textureOpacityFactor,
 XrColor4f edgeColor)

Initializes this struct with the specified values.

set

public XrPassthroughStyleFB set(XrPassthroughStyleFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPassthroughStyleFB malloc()

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

calloc

public static XrPassthroughStyleFB calloc()

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

create

public static XrPassthroughStyleFB create()

Returns a new XrPassthroughStyleFB instance allocated with BufferUtils.

create

public static XrPassthroughStyleFB create(long address)

Returns a new XrPassthroughStyleFB instance for the specified memory address.

createSafe

public static @Nullable XrPassthroughStyleFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPassthroughStyleFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPassthroughStyleFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPassthroughStyleFB.Buffer create(int capacity)

Returns a new XrPassthroughStyleFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPassthroughStyleFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPassthroughStyleFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntextureOpacityFactor

public static float ntextureOpacityFactor(long struct)

Unsafe version of textureOpacityFactor().

nedgeColor

public static XrColor4f nedgeColor(long struct)

Unsafe version of edgeColor().

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.

ntextureOpacityFactor

public static void ntextureOpacityFactor(long struct,
 float value)

Unsafe version of textureOpacityFactor.

nedgeColor

public static void nedgeColor(long struct,
 XrColor4f value)

Unsafe version of edgeColor.