Package org.lwjgl.openxr

Class HTCPassthrough

java.lang.Object

org.lwjgl.openxr.HTCPassthrough

public class HTCPassthrough
extends Object

The XR_HTC_passthrough extension.

This extension enables an application to show the passthrough image to see the surrounding environment from the VR headset. The application is allowed to configure the passthrough image with the different appearances according to the demand of the application.

The passthrough configurations that runtime provides to applications contain:

• Decide the passthrough layer shown over or under the frame submitted by the application.
• Specify the passthrough form with full of the entire screen or projection onto the mesh specified by the application.
• Set the alpha blending level for the composition of the passthrough layer.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_HTC_PASSTHROUGH_EXTENSION_NAME	The extension name.
static final int	XR_HTC_passthrough_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_PASSTHROUGH_HTC	Extends XrObjectType.
static final int	XR_PASSTHROUGH_FORM_PLANAR_HTC	XrPassthroughFormHTC - Describes the form of passthrough.
static final int	XR_PASSTHROUGH_FORM_PROJECTED_HTC	XrPassthroughFormHTC - Describes the form of passthrough.
static final int	XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_COLOR_HTC	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_CREATE_INFO_HTC	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreatePassthroughHTC(XrSession session, long createInfo, long passthrough)	Unsafe version of: CreatePassthroughHTC
static int	xrCreatePassthroughHTC(XrSession session, XrPassthroughCreateInfoHTC createInfo, org.lwjgl.PointerBuffer passthrough)	Create a passthrough handle.
static int	xrDestroyPassthroughHTC(XrPassthroughHTC passthrough)	Destroy a passthrough handle.

Methods inherited from class java.lang.Object

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

Field Details

XR_HTC_passthrough_SPEC_VERSION

public static final int XR_HTC_passthrough_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_HTC_PASSTHROUGH_EXTENSION_NAME

public static final String XR_HTC_PASSTHROUGH_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_PASSTHROUGH_HTC

public static final int XR_OBJECT_TYPE_PASSTHROUGH_HTC

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_CREATE_INFO_HTC

public static final int XR_TYPE_PASSTHROUGH_CREATE_INFO_HTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_COLOR_HTC

public static final int XR_TYPE_PASSTHROUGH_COLOR_HTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC

public static final int XR_TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

See Also:

• Constant Field Values

XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

public static final int XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

See Also:

• Constant Field Values

XR_PASSTHROUGH_FORM_PLANAR_HTC

public static final int XR_PASSTHROUGH_FORM_PLANAR_HTC

XrPassthroughFormHTC - Describes the form of passthrough.

Enumerant Descriptions

• PASSTHROUGH_FORM_PLANAR_HTC — Presents the passthrough with full of the entire screen.
• PASSTHROUGH_FORM_PROJECTED_HTC — Presents the passthrough projecting onto a custom mesh.

See Also

XrPassthroughCreateInfoHTC

See Also:

• Constant Field Values

XR_PASSTHROUGH_FORM_PROJECTED_HTC

public static final int XR_PASSTHROUGH_FORM_PROJECTED_HTC

XrPassthroughFormHTC - Describes the form of passthrough.

Enumerant Descriptions

• PASSTHROUGH_FORM_PLANAR_HTC — Presents the passthrough with full of the entire screen.
• PASSTHROUGH_FORM_PROJECTED_HTC — Presents the passthrough projecting onto a custom mesh.

See Also

XrPassthroughCreateInfoHTC

See Also:

• Constant Field Values

Method Details

nxrCreatePassthroughHTC

public static int nxrCreatePassthroughHTC(XrSession session,
 long createInfo,
 long passthrough)

Unsafe version of: CreatePassthroughHTC

xrCreatePassthroughHTC

public static int xrCreatePassthroughHTC(XrSession session,
 XrPassthroughCreateInfoHTC createInfo,
 org.lwjgl.PointerBuffer passthrough)

Create a passthrough handle.

C Specification

The CreatePassthroughHTC function is defined as:

 XrResult xrCreatePassthroughHTC(
     XrSession                                   session,
     const XrPassthroughCreateInfoHTC*           createInfo,
     XrPassthroughHTC*                           passthrough);

Description

Creates an XrPassthroughHTC handle.

If the function successfully returned, the output passthrough must be a valid handle.

Valid Usage (Implicit)

• The XR_HTC_passthrough extension must be enabled prior to calling CreatePassthroughHTC
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrPassthroughCreateInfoHTC structure
• passthrough must be a pointer to an XrPassthroughHTC 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_FEATURE_UNSUPPORTED

See Also

XrPassthroughCreateInfoHTC

Parameters:

session - an XrSession in which the passthrough will be active.

createInfo - a pointer to an XrPassthroughCreateInfoHTC structure containing information about how to create the passthrough.

passthrough - a pointer to a handle in which the created XrPassthroughHTC is returned.

xrDestroyPassthroughHTC

public static int xrDestroyPassthroughHTC(XrPassthroughHTC passthrough)

Destroy a passthrough handle.

C Specification

The DestroyPassthroughHTC function is defined as:

 XrResult xrDestroyPassthroughHTC(
     XrPassthroughHTC                            passthrough);

Description

The DestroyPassthroughHTC function releases the passthrough and the underlying resources.

Valid Usage (Implicit)

• The XR_HTC_passthrough extension must be enabled prior to calling DestroyPassthroughHTC
• passthrough must be a valid XrPassthroughHTC handle

Thread Safety

• Access to passthrough, 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

Parameters:

passthrough - the XrPassthroughHTC to be destroyed.