Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class METAPassthroughColorLut

extends Object
Class Inheritance
Imports
org.lwjgl.*, org.lwjgl.system.*

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

Modifier and TypeField and Description
public static final int
public static final String
public static final int
XR_META_passthrough_color_lut_SPEC_VERSION

The extension specification version.

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static int
nxrCreatePassthroughColorLutMETA(XrPassthroughFB passthrough, long createInfo, long colorLut)

Unsafe version of: CreatePassthroughColorLutMETA

public static int
public static int
xrCreatePassthroughColorLutMETA(XrPassthroughFB
the XrPassthroughFB this color LUT is created for.
passthrough
,
XrPassthroughColorLutCreateInfoMETA createInfo, PointerBuffer
the resulting XrPassthroughColorLutMETA.
colorLut
)

Create a passthrough color LUT.

public static int
xrDestroyPassthroughColorLutMETA(XrPassthroughColorLutMETA
the XrPassthroughColorLutMETA to be destroyed.
colorLut
)

Destroy a passthrough color LUT.

public static int
xrUpdatePassthroughColorLutMETA(XrPassthroughColorLutMETA
the XrPassthroughColorLutMETA to be updated.
colorLut
,
XrPassthroughColorLutUpdateInfoMETA updateInfo)

Update a passthrough color LUT.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_METAback to summary
public static final int XR_ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_META

Extends XrResult.

XR_META_PASSTHROUGH_COLOR_LUT_EXTENSION_NAMEback to summary
public static final String XR_META_PASSTHROUGH_COLOR_LUT_EXTENSION_NAME

The extension name.

XR_META_passthrough_color_lut_SPEC_VERSIONback to summary
public static final int XR_META_passthrough_color_lut_SPEC_VERSION

The extension specification version.

XR_OBJECT_TYPE_PASSTHROUGH_COLOR_LUT_METAback to summary
public static final int XR_OBJECT_TYPE_PASSTHROUGH_COLOR_LUT_META

Extends XrObjectType.

XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGB_METAback to summary
public static final int XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGB_META

XrPassthroughColorLutChannelsMETA - Color channels

See Also

XrPassthroughColorLutCreateInfoMETA

Enum values:
XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGBA_METAback to summary
public static final int XR_PASSTHROUGH_COLOR_LUT_CHANNELS_RGBA_META

XrPassthroughColorLutChannelsMETA - Color channels

See Also

XrPassthroughColorLutCreateInfoMETA

Enum values:
XR_TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_METAback to summary
public static final int XR_TYPE_PASSTHROUGH_COLOR_LUT_CREATE_INFO_META

Extends XrStructureType.

Enum values:
XR_TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_METAback to summary
public static final int XR_TYPE_PASSTHROUGH_COLOR_LUT_UPDATE_INFO_META

Extends XrStructureType.

Enum values:
XR_TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_METAback to summary
public static final int XR_TYPE_PASSTHROUGH_COLOR_MAP_INTERPOLATED_LUT_META

Extends XrStructureType.

Enum values:
XR_TYPE_PASSTHROUGH_COLOR_MAP_LUT_METAback to summary
public static final int XR_TYPE_PASSTHROUGH_COLOR_MAP_LUT_META

Extends XrStructureType.

Enum values:
XR_TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_METAback to summary
public static final int XR_TYPE_SYSTEM_PASSTHROUGH_COLOR_LUT_PROPERTIES_META

Extends XrStructureType.

Enum values:

Constructor Detail

METAPassthroughColorLutback to summary
protected METAPassthroughColorLut()

Method Detail

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

Unsafe version of: CreatePassthroughColorLutMETA

nxrUpdatePassthroughColorLutMETAback to summary
public static int nxrUpdatePassthroughColorLutMETA(XrPassthroughColorLutMETA colorLut, long updateInfo)

Unsafe version of: UpdatePassthroughColorLutMETA

xrCreatePassthroughColorLutMETAback to summary
public static int xrCreatePassthroughColorLutMETA(XrPassthroughFB passthrough, XrPassthroughColorLutCreateInfoMETA createInfo, 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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

XrPassthroughColorLutCreateInfoMETA

Parameters
passthrough:XrPassthroughFB

the XrPassthroughFB this color LUT is created for.

createInfo:XrPassthroughColorLutCreateInfoMETA

the XrPassthroughColorLutCreateInfoMETA.

colorLut:PointerBuffer

the resulting XrPassthroughColorLutMETA.

Annotations
@NativeType:XrResult
xrDestroyPassthroughColorLutMETAback to summary
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)
Thread Safety
  • Access to colorLut, and any child handles, must be externally synchronized
Return Codes
On success, this command returns
On failure, this command returns
Parameters
colorLut:XrPassthroughColorLutMETA

the XrPassthroughColorLutMETA to be destroyed.

Annotations
@NativeType:XrResult
xrUpdatePassthroughColorLutMETAback to summary
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, bufferSize of the new data must be equal to the 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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

XrPassthroughColorLutUpdateInfoMETA

Parameters
colorLut:XrPassthroughColorLutMETA

the XrPassthroughColorLutMETA to be updated.

updateInfo:XrPassthroughColorLutUpdateInfoMETA

the XrPassthroughColorLutUpdateInfoMETA.

Annotations
@NativeType:XrResult