Package org.lwjgl.openxr

Class XrPassthroughColorMapInterpolatedLutMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPassthroughColorMapInterpolatedLutMETA>

org.lwjgl.openxr.XrPassthroughColorMapInterpolatedLutMETA

All Implemented Interfaces:

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

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

A color map defined by the interpolation between two LUTs.

Description

XrPassthroughColorMapInterpolatedLutMETA lets applications apply the interpolation between two color LUTs to a passthrough layer. Applications may use this feature to smoothly transition between two color LUTs. Other Passthrough style elements (such as edges) must not be affected by color LUTs.

The blend between sourceColorLut and targetColorLut is computed as (1 - weight) * sourceColorLut [Cin] + weight * targetColorLut [Cin].

XrPassthroughColorMapInterpolatedLutMETA is provided in the next chain of XrPassthroughStyleFB when calling PassthroughLayerSetStyleFB. Subsequent calls to PassthroughLayerSetStyleFB with XrPassthroughColorMapInterpolatedLutMETA in the next chain update the color LUT for that layer. Subsequent calls to PassthroughLayerSetStyleFB without this XrPassthroughColorMapInterpolatedLutMETA (or XrPassthroughColorMapLutMETA) in the next chain disable color LUTs for that layer.

Valid Usage (Implicit)

• The XR_META_passthrough_color_lut extension must be enabled prior to using XrPassthroughColorMapInterpolatedLutMETA
• type must be TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• sourceColorLut must be a valid XrPassthroughColorLutMETA handle
• targetColorLut must be a valid XrPassthroughColorLutMETA handle
• Both of sourceColorLut and targetColorLut must have been created, allocated, or retrieved from the same XrPassthroughFB

Layout

 struct XrPassthroughColorMapInterpolatedLutMETA {
     XrStructureType type();
     void const * next();
     XrPassthroughColorLutMETA sourceColorLut();
     XrPassthroughColorLutMETA targetColorLut();
     float weight();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrPassthroughColorMapInterpolatedLutMETA	calloc()	Returns a new XrPassthroughColorMapInterpolatedLutMETA instance allocated with memCalloc.
static XrPassthroughColorMapInterpolatedLutMETA.Buffer	calloc(int capacity)	Returns a new XrPassthroughColorMapInterpolatedLutMETA.Buffer instance allocated with memCalloc.
static XrPassthroughColorMapInterpolatedLutMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapInterpolatedLutMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughColorMapInterpolatedLutMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapInterpolatedLutMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughColorMapInterpolatedLutMETA	create()	Returns a new XrPassthroughColorMapInterpolatedLutMETA instance allocated with BufferUtils.
static XrPassthroughColorMapInterpolatedLutMETA.Buffer	create(int capacity)	Returns a new XrPassthroughColorMapInterpolatedLutMETA.Buffer instance allocated with BufferUtils.
static XrPassthroughColorMapInterpolatedLutMETA	create(long address)	Returns a new XrPassthroughColorMapInterpolatedLutMETA instance for the specified memory address.
static XrPassthroughColorMapInterpolatedLutMETA.Buffer	create(long address, int capacity)	Create a XrPassthroughColorMapInterpolatedLutMETA.Buffer instance at the specified memory.
static @Nullable XrPassthroughColorMapInterpolatedLutMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrPassthroughColorMapInterpolatedLutMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrPassthroughColorMapInterpolatedLutMETA	malloc()	Returns a new XrPassthroughColorMapInterpolatedLutMETA instance allocated with memAlloc.
static XrPassthroughColorMapInterpolatedLutMETA.Buffer	malloc(int capacity)	Returns a new XrPassthroughColorMapInterpolatedLutMETA.Buffer instance allocated with memAlloc.
static XrPassthroughColorMapInterpolatedLutMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapInterpolatedLutMETA.Buffer instance allocated on the specified MemoryStack.
static XrPassthroughColorMapInterpolatedLutMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapInterpolatedLutMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrPassthroughColorMapInterpolatedLutMETA	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 long	nsourceColorLut(long struct)	Unsafe version of sourceColorLut().
static void	nsourceColorLut(long struct, XrPassthroughColorLutMETA value)	Unsafe version of sourceColorLut.
static long	ntargetColorLut(long struct)	Unsafe version of targetColorLut().
static void	ntargetColorLut(long struct, XrPassthroughColorLutMETA value)	Unsafe version of targetColorLut.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static float	nweight(long struct)	Unsafe version of weight().
static void	nweight(long struct, float value)	Unsafe version of weight.
XrPassthroughColorMapInterpolatedLutMETA	set(int type, long next, XrPassthroughColorLutMETA sourceColorLut, XrPassthroughColorLutMETA targetColorLut, float weight)	Initializes this struct with the specified values.
XrPassthroughColorMapInterpolatedLutMETA	set(XrPassthroughColorMapInterpolatedLutMETA src)	Copies the specified struct data to this struct.
int	sizeof()
long	sourceColorLut()	the initial XrPassthroughColorLutMETA.
XrPassthroughColorMapInterpolatedLutMETA	sourceColorLut(XrPassthroughColorLutMETA value)	Sets the specified value to the sourceColorLut() field.
long	targetColorLut()	the final XrPassthroughColorLutMETA.
XrPassthroughColorMapInterpolatedLutMETA	targetColorLut(XrPassthroughColorLutMETA value)	Sets the specified value to the targetColorLut() field.
int	type()	the XrStructureType of this structure.
XrPassthroughColorMapInterpolatedLutMETA	type(int value)	Sets the specified value to the type() field.
XrPassthroughColorMapInterpolatedLutMETA	type$Default()	Sets the TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
float	weight()	a factor in the range [0, 1] which defines the linear blend between the initial and the final color LUT.
XrPassthroughColorMapInterpolatedLutMETA	weight(float value)	Sets the specified value to the weight() 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.

SOURCECOLORLUT

public static final int SOURCECOLORLUT

The struct member offsets.

TARGETCOLORLUT

public static final int TARGETCOLORLUT

The struct member offsets.

WEIGHT

public static final int WEIGHT

The struct member offsets.

Constructor Details

XrPassthroughColorMapInterpolatedLutMETA

public XrPassthroughColorMapInterpolatedLutMETA(ByteBuffer container)

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

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.

sourceColorLut

public long sourceColorLut()

the initial XrPassthroughColorLutMETA.

targetColorLut

public long targetColorLut()

the final XrPassthroughColorLutMETA.

weight

public float weight()

a factor in the range [0, 1] which defines the linear blend between the initial and the final color LUT.

type

public XrPassthroughColorMapInterpolatedLutMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrPassthroughColorMapInterpolatedLutMETA type$Default()

Sets the TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META value to the type() field.

next

public XrPassthroughColorMapInterpolatedLutMETA next(long value)

Sets the specified value to the next() field.

sourceColorLut

public XrPassthroughColorMapInterpolatedLutMETA sourceColorLut(XrPassthroughColorLutMETA value)

Sets the specified value to the sourceColorLut() field.

targetColorLut

public XrPassthroughColorMapInterpolatedLutMETA targetColorLut(XrPassthroughColorLutMETA value)

Sets the specified value to the targetColorLut() field.

weight

public XrPassthroughColorMapInterpolatedLutMETA weight(float value)

Sets the specified value to the weight() field.

set

public XrPassthroughColorMapInterpolatedLutMETA set(int type,
 long next,
 XrPassthroughColorLutMETA sourceColorLut,
 XrPassthroughColorLutMETA targetColorLut,
 float weight)

Initializes this struct with the specified values.

set

public XrPassthroughColorMapInterpolatedLutMETA set(XrPassthroughColorMapInterpolatedLutMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPassthroughColorMapInterpolatedLutMETA malloc()

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

calloc

public static XrPassthroughColorMapInterpolatedLutMETA calloc()

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

create

public static XrPassthroughColorMapInterpolatedLutMETA create()

Returns a new XrPassthroughColorMapInterpolatedLutMETA instance allocated with BufferUtils.

create

public static XrPassthroughColorMapInterpolatedLutMETA create(long address)

Returns a new XrPassthroughColorMapInterpolatedLutMETA instance for the specified memory address.

createSafe

public static @Nullable XrPassthroughColorMapInterpolatedLutMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPassthroughColorMapInterpolatedLutMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPassthroughColorMapInterpolatedLutMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPassthroughColorMapInterpolatedLutMETA.Buffer create(int capacity)

Returns a new XrPassthroughColorMapInterpolatedLutMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPassthroughColorMapInterpolatedLutMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPassthroughColorMapInterpolatedLutMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsourceColorLut

public static long nsourceColorLut(long struct)

Unsafe version of sourceColorLut().

ntargetColorLut

public static long ntargetColorLut(long struct)

Unsafe version of targetColorLut().

nweight

public static float nweight(long struct)

Unsafe version of weight().

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.

nsourceColorLut

public static void nsourceColorLut(long struct,
 XrPassthroughColorLutMETA value)

Unsafe version of sourceColorLut.

ntargetColorLut

public static void ntargetColorLut(long struct,
 XrPassthroughColorLutMETA value)

Unsafe version of targetColorLut.

nweight

public static void nweight(long struct,
 float value)

Unsafe version of weight.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate