Package org.lwjgl.openxr

Class XrPassthroughColorMapLutMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPassthroughColorMapLutMETA>

org.lwjgl.openxr.XrPassthroughColorMapLutMETA

All Implemented Interfaces:

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

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

A color map defined by a LUT.

Description

XrPassthroughColorMapLutMETA lets applications apply a color LUT to a passthrough layer. Other Passthrough style elements (such as edges) must not be affected by color LUTs.

Applications may use weight to efficiently blend between the original colors and the mapped colors. The blend is computed as (1 - weight) * Cin + weight * colorLut [Cin].

XrPassthroughColorMapLutMETA is provided in the next chain of XrPassthroughStyleFB when calling PassthroughLayerSetStyleFB. Subsequent calls to PassthroughLayerSetStyleFB with XrPassthroughColorMapLutMETA in the next chain update the color LUT for that layer. Subsequent calls to PassthroughLayerSetStyleFB without this XrPassthroughColorMapLutMETA (or XrPassthroughColorMapInterpolatedLutMETA) 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 XrPassthroughColorMapLutMETA
• type must be TYPE_PASSTHROUGH_COLOR_MAP_LUT_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• colorLut must be a valid XrPassthroughColorLutMETA handle

Layout

 struct XrPassthroughColorMapLutMETA {
     XrStructureType type();
     void const * next();
     XrPassthroughColorLutMETA colorLut();
     float weight();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrPassthroughColorMapLutMETA	calloc()	Returns a new XrPassthroughColorMapLutMETA instance allocated with memCalloc.
static XrPassthroughColorMapLutMETA.Buffer	calloc(int capacity)	Returns a new XrPassthroughColorMapLutMETA.Buffer instance allocated with memCalloc.
static XrPassthroughColorMapLutMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapLutMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPassthroughColorMapLutMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapLutMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
long	colorLut()	an XrPassthroughColorLutMETA.
XrPassthroughColorMapLutMETA	colorLut(XrPassthroughColorLutMETA value)	Sets the specified value to the colorLut() field.
static XrPassthroughColorMapLutMETA	create()	Returns a new XrPassthroughColorMapLutMETA instance allocated with BufferUtils.
static XrPassthroughColorMapLutMETA.Buffer	create(int capacity)	Returns a new XrPassthroughColorMapLutMETA.Buffer instance allocated with BufferUtils.
static XrPassthroughColorMapLutMETA	create(long address)	Returns a new XrPassthroughColorMapLutMETA instance for the specified memory address.
static XrPassthroughColorMapLutMETA.Buffer	create(long address, int capacity)	Create a XrPassthroughColorMapLutMETA.Buffer instance at the specified memory.
static @Nullable XrPassthroughColorMapLutMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrPassthroughColorMapLutMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrPassthroughColorMapLutMETA	malloc()	Returns a new XrPassthroughColorMapLutMETA instance allocated with memAlloc.
static XrPassthroughColorMapLutMETA.Buffer	malloc(int capacity)	Returns a new XrPassthroughColorMapLutMETA.Buffer instance allocated with memAlloc.
static XrPassthroughColorMapLutMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapLutMETA.Buffer instance allocated on the specified MemoryStack.
static XrPassthroughColorMapLutMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPassthroughColorMapLutMETA instance allocated on the specified MemoryStack.
static long	ncolorLut(long struct)	Unsafe version of colorLut().
static void	ncolorLut(long struct, XrPassthroughColorLutMETA value)	Unsafe version of colorLut.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrPassthroughColorMapLutMETA	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 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.
XrPassthroughColorMapLutMETA	set(int type, long next, XrPassthroughColorLutMETA colorLut, float weight)	Initializes this struct with the specified values.
XrPassthroughColorMapLutMETA	set(XrPassthroughColorMapLutMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrPassthroughColorMapLutMETA	type(int value)	Sets the specified value to the type() field.
XrPassthroughColorMapLutMETA	type$Default()	Sets the TYPE_PASSTHROUGH_COLOR_MAP_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 original and the mapped colors for the output color.
XrPassthroughColorMapLutMETA	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.

COLORLUT

public static final int COLORLUT

The struct member offsets.

WEIGHT

public static final int WEIGHT

The struct member offsets.

Constructor Details

XrPassthroughColorMapLutMETA

public XrPassthroughColorMapLutMETA(ByteBuffer container)

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

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.

colorLut

public long colorLut()

an XrPassthroughColorLutMETA.

weight

public float weight()

a factor in the range [0, 1] which defines the linear blend between the original and the mapped colors for the output color.

type

public XrPassthroughColorMapLutMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrPassthroughColorMapLutMETA type$Default()

Sets the TYPE_PASSTHROUGH_COLOR_MAP_LUT_META value to the type() field.

next

public XrPassthroughColorMapLutMETA next(long value)

Sets the specified value to the next() field.

colorLut

public XrPassthroughColorMapLutMETA colorLut(XrPassthroughColorLutMETA value)

Sets the specified value to the colorLut() field.

weight

public XrPassthroughColorMapLutMETA weight(float value)

Sets the specified value to the weight() field.

set

public XrPassthroughColorMapLutMETA set(int type,
 long next,
 XrPassthroughColorLutMETA colorLut,
 float weight)

Initializes this struct with the specified values.

set

public XrPassthroughColorMapLutMETA set(XrPassthroughColorMapLutMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPassthroughColorMapLutMETA malloc()

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

calloc

public static XrPassthroughColorMapLutMETA calloc()

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

create

public static XrPassthroughColorMapLutMETA create()

Returns a new XrPassthroughColorMapLutMETA instance allocated with BufferUtils.

create

public static XrPassthroughColorMapLutMETA create(long address)

Returns a new XrPassthroughColorMapLutMETA instance for the specified memory address.

createSafe

public static @Nullable XrPassthroughColorMapLutMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPassthroughColorMapLutMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPassthroughColorMapLutMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPassthroughColorMapLutMETA.Buffer create(int capacity)

Returns a new XrPassthroughColorMapLutMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPassthroughColorMapLutMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPassthroughColorMapLutMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncolorLut

public static long ncolorLut(long struct)

Unsafe version of colorLut().

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.

ncolorLut

public static void ncolorLut(long struct,
 XrPassthroughColorLutMETA value)

Unsafe version of colorLut.

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