Package org.lwjgl.openxr

Class QCOMTrackingOptimizationSettings

java.lang.Object

org.lwjgl.openxr.QCOMTrackingOptimizationSettings

public class QCOMTrackingOptimizationSettings
extends Object

The XR_QCOM_tracking_optimization_settings extension.

This extension defines an API for the application to give optimization hints to the runtime for tracker domains.

For example, an application might be interested in tracking targets that are at a far distance from the camera which may increase tracking latency, while another application might be interested in minimizing power consumption at the cost of tracking accuracy. Targets are domains which are defined in XrTrackingOptimizationSettingsDomainQCOM.

This allows the application to tailor the tracking algorithms to specific use-cases and scene-scales in order to provide the best experience possible.

Summary: provide domain hints to the run-time about which parameters to optimize tracking for.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_HINT_ALREADY_SET_QCOM	Extends XrResult.
static final String	XR_QCOM_TRACKING_OPTIMIZATION_SETTINGS_EXTENSION_NAME	The extension name.
static final int	XR_QCOM_tracking_optimization_settings_SPEC_VERSION	The extension specification version.
static final int	XR_TRACKING_OPTIMIZATION_SETTINGS_DOMAIN_ALL_QCOM	XrTrackingOptimizationSettingsDomainQCOM - Domains to apply tracking optimization hints
static final int	XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM	XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals
static final int	XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM	XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals
static final int	XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM	XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals
static final int	XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM	XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals
static final int	XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM	XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Method Summary

Modifier and Type	Method	Description
static int	xrSetTrackingOptimizationSettingsHintQCOM(XrSession session, int domain, int hint)	Submit a tracking optimization hint.

Methods inherited from class java.lang.Object

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

Field Details

XR_QCOM_tracking_optimization_settings_SPEC_VERSION

public static final int XR_QCOM_tracking_optimization_settings_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_QCOM_TRACKING_OPTIMIZATION_SETTINGS_EXTENSION_NAME

public static final String XR_QCOM_TRACKING_OPTIMIZATION_SETTINGS_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_ERROR_HINT_ALREADY_SET_QCOM

public static final int XR_ERROR_HINT_ALREADY_SET_QCOM

Extends XrResult.

See Also:

• Constant Field Values

XR_TRACKING_OPTIMIZATION_SETTINGS_DOMAIN_ALL_QCOM

public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_DOMAIN_ALL_QCOM

XrTrackingOptimizationSettingsDomainQCOM - Domains to apply tracking optimization hints

Enumerant Descriptions

• TRACKING_OPTIMIZATION_SETTINGS_DOMAIN_ALL_QCOM — Setting applies to all QCOM tracking extensions.

See Also

SetTrackingOptimizationSettingsHintQCOM

See Also:

• Constant Field Values

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM

public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions

• TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM — Used by the application to indicate that it does not have a preference to optimize for. The run-time is understood to choose a balanced approach.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for long range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for close range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for low power consumption, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for increased tracking performance, possibly at the cost of increased power consumption.

See Also

SetTrackingOptimizationSettingsHintQCOM

See Also:

• Constant Field Values

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM

public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions

• TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM — Used by the application to indicate that it does not have a preference to optimize for. The run-time is understood to choose a balanced approach.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for long range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for close range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for low power consumption, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for increased tracking performance, possibly at the cost of increased power consumption.

See Also

SetTrackingOptimizationSettingsHintQCOM

See Also:

• Constant Field Values

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM

public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions

• TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM — Used by the application to indicate that it does not have a preference to optimize for. The run-time is understood to choose a balanced approach.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for long range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for close range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for low power consumption, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for increased tracking performance, possibly at the cost of increased power consumption.

See Also

SetTrackingOptimizationSettingsHintQCOM

See Also:

• Constant Field Values

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM

public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions

• TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM — Used by the application to indicate that it does not have a preference to optimize for. The run-time is understood to choose a balanced approach.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for long range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for close range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for low power consumption, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for increased tracking performance, possibly at the cost of increased power consumption.

See Also

SetTrackingOptimizationSettingsHintQCOM

See Also:

• Constant Field Values

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM

public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions

• TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM — Used by the application to indicate that it does not have a preference to optimize for. The run-time is understood to choose a balanced approach.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for long range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for close range, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for low power consumption, possibly at the expense of competing interests.
• TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM — Used by the application to indicate that it prefers tracking to be optimized for increased tracking performance, possibly at the cost of increased power consumption.

See Also

SetTrackingOptimizationSettingsHintQCOM

See Also:

• Constant Field Values

Method Details

xrSetTrackingOptimizationSettingsHintQCOM

public static int xrSetTrackingOptimizationSettingsHintQCOM(XrSession session,
 int domain,
 int hint)

Submit a tracking optimization hint.

C Specification

The SetTrackingOptimizationSettingsHintQCOM function is defined as:

 XrResult xrSetTrackingOptimizationSettingsHintQCOM(
     XrSession                                   session,
     XrTrackingOptimizationSettingsDomainQCOM    domain,
     XrTrackingOptimizationSettingsHintQCOM      hint);

Description

The XR runtime behaves as if TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM was submitted if the application does not provide a hint.

The XR runtime must return ERROR_VALIDATION_FAILURE if the application sets a domain or hint not part of XrTrackingOptimizationSettingsDomainQCOM or XrTrackingOptimizationSettingsHintQCOM.

A hint is typically set before a domain handle is created. If hints are set more than once from one or concurrent sessions, the runtime may accommodate the first hint it received and return ERROR_HINT_ALREADY_SET_QCOM for any subsequent calls made.

If the application destroys the active domain handle associated with the hint, the runtime may behave as if TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM was set. In this scenario, the runtime should accommodate new valid hints that may be set for the same domain.

Valid Usage (Implicit)

• The XR_QCOM_tracking_optimization_settings extension must be enabled prior to calling SetTrackingOptimizationSettingsHintQCOM
• session must be a valid XrSession handle
• domain must be a valid XrTrackingOptimizationSettingsDomainQCOM value
• hint must be a valid XrTrackingOptimizationSettingsHintQCOM value

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_HINT_ALREADY_SET_QCOM

Parameters:

session - a valid XrSession handle.

domain - the tracking domain for which the hint is applied

hint - the hint to be applied