Package org.lwjgl.openxr

Class METAPassthroughColorLut

java.lang.Object

org.lwjgl.openxr.METAPassthroughColorLut

public class METAPassthroughColorLut
extends Object

The XR_META_passthrough_color_lut extension.

This extension adds the capability to define and apply RGB to RGB(A) color look-up tables (LUTs) to passthrough layers created using XR_FB_passthrough.

Color LUTs are 3-dimensional arrays which map each input color to a different output color. When applied to a Passthrough layer, the runtime must transform Passthrough camera images according to this map before display. Color LUTs may be used to achieve effects such as color grading, level control, color filtering, or chroma keying.

Color LUTs must be created using CreatePassthroughColorLutMETA before they can be applied to a Passthrough layer in a call to PassthroughLayerSetStyleFB (as a part of XrPassthroughColorMapLutMETA or XrPassthroughColorMapInterpolatedLutMETA). A color LUT may be applied to multiple Passthrough layers simultaneously.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_META	Extends XrResult.
static final String	XR_META_PASSTHROUGH_COLOR_LUT_EXTENSION_NAME	The extension name.
static final int	XR_META_passthrough_color_lut_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_PASSTHROUGH_COLOR_LUT_META	Extends XrObjectType.
static final int	XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGB_META	XrPassthroughColorLutChannelsMETA - Color channels
static final int	XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGBA_META	XrPassthroughColorLutChannelsMETA - Color channels
static final int	XR_TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_COLOR_MAP_LUT_META	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreatePassthroughColorLutMETA(XrPassthroughFB passthrough, long createInfo, long colorLut)	Unsafe version of: CreatePassthroughColorLutMETA
static int	nxrUpdatePassthroughColorLutMETA(XrPassthroughColorLutMETA colorLut, long updateInfo)	Unsafe version of: UpdatePassthroughColorLutMETA
static int	xrCreatePassthroughColorLutMETA(XrPassthroughFB passthrough, XrPassthroughColorLutCreateInfoMETA createInfo, org.lwjgl.PointerBuffer colorLut)	Create a passthrough color LUT.
static int	xrDestroyPassthroughColorLutMETA(XrPassthroughColorLutMETA colorLut)	Destroy a passthrough color LUT.
static int	xrUpdatePassthroughColorLutMETA(XrPassthroughColorLutMETA colorLut, XrPassthroughColorLutUpdateInfoMETA updateInfo)	Update a passthrough color LUT.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_META_passthrough_color_lut_SPEC_VERSION

public static final int XR_META_passthrough_color_lut_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_META_PASSTHROUGH_COLOR_LUT_EXTENSION_NAME

public static final String XR_META_PASSTHROUGH_COLOR_LUT_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META

public static final int XR_TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META
• TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_MAP_LUT_META
• TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META

public static final int XR_TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META
• TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_MAP_LUT_META
• TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META

public static final int XR_TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META
• TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_MAP_LUT_META
• TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_COLOR_MAP_LUT_META

public static final int XR_TYPE_PASSTHROUGH_COLOR_MAP_LUT_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META
• TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_MAP_LUT_META
• TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

public static final int XR_TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META
• TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META
• TYPE_PASSTHROUGH_COLOR_MAP_LUT_META
• TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

See Also:

• Constant Field Values

XR_OBJECT_TYPE_PASSTHROUGH_COLOR_LUT_META

public static final int XR_OBJECT_TYPE_PASSTHROUGH_COLOR_LUT_META

Extends XrObjectType.

See Also:

• Constant Field Values

XR_ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_META

public static final int XR_ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_META

Extends XrResult.

See Also:

• Constant Field Values

XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGB_META

public static final int XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGB_META

XrPassthroughColorLutChannelsMETA - Color channels

See Also

XrPassthroughColorLutCreateInfoMETA

Enum values:

• PASSTHROUGH_COLOR_LUT_CHANNELS_RGB_META
• PASSTHROUGH_COLOR_LUT_CHANNELS_RGBA_META

See Also:

• Constant Field Values

XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGBA_META

public static final int XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGBA_META

XrPassthroughColorLutChannelsMETA - Color channels

See Also

XrPassthroughColorLutCreateInfoMETA

Enum values:

• PASSTHROUGH_COLOR_LUT_CHANNELS_RGB_META
• PASSTHROUGH_COLOR_LUT_CHANNELS_RGBA_META

See Also:

• Constant Field Values

Method Details

nxrCreatePassthroughColorLutMETA

public static int nxrCreatePassthroughColorLutMETA(XrPassthroughFB passthrough,
 long createInfo,
 long colorLut)

Unsafe version of: CreatePassthroughColorLutMETA

xrCreatePassthroughColorLutMETA

public static int xrCreatePassthroughColorLutMETA(XrPassthroughFB passthrough,
 XrPassthroughColorLutCreateInfoMETA createInfo,
 org.lwjgl.PointerBuffer colorLut)

Create a passthrough color LUT.

C Specification

The CreatePassthroughColorLutMETA function is defined as:

 XrResult xrCreatePassthroughColorLutMETA(
     XrPassthroughFB                             passthrough,
     const XrPassthroughColorLutCreateInfoMETA*  createInfo,
     XrPassthroughColorLutMETA*                  colorLut);

Description

Creates a passthrough color LUT. The resulting XrPassthroughColorLutMETA may be referenced in XrPassthroughColorMapLutMETA and XrPassthroughColorMapInterpolatedLutMETA in subsequent calls to PassthroughLayerSetStyleFB.

Valid Usage (Implicit)

• The XR_META_passthrough_color_lut extension must be enabled prior to calling CreatePassthroughColorLutMETA
• passthrough must be a valid XrPassthroughFB handle
• createInfo must be a pointer to a valid XrPassthroughColorLutCreateInfoMETA structure
• colorLut must be a pointer to an XrPassthroughColorLutMETA handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_META
• ERROR_FEATURE_UNSUPPORTED

See Also

XrPassthroughColorLutCreateInfoMETA

Parameters:

passthrough - the XrPassthroughFB this color LUT is created for.

createInfo - the XrPassthroughColorLutCreateInfoMETA.

colorLut - the resulting XrPassthroughColorLutMETA.

xrDestroyPassthroughColorLutMETA

public static int xrDestroyPassthroughColorLutMETA(XrPassthroughColorLutMETA colorLut)

Destroy a passthrough color LUT.

C Specification

The DestroyPassthroughColorLutMETA function is defined as:

 XrResult xrDestroyPassthroughColorLutMETA(
     XrPassthroughColorLutMETA                   colorLut);

Description

Destroys a passthrough color LUT. If the color LUT is still in use (i.e. if for at least one passthrough layer, PassthroughLayerSetStyleFB has last been called with an instance of XrPassthroughColorMapLutMETA or XrPassthroughColorMapInterpolatedLutMETA in the next chain that references this color LUT), the runtime must retain the color LUT data and continue applying it to the affected passthrough layer until a different style is applied.

Valid Usage (Implicit)

• The XR_META_passthrough_color_lut extension must be enabled prior to calling DestroyPassthroughColorLutMETA
• colorLut must be a valid XrPassthroughColorLutMETA handle

Thread Safety

• Access to colorLut, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_FEATURE_UNSUPPORTED

Parameters:

colorLut - the XrPassthroughColorLutMETA to be destroyed.

nxrUpdatePassthroughColorLutMETA

public static int nxrUpdatePassthroughColorLutMETA(XrPassthroughColorLutMETA colorLut,
 long updateInfo)

Unsafe version of: UpdatePassthroughColorLutMETA

xrUpdatePassthroughColorLutMETA

public static int xrUpdatePassthroughColorLutMETA(XrPassthroughColorLutMETA colorLut,
 XrPassthroughColorLutUpdateInfoMETA updateInfo)

Update a passthrough color LUT.

C Specification

The UpdatePassthroughColorLutMETA function is defined as:

 XrResult xrUpdatePassthroughColorLutMETA(
     XrPassthroughColorLutMETA                   colorLut,
     const XrPassthroughColorLutUpdateInfoMETA*  updateInfo);

Description

Updates the LUT data of a passthrough color LUT. The data type of the color LUT (resolution and channels) is immutable. The provided data in this call must therefore match the data type specified at creation time. Specifically, XrPassthroughColorLutDataMETA::bufferSize of the new data must be equal to the XrPassthroughColorLutDataMETA::bufferSize specified during creation. Otherwise, the runtime must return ERROR_VALIDATION_FAILURE.

The runtime must reflect changes to color LUT data on all Passthrough layers the color LUT is currently applied to.

Valid Usage (Implicit)

• The XR_META_passthrough_color_lut extension must be enabled prior to calling UpdatePassthroughColorLutMETA
• colorLut must be a valid XrPassthroughColorLutMETA handle
• updateInfo must be a pointer to a valid XrPassthroughColorLutUpdateInfoMETA structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_META
• ERROR_FEATURE_UNSUPPORTED

See Also

XrPassthroughColorLutUpdateInfoMETA

Parameters:

colorLut - the XrPassthroughColorLutMETA to be updated.

updateInfo - the XrPassthroughColorLutUpdateInfoMETA.