Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class QCOMTrackingOptimizationSettings

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

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

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

The extension specification version.

public static final int
XR_TRACKING_OPTIMIZATION_SETTINGS_DOMAIN_ALL_QCOM

XrTrackingOptimizationSettingsDomainQCOM - Domains to apply tracking optimization hints Enumerant Descriptions

public static final int
XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals Enumerant Descriptions

public static final int
XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals Enumerant Descriptions

public static final int
XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals Enumerant Descriptions

public static final int
XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals Enumerant Descriptions

public static final int
XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals Enumerant Descriptions

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static int
xrSetTrackingOptimizationSettingsHintQCOM(XrSession
a valid XrSession handle.
session
,
int
the tracking domain for which the hint is applied
domain
,
int
the hint to be applied
hint
)

Submit a tracking optimization hint.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_ERROR_HINT_ALREADY_SET_QCOMback to summary
public static final int XR_ERROR_HINT_ALREADY_SET_QCOM

Extends XrResult.

XR_QCOM_TRACKING_OPTIMIZATION_SETTINGS_EXTENSION_NAMEback to summary
public static final String XR_QCOM_TRACKING_OPTIMIZATION_SETTINGS_EXTENSION_NAME

The extension name.

XR_QCOM_tracking_optimization_settings_SPEC_VERSIONback to summary
public static final int XR_QCOM_tracking_optimization_settings_SPEC_VERSION

The extension specification version.

XR_TRACKING_OPTIMIZATION_SETTINGS_DOMAIN_ALL_QCOMback to summary
public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_DOMAIN_ALL_QCOM

XrTrackingOptimizationSettingsDomainQCOM - Domains to apply tracking optimization hints

Enumerant Descriptions
See Also

SetTrackingOptimizationSettingsHintQCOM

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOMback to summary
public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_CLOSE_RANGE_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions
See Also

SetTrackingOptimizationSettingsHintQCOM

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOMback to summary
public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_HIGH_POWER_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions
See Also

SetTrackingOptimizationSettingsHintQCOM

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOMback to summary
public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LONG_RANGE_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions
See Also

SetTrackingOptimizationSettingsHintQCOM

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOMback to summary
public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_LOW_POWER_PRIORIZATION_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions
See Also

SetTrackingOptimizationSettingsHintQCOM

XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOMback to summary
public static final int XR_TRACKING_OPTIMIZATION_SETTINGS_HINT_NONE_QCOM

XrTrackingOptimizationSettingsHintQCOM - Hints for prioritizing different tracking goals

Enumerant Descriptions
See Also

SetTrackingOptimizationSettingsHintQCOM

Constructor Detail

QCOMTrackingOptimizationSettingsback to summary
protected QCOMTrackingOptimizationSettings()

Method Detail

xrSetTrackingOptimizationSettingsHintQCOMback to summary
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)
Return Codes
On success, this command returns
On failure, this command returns
Parameters
session:XrSession

a valid XrSession handle.

domain:int

the tracking domain for which the hint is applied

hint:int

the hint to be applied

Annotations
@NativeType:XrResult