Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrPassthroughBrightnessContrastSaturationFB

extends Struct<XrPassthroughBrightnessContrastSaturationFB>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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:

XrPassthroughBrightnessContrastSaturationFB is provided in the next chain of XrPassthroughStyleFB.

Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BRIGHTNESS

The struct member offsets.

public static final int
CONTRAST

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SATURATION

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:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrPassthroughBrightnessContrastSaturationFB(ByteBuffer container)

Creates a XrPassthroughBrightnessContrastSaturationFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public float
brightness()

the brightness adjustment value in the range [-100, 100].

public XrPassthroughBrightnessContrastSaturationFB
brightness(float value)

Sets the specified value to the brightness field.

public static XrPassthroughBrightnessContrastSaturationFB
calloc()

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with memCalloc.

public static XrPassthroughBrightnessContrastSaturationFB.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with memCalloc.

public static XrPassthroughBrightnessContrastSaturationFB
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrPassthroughBrightnessContrastSaturationFB.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public float
contrast()

the contrast adjustment value in the range [0, Infinity].

public XrPassthroughBrightnessContrastSaturationFB
contrast(float value)

Sets the specified value to the contrast field.

protected XrPassthroughBrightnessContrastSaturationFB
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 XrPassthroughBrightnessContrastSaturationFB
create()

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with BufferUtils.

public static XrPassthroughBrightnessContrastSaturationFB
create(long address)

Returns a new XrPassthroughBrightnessContrastSaturationFB instance for the specified memory address.

public static XrPassthroughBrightnessContrastSaturationFB.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with BufferUtils.

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

Create a XrPassthroughBrightnessContrastSaturationFB.Buffer instance at the specified memory.

public static XrPassthroughBrightnessContrastSaturationFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrPassthroughBrightnessContrastSaturationFB
malloc()

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with memAlloc.

public static XrPassthroughBrightnessContrastSaturationFB.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with memAlloc.

public static XrPassthroughBrightnessContrastSaturationFB
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated on the specified MemoryStack.

public static XrPassthroughBrightnessContrastSaturationFB.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static float
nbrightness(long struct)

Unsafe version of brightness.

public static void
nbrightness(long struct, float value)

Unsafe version of brightness.

public static float
ncontrast(long struct)

Unsafe version of contrast.

public static void
ncontrast(long struct, float value)

Unsafe version of contrast.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrPassthroughBrightnessContrastSaturationFB
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static float
nsaturation(long struct)

Unsafe version of saturation.

public static void
nsaturation(long struct, float value)

Unsafe version of saturation.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public float
saturation()

the saturation adjustment value in the range [0, Infinity].

public XrPassthroughBrightnessContrastSaturationFB
saturation(float value)

Sets the specified value to the saturation field.

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

Initializes this struct with the specified values.

public XrPassthroughBrightnessContrastSaturationFB

Returns:

this struct
set
(XrPassthroughBrightnessContrastSaturationFB
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 XrPassthroughBrightnessContrastSaturationFB
type(int value)

Sets the specified value to the type field.

public XrPassthroughBrightnessContrastSaturationFB
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BRIGHTNESSback to summary
public static final int BRIGHTNESS

The struct member offsets.

CONTRASTback to summary
public static final int CONTRAST

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SATURATIONback to summary
public static final int SATURATION

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrPassthroughBrightnessContrastSaturationFBback to summary
protected XrPassthroughBrightnessContrastSaturationFB(long address, ByteBuffer container)
XrPassthroughBrightnessContrastSaturationFBback to summary
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 Detail

brightnessback to summary
public float brightness()

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

brightnessback to summary
public XrPassthroughBrightnessContrastSaturationFB brightness(float value)

Sets the specified value to the brightness field.

callocback to summary
public static XrPassthroughBrightnessContrastSaturationFB calloc()

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

callocback to summary
public static XrPassthroughBrightnessContrastSaturationFB.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrPassthroughBrightnessContrastSaturationFB calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrPassthroughBrightnessContrastSaturationFB.Buffer calloc(int capacity, MemoryStack stack)

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

contrastback to summary
public float contrast()

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

contrastback to summary
public XrPassthroughBrightnessContrastSaturationFB contrast(float value)

Sets the specified value to the contrast field.

createback to summary
protected XrPassthroughBrightnessContrastSaturationFB 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
createback to summary
public static XrPassthroughBrightnessContrastSaturationFB create()

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated with BufferUtils.

createback to summary
public static XrPassthroughBrightnessContrastSaturationFB create(long address)

Returns a new XrPassthroughBrightnessContrastSaturationFB instance for the specified memory address.

createback to summary
public static XrPassthroughBrightnessContrastSaturationFB.Buffer create(int capacity)

Returns a new XrPassthroughBrightnessContrastSaturationFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrPassthroughBrightnessContrastSaturationFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrPassthroughBrightnessContrastSaturationFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrPassthroughBrightnessContrastSaturationFB.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrPassthroughBrightnessContrastSaturationFB malloc()

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

mallocback to summary
public static XrPassthroughBrightnessContrastSaturationFB.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrPassthroughBrightnessContrastSaturationFB malloc(MemoryStack stack)

Returns a new XrPassthroughBrightnessContrastSaturationFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrPassthroughBrightnessContrastSaturationFB.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbrightnessback to summary
public static float nbrightness(long struct)

Unsafe version of brightness.

nbrightnessback to summary
public static void nbrightness(long struct, float value)

Unsafe version of brightness.

ncontrastback to summary
public static float ncontrast(long struct)

Unsafe version of contrast.

ncontrastback to summary
public static void ncontrast(long struct, float value)

Unsafe version of contrast.

nextback 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 *
nextback to summary
public XrPassthroughBrightnessContrastSaturationFB next(long value)

Sets the specified value to the next field.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nsaturationback to summary
public static float nsaturation(long struct)

Unsafe version of saturation.

nsaturationback to summary
public static void nsaturation(long struct, float value)

Unsafe version of saturation.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

saturationback to summary
public float saturation()

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

saturationback to summary
public XrPassthroughBrightnessContrastSaturationFB saturation(float value)

Sets the specified value to the saturation field.

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

Initializes this struct with the specified values.

setback to summary
public XrPassthroughBrightnessContrastSaturationFB set(XrPassthroughBrightnessContrastSaturationFB src)

Copies the specified struct data to this struct.

Parameters
src:XrPassthroughBrightnessContrastSaturationFB

the source struct

Returns:XrPassthroughBrightnessContrastSaturationFB

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrPassthroughBrightnessContrastSaturationFB type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrPassthroughBrightnessContrastSaturationFB type$Default()

Sets the TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB value to the type field.

org.lwjgl.openxr back to summary

public Class XrPassthroughBrightnessContrastSaturationFB.Buffer

extends StructBuffer<XrPassthroughBrightnessContrastSaturationFB, XrPassthroughBrightnessContrastSaturationFB.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrPassthroughBrightnessContrastSaturationFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrPassthroughBrightnessContrastSaturationFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrPassthroughBrightnessContrastSaturationFB.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 TypeMethod and Description
public float
public XrPassthroughBrightnessContrastSaturationFB.Buffer
brightness(float value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#brightness field.

public float
public XrPassthroughBrightnessContrastSaturationFB.Buffer
contrast(float value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#contrast field.

protected XrPassthroughBrightnessContrastSaturationFB
public long

Returns:

the value of the XrPassthroughBrightnessContrastSaturationFB#next field.
next
()

public XrPassthroughBrightnessContrastSaturationFB.Buffer
next(long value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#next field.

public float
public XrPassthroughBrightnessContrastSaturationFB.Buffer
saturation(float value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#saturation field.

protected XrPassthroughBrightnessContrastSaturationFB.Buffer
public int

Returns:

the value of the XrPassthroughBrightnessContrastSaturationFB#type field.
type
()

public XrPassthroughBrightnessContrastSaturationFB.Buffer
type(int value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#type field.

public XrPassthroughBrightnessContrastSaturationFB.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrPassthroughBrightnessContrastSaturationFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrPassthroughBrightnessContrastSaturationFB.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 XrPassthroughBrightnessContrastSaturationFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

brightnessback to summary
public float brightness()
Returns:float

the value of the XrPassthroughBrightnessContrastSaturationFB#brightness field.

brightnessback to summary
public XrPassthroughBrightnessContrastSaturationFB.Buffer brightness(float value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#brightness field.

contrastback to summary
public float contrast()
Returns:float

the value of the XrPassthroughBrightnessContrastSaturationFB#contrast field.

contrastback to summary
public XrPassthroughBrightnessContrastSaturationFB.Buffer contrast(float value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#contrast field.

getElementFactoryback to summary
protected XrPassthroughBrightnessContrastSaturationFB getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrPassthroughBrightnessContrastSaturationFB#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrPassthroughBrightnessContrastSaturationFB.Buffer next(long value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#next field.

saturationback to summary
public float saturation()
Returns:float

the value of the XrPassthroughBrightnessContrastSaturationFB#saturation field.

saturationback to summary
public XrPassthroughBrightnessContrastSaturationFB.Buffer saturation(float value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#saturation field.

selfback to summary
protected XrPassthroughBrightnessContrastSaturationFB.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrPassthroughBrightnessContrastSaturationFB#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrPassthroughBrightnessContrastSaturationFB.Buffer type(int value)

Sets the specified value to the XrPassthroughBrightnessContrastSaturationFB#type field.

type$Defaultback to summary
public XrPassthroughBrightnessContrastSaturationFB.Buffer type$Default()

Sets the TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB value to the XrPassthroughBrightnessContrastSaturationFB#type field.