Package org.lwjgl.openxr

Class MLUserCalibration

java.lang.Object

org.lwjgl.openxr.MLUserCalibration

public class MLUserCalibration
extends Object

The XR_ML_user_calibration extension.

This extension can be used to determine how well the device is calibrated for the current user of the device. The extension provides two events for this purpose:

• Headset Fit: Provides the quality of the fit of the headset on the user.
• Eye Calibration: Provides the quality of the user’s eye calibration.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_EYE_CALIBRATION_STATUS_COARSE_ML	XrEyeCalibrationStatusML - Headset fit status
static final int	XR_EYE_CALIBRATION_STATUS_FINE_ML	XrEyeCalibrationStatusML - Headset fit status
static final int	XR_EYE_CALIBRATION_STATUS_NONE_ML	XrEyeCalibrationStatusML - Headset fit status
static final int	XR_EYE_CALIBRATION_STATUS_UNKNOWN_ML	XrEyeCalibrationStatusML - Headset fit status
static final int	XR_HEADSET_FIT_STATUS_BAD_FIT_ML	XrHeadsetFitStatusML - Headset fit status
static final int	XR_HEADSET_FIT_STATUS_GOOD_FIT_ML	XrHeadsetFitStatusML - Headset fit status
static final int	XR_HEADSET_FIT_STATUS_NOT_WORN_ML	XrHeadsetFitStatusML - Headset fit status
static final int	XR_HEADSET_FIT_STATUS_UNKNOWN_ML	XrHeadsetFitStatusML - Headset fit status
static final String	XR_ML_USER_CALIBRATION_EXTENSION_NAME	The extension name.
static final int	XR_ML_user_calibration_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_EVENT_DATA_EYE_CALIBRATION_CHANGED_ML	Extends XrStructureType.
static final int	XR_TYPE_EVENT_DATA_HEADSET_FIT_CHANGED_ML	Extends XrStructureType.
static final int	XR_TYPE_USER_CALIBRATION_ENABLE_EVENTS_INFO_ML	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrEnableUserCalibrationEventsML(org.lwjgl.openxr.XrInstance instance, long enableInfo)	Unsafe version of: EnableUserCalibrationEventsML
static int	xrEnableUserCalibrationEventsML(org.lwjgl.openxr.XrInstance instance, XrUserCalibrationEnableEventsInfoML enableInfo)	Enable/disable user calibration events.

Methods inherited from class java.lang.Object

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

Field Details

XR_ML_user_calibration_SPEC_VERSION

public static final int XR_ML_user_calibration_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_ML_USER_CALIBRATION_EXTENSION_NAME

public static final String XR_ML_USER_CALIBRATION_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_HEADSET_FIT_CHANGED_ML

public static final int XR_TYPE_EVENT_DATA_HEADSET_FIT_CHANGED_ML

Extends XrStructureType.

Enum values:

• TYPE_EVENT_DATA_HEADSET_FIT_CHANGED_ML
• TYPE_EVENT_DATA_EYE_CALIBRATION_CHANGED_ML
• TYPE_USER_CALIBRATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_EYE_CALIBRATION_CHANGED_ML

public static final int XR_TYPE_EVENT_DATA_EYE_CALIBRATION_CHANGED_ML

Extends XrStructureType.

Enum values:

• TYPE_EVENT_DATA_HEADSET_FIT_CHANGED_ML
• TYPE_EVENT_DATA_EYE_CALIBRATION_CHANGED_ML
• TYPE_USER_CALIBRATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_TYPE_USER_CALIBRATION_ENABLE_EVENTS_INFO_ML

public static final int XR_TYPE_USER_CALIBRATION_ENABLE_EVENTS_INFO_ML

Extends XrStructureType.

Enum values:

• TYPE_EVENT_DATA_HEADSET_FIT_CHANGED_ML
• TYPE_EVENT_DATA_EYE_CALIBRATION_CHANGED_ML
• TYPE_USER_CALIBRATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_HEADSET_FIT_STATUS_UNKNOWN_ML

public static final int XR_HEADSET_FIT_STATUS_UNKNOWN_ML

XrHeadsetFitStatusML - Headset fit status

Description

Enum	Description
HEADSET_FIT_STATUS_UNKNOWN_ML	Headset fit status not available for unknown reason.
HEADSET_FIT_STATUS_NOT_WORN_ML	Headset not worn.
HEADSET_FIT_STATUS_GOOD_FIT_ML	Good fit.
HEADSET_FIT_STATUS_BAD_FIT_ML	Bad fit.

See Also

XrEventDataHeadsetFitChangedML

See Also:

• Constant Field Values

XR_HEADSET_FIT_STATUS_NOT_WORN_ML

public static final int XR_HEADSET_FIT_STATUS_NOT_WORN_ML

XrHeadsetFitStatusML - Headset fit status

Description

Enum	Description
HEADSET_FIT_STATUS_UNKNOWN_ML	Headset fit status not available for unknown reason.
HEADSET_FIT_STATUS_NOT_WORN_ML	Headset not worn.
HEADSET_FIT_STATUS_GOOD_FIT_ML	Good fit.
HEADSET_FIT_STATUS_BAD_FIT_ML	Bad fit.

See Also

XrEventDataHeadsetFitChangedML

See Also:

• Constant Field Values

XR_HEADSET_FIT_STATUS_GOOD_FIT_ML

public static final int XR_HEADSET_FIT_STATUS_GOOD_FIT_ML

XrHeadsetFitStatusML - Headset fit status

Description

Enum	Description
HEADSET_FIT_STATUS_UNKNOWN_ML	Headset fit status not available for unknown reason.
HEADSET_FIT_STATUS_NOT_WORN_ML	Headset not worn.
HEADSET_FIT_STATUS_GOOD_FIT_ML	Good fit.
HEADSET_FIT_STATUS_BAD_FIT_ML	Bad fit.

See Also

XrEventDataHeadsetFitChangedML

See Also:

• Constant Field Values

XR_HEADSET_FIT_STATUS_BAD_FIT_ML

public static final int XR_HEADSET_FIT_STATUS_BAD_FIT_ML

XrHeadsetFitStatusML - Headset fit status

Description

Enum	Description
HEADSET_FIT_STATUS_UNKNOWN_ML	Headset fit status not available for unknown reason.
HEADSET_FIT_STATUS_NOT_WORN_ML	Headset not worn.
HEADSET_FIT_STATUS_GOOD_FIT_ML	Good fit.
HEADSET_FIT_STATUS_BAD_FIT_ML	Bad fit.

See Also

XrEventDataHeadsetFitChangedML

See Also:

• Constant Field Values

XR_EYE_CALIBRATION_STATUS_UNKNOWN_ML

public static final int XR_EYE_CALIBRATION_STATUS_UNKNOWN_ML

XrEyeCalibrationStatusML - Headset fit status

Description

Enum	Description
EYE_CALIBRATION_STATUS_UNKNOWN_ML	Eye calibration status not available for unknown reason.
EYE_CALIBRATION_STATUS_NONE_ML	User has not performed the eye calibration step. Use system provided app to perform eye calibration.
EYE_CALIBRATION_STATUS_COARSE_ML	Eye calibration is of lower accuracy.
EYE_CALIBRATION_STATUS_FINE_ML	Eye calibration is of higher accuracy.

See Also

XrEventDataEyeCalibrationChangedML

See Also:

• Constant Field Values

XR_EYE_CALIBRATION_STATUS_NONE_ML

public static final int XR_EYE_CALIBRATION_STATUS_NONE_ML

XrEyeCalibrationStatusML - Headset fit status

Description

Enum	Description
EYE_CALIBRATION_STATUS_UNKNOWN_ML	Eye calibration status not available for unknown reason.
EYE_CALIBRATION_STATUS_NONE_ML	User has not performed the eye calibration step. Use system provided app to perform eye calibration.
EYE_CALIBRATION_STATUS_COARSE_ML	Eye calibration is of lower accuracy.
EYE_CALIBRATION_STATUS_FINE_ML	Eye calibration is of higher accuracy.

See Also

XrEventDataEyeCalibrationChangedML

See Also:

• Constant Field Values

XR_EYE_CALIBRATION_STATUS_COARSE_ML

public static final int XR_EYE_CALIBRATION_STATUS_COARSE_ML

XrEyeCalibrationStatusML - Headset fit status

Description

Enum	Description
EYE_CALIBRATION_STATUS_UNKNOWN_ML	Eye calibration status not available for unknown reason.
EYE_CALIBRATION_STATUS_NONE_ML	User has not performed the eye calibration step. Use system provided app to perform eye calibration.
EYE_CALIBRATION_STATUS_COARSE_ML	Eye calibration is of lower accuracy.
EYE_CALIBRATION_STATUS_FINE_ML	Eye calibration is of higher accuracy.

See Also

XrEventDataEyeCalibrationChangedML

See Also:

• Constant Field Values

XR_EYE_CALIBRATION_STATUS_FINE_ML

public static final int XR_EYE_CALIBRATION_STATUS_FINE_ML

XrEyeCalibrationStatusML - Headset fit status

Description

Enum	Description
EYE_CALIBRATION_STATUS_UNKNOWN_ML	Eye calibration status not available for unknown reason.
EYE_CALIBRATION_STATUS_NONE_ML	User has not performed the eye calibration step. Use system provided app to perform eye calibration.
EYE_CALIBRATION_STATUS_COARSE_ML	Eye calibration is of lower accuracy.
EYE_CALIBRATION_STATUS_FINE_ML	Eye calibration is of higher accuracy.

See Also

XrEventDataEyeCalibrationChangedML

See Also:

• Constant Field Values

Method Details

nxrEnableUserCalibrationEventsML

public static int nxrEnableUserCalibrationEventsML(org.lwjgl.openxr.XrInstance instance,
 long enableInfo)

Unsafe version of: EnableUserCalibrationEventsML

xrEnableUserCalibrationEventsML

public static int xrEnableUserCalibrationEventsML(org.lwjgl.openxr.XrInstance instance,
 XrUserCalibrationEnableEventsInfoML enableInfo)

Enable/disable user calibration events.

C Specification

The EnableUserCalibrationEventsML function is defined as:

 XrResult xrEnableUserCalibrationEventsML(
     XrInstance                                  instance,
     const XrUserCalibrationEnableEventsInfoML*  enableInfo);

Valid Usage (Implicit)

• The XR_ML_user_calibration extension must be enabled prior to calling EnableUserCalibrationEventsML
• instance must be a valid XrInstance handle
• enableInfo must be a pointer to a valid XrUserCalibrationEnableEventsInfoML structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST

See Also

XrUserCalibrationEnableEventsInfoML

Parameters:

instance - a handle to an XrInstance previously created with CreateInstance.

enableInfo - the XrUserCalibrationEnableEventsInfoML that enables or disables user calibration events.