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) * C_in + weight * colorLut[C_in].

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 and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrPassthroughColorMapLutMETA.Buffer An array of `XrPassthroughColorMapLutMETA` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	COLORLUT The struct member offsets.
public static final int	NEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	TYPE The struct member offsets.
public static final int	WEIGHT The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrPassthroughColorMapLutMETA(long address, ByteBuffer container)
public	XrPassthroughColorMapLutMETA(ByteBuffer container) Creates a `XrPassthroughColorMapLutMETA` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrPassthroughColorMapLutMETA	calloc() Returns a new `XrPassthroughColorMapLutMETA` instance allocated with `memCalloc`.
public static XrPassthroughColorMapLutMETA.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated with `memCalloc`.
public static XrPassthroughColorMapLutMETA	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughColorMapLutMETA` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrPassthroughColorMapLutMETA.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public long	colorLut() an `XrPassthroughColorLutMETA`.
public XrPassthroughColorMapLutMETA	colorLut(XrPassthroughColorLutMETA value) Sets the specified value to the `colorLut` field.
protected XrPassthroughColorMapLutMETA	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 XrPassthroughColorMapLutMETA	create() Returns a new `XrPassthroughColorMapLutMETA` instance allocated with `BufferUtils`.
public static XrPassthroughColorMapLutMETA	create(long address) Returns a new `XrPassthroughColorMapLutMETA` instance for the specified memory address.
public static XrPassthroughColorMapLutMETA.Buffer	create(int the buffer capacity capacity) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated with `BufferUtils`.
public static XrPassthroughColorMapLutMETA.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrPassthroughColorMapLutMETA.Buffer` instance at the specified memory.
public static XrPassthroughColorMapLutMETA	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrPassthroughColorMapLutMETA.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static XrPassthroughColorMapLutMETA	malloc() Returns a new `XrPassthroughColorMapLutMETA` instance allocated with `memAlloc`.
public static XrPassthroughColorMapLutMETA.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated with `memAlloc`.
public static XrPassthroughColorMapLutMETA	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughColorMapLutMETA` instance allocated on the specified `MemoryStack`.
public static XrPassthroughColorMapLutMETA.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated on the specified `MemoryStack`.
public static long	ncolorLut(long struct) Unsafe version of `colorLut`.
public static void	ncolorLut(long struct, XrPassthroughColorLutMETA value) Unsafe version of `colorLut`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrPassthroughColorMapLutMETA	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 int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public static float	nweight(long struct) Unsafe version of `weight`.
public static void	nweight(long struct, float value) Unsafe version of `weight`.
public XrPassthroughColorMapLutMETA	set(int type, long next, XrPassthroughColorLutMETA colorLut, float weight) Initializes this struct with the specified values.
public XrPassthroughColorMapLutMETA	Returns: this struct set(XrPassthroughColorMapLutMETA 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 XrPassthroughColorMapLutMETA	type(int value) Sets the specified value to the `type` field.
public XrPassthroughColorMapLutMETA	type$Default() Sets the `TYPE_PASSTHROUGH_COLOR_MAP_LUT_META` value to the `type` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.
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.
public XrPassthroughColorMapLutMETA	weight(float value) Sets the specified value to the `weight` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

COLORLUT	back to summary
public static final int COLORLUT The struct member offsets.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

WEIGHT	back to summary
public static final int WEIGHT The struct member offsets.

Constructor Detail

XrPassthroughColorMapLutMETA	back to summary
protected XrPassthroughColorMapLutMETA(long address, ByteBuffer container)

XrPassthroughColorMapLutMETA back to summary

XrPassthroughColorMapLutMETA	back to summary
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.

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 Detail

calloc	back to summary
public static XrPassthroughColorMapLutMETA calloc() Returns a new `XrPassthroughColorMapLutMETA` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrPassthroughColorMapLutMETA.Buffer calloc(int capacity) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrPassthroughColorMapLutMETA.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrPassthroughColorMapLutMETA calloc(MemoryStack stack) Returns a new `XrPassthroughColorMapLutMETA` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrPassthroughColorMapLutMETA calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrPassthroughColorMapLutMETA.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrPassthroughColorMapLutMETA.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

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

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

colorLut back to summary

colorLut	back to summary
public long colorLut() an `XrPassthroughColorLutMETA`. Annotations @NativeType:XrPassthroughColorLutMETA

public long colorLut()

an XrPassthroughColorLutMETA.

Annotations

@NativeType:XrPassthroughColorLutMETA

colorLut	back to summary
public XrPassthroughColorMapLutMETA colorLut(XrPassthroughColorLutMETA value) Sets the specified value to the `colorLut` field.

create back to summary

create	back to summary
protected XrPassthroughColorMapLutMETA 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

protected XrPassthroughColorMapLutMETA 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

create	back to summary
public static XrPassthroughColorMapLutMETA create() Returns a new `XrPassthroughColorMapLutMETA` instance allocated with `BufferUtils`.

create	back to summary
public static XrPassthroughColorMapLutMETA create(long address) Returns a new `XrPassthroughColorMapLutMETA` instance for the specified memory address.

create back to summary

create	back to summary
public static XrPassthroughColorMapLutMETA.Buffer create(int capacity) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrPassthroughColorMapLutMETA.Buffer create(int capacity)

Returns a new XrPassthroughColorMapLutMETA.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrPassthroughColorMapLutMETA.Buffer create(long address, int capacity) Create a `XrPassthroughColorMapLutMETA.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrPassthroughColorMapLutMETA.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrPassthroughColorMapLutMETA createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrPassthroughColorMapLutMETA createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrPassthroughColorMapLutMETA.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static XrPassthroughColorMapLutMETA malloc() Returns a new `XrPassthroughColorMapLutMETA` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrPassthroughColorMapLutMETA.Buffer malloc(int capacity) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrPassthroughColorMapLutMETA.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrPassthroughColorMapLutMETA malloc(MemoryStack stack) Returns a new `XrPassthroughColorMapLutMETA` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrPassthroughColorMapLutMETA malloc(MemoryStack stack)

Returns a new XrPassthroughColorMapLutMETA instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrPassthroughColorMapLutMETA.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrPassthroughColorMapLutMETA.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

ncolorLut	back to summary
public static long ncolorLut(long struct) Unsafe version of `colorLut`.

ncolorLut	back to summary
public static void ncolorLut(long struct, XrPassthroughColorLutMETA value) Unsafe version of `colorLut`.

next back to summary

next	back 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 *

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 *

next	back to summary
public XrPassthroughColorMapLutMETA next(long value) Sets the specified value to the `next` field.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

nweight	back to summary
public static float nweight(long struct) Unsafe version of `weight`.

nweight	back to summary
public static void nweight(long struct, float value) Unsafe version of `weight`.

set	back to summary
public XrPassthroughColorMapLutMETA set(int type, long next, XrPassthroughColorLutMETA colorLut, float weight) Initializes this struct with the specified values.

set	back to summary
public XrPassthroughColorMapLutMETA set(XrPassthroughColorMapLutMETA src) Copies the specified struct data to this struct. Parameters src:XrPassthroughColorMapLutMETA the source struct Returns:XrPassthroughColorMapLutMETA this struct

set

back to summary

public XrPassthroughColorMapLutMETA set(XrPassthroughColorMapLutMETA src)

Copies the specified struct data to this struct.

Parameters

src:XrPassthroughColorMapLutMETA: the source struct

Returns:XrPassthroughColorMapLutMETA

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrPassthroughColorMapLutMETA type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrPassthroughColorMapLutMETA type$Default() Sets the `TYPE_PASSTHROUGH_COLOR_MAP_LUT_META` value to the `type` field.

validate back to summary

validate	back to summary
public static void validate(long struct) Validates pointer members that should not be `NULL`. Parameters struct:long the struct to validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

weight	back to summary
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.

weight	back to summary
public XrPassthroughColorMapLutMETA weight(float value) Sets the specified value to the `weight` field.

org.lwjgl.openxr back to summary

public Class XrPassthroughColorMapLutMETA.Buffer

Class Inheritance

extends StructBuffer<XrPassthroughColorMapLutMETA, XrPassthroughColorMapLutMETA.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrPassthroughColorMapLutMETA.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrPassthroughColorMapLutMETA structs.

Field Summary

Modifier and Type	Field and Description
private static final XrPassthroughColorMapLutMETA	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrPassthroughColorMapLutMETA.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 Type	Method and Description
public long	Returns: the value of the `XrPassthroughColorMapLutMETA#colorLut` field. colorLut()
public XrPassthroughColorMapLutMETA.Buffer	colorLut(XrPassthroughColorLutMETA value) Sets the specified value to the `XrPassthroughColorMapLutMETA#colorLut` field.
protected XrPassthroughColorMapLutMETA	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrPassthroughColorMapLutMETA#next` field. next()
public XrPassthroughColorMapLutMETA.Buffer	next(long value) Sets the specified value to the `XrPassthroughColorMapLutMETA#next` field.
protected XrPassthroughColorMapLutMETA.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrPassthroughColorMapLutMETA#type` field. type()
public XrPassthroughColorMapLutMETA.Buffer	type(int value) Sets the specified value to the `XrPassthroughColorMapLutMETA#type` field.
public XrPassthroughColorMapLutMETA.Buffer	type$Default() Sets the `TYPE_PASSTHROUGH_COLOR_MAP_LUT_META` value to the `XrPassthroughColorMapLutMETA#type` field.
public float	Returns: the value of the `XrPassthroughColorMapLutMETA#weight` field. weight()
public XrPassthroughColorMapLutMETA.Buffer	weight(float value) Sets the specified value to the `XrPassthroughColorMapLutMETA#weight` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrPassthroughColorMapLutMETA ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

colorLut	back to summary
public long colorLut() Returns:long the value of the `XrPassthroughColorMapLutMETA#colorLut` field. Annotations @NativeType:XrPassthroughColorLutMETA

colorLut	back to summary
public XrPassthroughColorMapLutMETA.Buffer colorLut(XrPassthroughColorLutMETA value) Sets the specified value to the `XrPassthroughColorMapLutMETA#colorLut` field.

getElementFactory

back to summary

protected XrPassthroughColorMapLutMETA getElementFactory()

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

Annotations

@Override

next	back to summary
public long next() Returns:long the value of the `XrPassthroughColorMapLutMETA#next` field. Annotations @NativeType:void const *

next	back to summary
public XrPassthroughColorMapLutMETA.Buffer next(long value) Sets the specified value to the `XrPassthroughColorMapLutMETA#next` field.

self

back to summary

protected XrPassthroughColorMapLutMETA.Buffer self()

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

Annotations

@Override

type	back to summary
public int type() Returns:int the value of the `XrPassthroughColorMapLutMETA#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrPassthroughColorMapLutMETA.Buffer type(int value) Sets the specified value to the `XrPassthroughColorMapLutMETA#type` field.

type$Default	back to summary
public XrPassthroughColorMapLutMETA.Buffer type$Default() Sets the `TYPE_PASSTHROUGH_COLOR_MAP_LUT_META` value to the `XrPassthroughColorMapLutMETA#type` field.

weight	back to summary
public float weight() Returns:float the value of the `XrPassthroughColorMapLutMETA#weight` field.

weight	back to summary
public XrPassthroughColorMapLutMETA.Buffer weight(float value) Sets the specified value to the `XrPassthroughColorMapLutMETA#weight` field.