Package org.lwjgl.openxr

Class XrPassthroughBrightnessContrastSaturationFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPassthroughBrightnessContrastSaturationFB>

org.lwjgl.openxr.XrPassthroughBrightnessContrastSaturationFB

All Implemented Interfaces:

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

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

A color adjustment for passthrough layers.

Description

XrPassthroughBrightnessContrastSaturationFB lets applications adjust the brightness, contrast, and saturation of passthrough layers. The adjustments only are applied before any additional effects (such as edges) are rendered on top.

The adjustments are applied in CIELAB color space (white point D65) using the following formulas:

• L*' = clamp((L* - 50) × contrast + 50, 0, 100)
• L*'' = clamp(L*' + brightness, 0, 100)
• (a*', b*') = (a*, b*) × saturation
• Resulting color: (L*'', a*', b*')

XrPassthroughBrightnessContrastSaturationFB is provided in the next chain of XrPassthroughStyleFB.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to using XrPassthroughBrightnessContrastSaturationFB
• type must be TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

Layout

 struct XrPassthroughBrightnessContrastSaturationFB {
     XrStructureType type();
     void const * next();
     float brightness();
     float contrast();
     float saturation();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
float	brightness()	the brightness adjustment value in the range [-100, 100].
XrPassthroughBrightnessContrastSaturationFB	brightness(float value)	Sets the specified value to the brightness() field.
static XrPassthroughBrightnessContrastSaturationFB	calloc()	Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with memCalloc.
static XrPassthroughBrightnessContrastSaturationFB.Buffer	calloc(int capacity)	Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with memCalloc.
static XrPassthroughBrightnessContrastSaturationFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughBrightnessContrastSaturationFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
float	contrast()	the contrast adjustment value in the range [0, Infinity].
XrPassthroughBrightnessContrastSaturationFB	contrast(float value)	Sets the specified value to the contrast() field.
static XrPassthroughBrightnessContrastSaturationFB	create()	Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with BufferUtils.
static XrPassthroughBrightnessContrastSaturationFB.Buffer	create(int capacity)	Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with BufferUtils.
static XrPassthroughBrightnessContrastSaturationFB	create(long address)	Returns a new XrPassthroughBrightnessContrastSaturationFB instance for the specified memory address.
static XrPassthroughBrightnessContrastSaturationFB.Buffer	create(long address, int capacity)	Create a XrPassthroughBrightnessContrastSaturationFB.Buffer instance at the specified memory.
static @Nullable XrPassthroughBrightnessContrastSaturationFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrPassthroughBrightnessContrastSaturationFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrPassthroughBrightnessContrastSaturationFB	malloc()	Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with memAlloc.
static XrPassthroughBrightnessContrastSaturationFB.Buffer	malloc(int capacity)	Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with memAlloc.
static XrPassthroughBrightnessContrastSaturationFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated on the specified MemoryStack.
static XrPassthroughBrightnessContrastSaturationFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated on the specified MemoryStack.
static float	nbrightness(long struct)	Unsafe version of brightness().
static void	nbrightness(long struct, float value)	Unsafe version of brightness.
static float	ncontrast(long struct)	Unsafe version of contrast().
static void	ncontrast(long struct, float value)	Unsafe version of contrast.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrPassthroughBrightnessContrastSaturationFB	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static float	nsaturation(long struct)	Unsafe version of saturation().
static void	nsaturation(long struct, float value)	Unsafe version of saturation.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
float	saturation()	the saturation adjustment value in the range [0, Infinity].
XrPassthroughBrightnessContrastSaturationFB	saturation(float value)	Sets the specified value to the saturation() field.
XrPassthroughBrightnessContrastSaturationFB	set(int type, long next, float brightness, float contrast, float saturation)	Initializes this struct with the specified values.
XrPassthroughBrightnessContrastSaturationFB	set(XrPassthroughBrightnessContrastSaturationFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrPassthroughBrightnessContrastSaturationFB	type(int value)	Sets the specified value to the type() field.
XrPassthroughBrightnessContrastSaturationFB	type$Default()	Sets the TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_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.

BRIGHTNESS

public static final int BRIGHTNESS

The struct member offsets.

CONTRAST

public static final int CONTRAST

The struct member offsets.

SATURATION

public static final int SATURATION

The struct member offsets.

Constructor Details

XrPassthroughBrightnessContrastSaturationFB

public XrPassthroughBrightnessContrastSaturationFB(ByteBuffer container)

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

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.

brightness

public float brightness()

the brightness adjustment value in the range [-100, 100]. The neutral element is 0.

contrast

public float contrast()

the contrast adjustment value in the range [0, Infinity]. The neutral element is 1.

saturation

public float saturation()

the saturation adjustment value in the range [0, Infinity]. The neutral element is 1.

type

public XrPassthroughBrightnessContrastSaturationFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrPassthroughBrightnessContrastSaturationFB type$Default()

Sets the TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB value to the type() field.

next

public XrPassthroughBrightnessContrastSaturationFB next(long value)

Sets the specified value to the next() field.

brightness

public XrPassthroughBrightnessContrastSaturationFB brightness(float value)

Sets the specified value to the brightness() field.

contrast

public XrPassthroughBrightnessContrastSaturationFB contrast(float value)

Sets the specified value to the contrast() field.

saturation

public XrPassthroughBrightnessContrastSaturationFB saturation(float value)

Sets the specified value to the saturation() field.

set

public XrPassthroughBrightnessContrastSaturationFB set(int type,
 long next,
 float brightness,
 float contrast,
 float saturation)

Initializes this struct with the specified values.

set

public XrPassthroughBrightnessContrastSaturationFB set(XrPassthroughBrightnessContrastSaturationFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPassthroughBrightnessContrastSaturationFB malloc()

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

calloc

public static XrPassthroughBrightnessContrastSaturationFB calloc()

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

create

public static XrPassthroughBrightnessContrastSaturationFB create()

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with BufferUtils.

create

public static XrPassthroughBrightnessContrastSaturationFB create(long address)

Returns a new XrPassthroughBrightnessContrastSaturationFB instance for the specified memory address.

createSafe

public static @Nullable XrPassthroughBrightnessContrastSaturationFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPassthroughBrightnessContrastSaturationFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPassthroughBrightnessContrastSaturationFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPassthroughBrightnessContrastSaturationFB.Buffer create(int capacity)

Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPassthroughBrightnessContrastSaturationFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbrightness

public static float nbrightness(long struct)

Unsafe version of brightness().

ncontrast

public static float ncontrast(long struct)

Unsafe version of contrast().

nsaturation

public static float nsaturation(long struct)

Unsafe version of saturation().

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.

nbrightness

public static void nbrightness(long struct,
 float value)

Unsafe version of brightness.

ncontrast

public static void ncontrast(long struct,
 float value)

Unsafe version of contrast.

nsaturation

public static void nsaturation(long struct,
 float value)

Unsafe version of saturation.