LWJGL 3.3.3 · org.lwjgl.openxr.VARJOEnvironmentDepthEstimation

The XR_VARJO_environment_depth_estimation extension.

This extension provides a mechanism for enabling depth estimation of the environment in the runtime-supplied compositor. This is an extension to ENVIRONMENT_BLEND_MODE_ALPHA_BLEND mode to not only use the color but also depth for composition of the final image.

Mixed reality applications might want to mix real and virtual content based on the depth information for proper occlusion. XR hardware and runtime may offer various ways to estimate the depth of the environment inside the compositor. When this estimation is enabled, the compositor can generate properly occluded final image when layers are submitted with depth information (both XR_KHR_composition_layer_depth and XR_VARJO_composition_layer_depth_test).

This extension defines a new function, SetEnvironmentDepthEstimationVARJO, which can be used to toggle environment depth estimation in the compositor. Toggling depth estimation is an asynchronous operation and the feature may not be activated immediately. Function can be called immediately after the session is created. Composition of the environment layer follows the rules as described in XR_VARJO_composition_layer_depth_test.

Field Summary

Modifier and Type	Field and Description
public static final String	XR_VARJO_ENVIRONMENT_DEPTH_ESTIMATION_EXTENSION_NAME The extension name.
public static final int	XR_VARJO_environment_depth_estimation_SPEC_VERSION The extension specification version.

Access	Constructor and Description
protected	VARJOEnvironmentDepthEstimation()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public static int	xrSetEnvironmentDepthEstimationVARJO(XrSession an `XrSession` handle previously created with `CreateSession`. session, boolean a boolean that specifies whether depth estimation functionality should be activated. Compositor will disable depth estimation functionality if environment blend mode is not `ENVIRONMENT_BLEND_MODE_ALPHA_BLEND` and will enable the functionality when environment blend mode is set to `ENVIRONMENT_BLEND_MODE_ALPHA_BLEND`. enabled) Enable or disable environment depth estimation functionality.

public static int

xrSetEnvironmentDepthEstimationVARJO(XrSession

an XrSession handle previously created with CreateSession.

session, boolean

a boolean that specifies whether depth estimation functionality should be activated. Compositor will disable depth estimation functionality if environment blend mode is not ENVIRONMENT_BLEND_MODE_ALPHA_BLEND and will enable the functionality when environment blend mode is set to ENVIRONMENT_BLEND_MODE_ALPHA_BLEND.

enabled)

Enable or disable environment depth estimation functionality.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

XR_VARJO_ENVIRONMENT_DEPTH_ESTIMATION_EXTENSION_NAME	back to summary
public static final String XR_VARJO_ENVIRONMENT_DEPTH_ESTIMATION_EXTENSION_NAME The extension name.

XR_VARJO_environment_depth_estimation_SPEC_VERSION	back to summary
public static final int XR_VARJO_environment_depth_estimation_SPEC_VERSION The extension specification version.

Constructor Detail

VARJOEnvironmentDepthEstimation	back to summary
protected VARJOEnvironmentDepthEstimation()

Method Detail

xrSetEnvironmentDepthEstimationVARJO back to summary

xrSetEnvironmentDepthEstimationVARJO	back to summary
public static int xrSetEnvironmentDepthEstimationVARJO(XrSession session, boolean enabled) Enable or disable environment depth estimation functionality. C Specification The `SetEnvironmentDepthEstimationVARJO` function is defined as: `XrResult xrSetEnvironmentDepthEstimationVARJO( XrSession session, XrBool32 enabled);` Valid Usage (Implicit) The `XR_VARJO_environment_depth_estimation` extension must be enabled prior to calling `SetEnvironmentDepthEstimationVARJO` `session` must be a valid `XrSession` handle Return Codes On success, this command returns `SUCCESS` `SESSION_LOSS_PENDING` On failure, this command returns `ERROR_FUNCTION_UNSUPPORTED` `ERROR_RUNTIME_FAILURE` `ERROR_HANDLE_INVALID` `ERROR_INSTANCE_LOST` `ERROR_SESSION_LOST` `ERROR_FEATURE_UNSUPPORTED` Parameters session:XrSession an `XrSession` handle previously created with `CreateSession`. enabled:boolean a boolean that specifies whether depth estimation functionality should be activated. Compositor will disable depth estimation functionality if environment blend mode is not `ENVIRONMENT_BLEND_MODE_ALPHA_BLEND` and will enable the functionality when environment blend mode is set to `ENVIRONMENT_BLEND_MODE_ALPHA_BLEND`. Annotations @NativeType:XrResult

public static int xrSetEnvironmentDepthEstimationVARJO(XrSession session, boolean enabled)

Enable or disable environment depth estimation functionality.

C Specification

The SetEnvironmentDepthEstimationVARJO function is defined as:


XrResult xrSetEnvironmentDepthEstimationVARJO(
    XrSession                                   session,
    XrBool32                                    enabled);

Valid Usage (Implicit)

The XR_VARJO_environment_depth_estimation extension must be enabled prior to calling SetEnvironmentDepthEstimationVARJO
session must be a valid XrSession handle

Return Codes

On success, this command returns

On failure, this command returns

Parameters

session:XrSession: an XrSession handle previously created with CreateSession.
enabled:boolean: a boolean that specifies whether depth estimation functionality should be activated. Compositor will disable depth estimation functionality if environment blend mode is not ENVIRONMENT_BLEND_MODE_ALPHA_BLEND and will enable the functionality when environment blend mode is set to ENVIRONMENT_BLEND_MODE_ALPHA_BLEND.

Annotations

@NativeType:XrResult

public Class VARJOEnvironmentDepthEstimation