Package org.lwjgl.openxr

Class FBEyeTrackingSocial

java.lang.Object

org.lwjgl.openxr.FBEyeTrackingSocial

public class FBEyeTrackingSocial
extends Object

The XR_FB_eye_tracking_social extension.

This extension enables applications to obtain position and orientation of the user’s eyes. It enables applications to render eyes in XR experiences.

This extension is intended to drive animation of avatar eyes. So, for that purpose, the runtimes may filter the poses in ways that are suitable for avatar eye interaction but detrimental to other use cases. This extension should not be used for other eye tracking purposes. For interaction, XR_EXT_eye_gaze_interaction should be used.

Eye tracking data is sensitive personal information and is closely linked to personal privacy and integrity. It is strongly recommended that applications that store or transfer eye tracking data always ask the user for active and specific acceptance to do so.

If a runtime supports a permission system to control application access to the eye tracker, then the runtime must set the isValid field to FALSE on the supplied XrEyeGazeFB structure until the application has been allowed access to the eye tracker. When the application access has been allowed, the runtime may set isValid on the supplied XrEyeGazeFB structure to TRUE.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_EYE_POSITION_COUNT_FB	XrEyePositionFB - Enumerates eyes.
static final int	XR_EYE_POSITION_LEFT_FB	XrEyePositionFB - Enumerates eyes.
static final int	XR_EYE_POSITION_RIGHT_FB	XrEyePositionFB - Enumerates eyes.
static final String	XR_FB_EYE_TRACKING_SOCIAL_EXTENSION_NAME	The extension name.
static final int	XR_FB_eye_tracking_social_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_EYE_TRACKER_FB	Extends XrObjectType.
static final int	XR_TYPE_EYE_GAZES_FB	Extends XrStructureType.
static final int	XR_TYPE_EYE_GAZES_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_EYE_TRACKER_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateEyeTrackerFB(XrSession session, long createInfo, long eyeTracker)	Unsafe version of: CreateEyeTrackerFB
static int	nxrGetEyeGazesFB(XrEyeTrackerFB eyeTracker, long gazeInfo, long eyeGazes)	Unsafe version of: GetEyeGazesFB
static int	xrCreateEyeTrackerFB(XrSession session, XrEyeTrackerCreateInfoFB createInfo, org.lwjgl.PointerBuffer eyeTracker)	Create an eye gaze handle.
static int	xrDestroyEyeTrackerFB(XrEyeTrackerFB eyeTracker)	Destroy an eye gaze handle.
static int	xrGetEyeGazesFB(XrEyeTrackerFB eyeTracker, XrEyeGazesInfoFB gazeInfo, XrEyeGazesFB eyeGazes)	Locate eye gaze directions.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_eye_tracking_social_SPEC_VERSION

public static final int XR_FB_eye_tracking_social_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_EYE_TRACKING_SOCIAL_EXTENSION_NAME

public static final String XR_FB_EYE_TRACKING_SOCIAL_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_EYE_TRACKER_FB

public static final int XR_OBJECT_TYPE_EYE_TRACKER_FB

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TYPE_EYE_TRACKER_CREATE_INFO_FB

public static final int XR_TYPE_EYE_TRACKER_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_EYE_TRACKER_CREATE_INFO_FB
• TYPE_EYE_GAZES_INFO_FB
• TYPE_EYE_GAZES_FB
• TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB

See Also:

• Constant Field Values

XR_TYPE_EYE_GAZES_INFO_FB

public static final int XR_TYPE_EYE_GAZES_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_EYE_TRACKER_CREATE_INFO_FB
• TYPE_EYE_GAZES_INFO_FB
• TYPE_EYE_GAZES_FB
• TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB

See Also:

• Constant Field Values

XR_TYPE_EYE_GAZES_FB

public static final int XR_TYPE_EYE_GAZES_FB

Extends XrStructureType.

Enum values:

• TYPE_EYE_TRACKER_CREATE_INFO_FB
• TYPE_EYE_GAZES_INFO_FB
• TYPE_EYE_GAZES_FB
• TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB

public static final int XR_TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB

Extends XrStructureType.

Enum values:

• TYPE_EYE_TRACKER_CREATE_INFO_FB
• TYPE_EYE_GAZES_INFO_FB
• TYPE_EYE_GAZES_FB
• TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_FB

See Also:

• Constant Field Values

XR_EYE_POSITION_LEFT_FB

public static final int XR_EYE_POSITION_LEFT_FB

XrEyePositionFB - Enumerates eyes.

Enumerant Descriptions

• EYE_POSITION_LEFT_FB — Specifies the position of the left eye.
• EYE_POSITION_RIGHT_FB — Specifies the position of the right eye.

See Also

XrEyeGazesFB

Enum values:

• EYE_POSITION_COUNT_FB

See Also:

• Constant Field Values

XR_EYE_POSITION_RIGHT_FB

public static final int XR_EYE_POSITION_RIGHT_FB

XrEyePositionFB - Enumerates eyes.

Enumerant Descriptions

• EYE_POSITION_LEFT_FB — Specifies the position of the left eye.
• EYE_POSITION_RIGHT_FB — Specifies the position of the right eye.

See Also

XrEyeGazesFB

Enum values:

• EYE_POSITION_COUNT_FB

See Also:

• Constant Field Values

XR_EYE_POSITION_COUNT_FB

public static final int XR_EYE_POSITION_COUNT_FB

XrEyePositionFB - Enumerates eyes.

Enumerant Descriptions

• EYE_POSITION_LEFT_FB — Specifies the position of the left eye.
• EYE_POSITION_RIGHT_FB — Specifies the position of the right eye.

See Also

XrEyeGazesFB

Enum values:

• EYE_POSITION_COUNT_FB

See Also:

• Constant Field Values

Method Details

nxrCreateEyeTrackerFB

public static int nxrCreateEyeTrackerFB(XrSession session,
 long createInfo,
 long eyeTracker)

Unsafe version of: CreateEyeTrackerFB

xrCreateEyeTrackerFB

public static int xrCreateEyeTrackerFB(XrSession session,
 XrEyeTrackerCreateInfoFB createInfo,
 org.lwjgl.PointerBuffer eyeTracker)

Create an eye gaze handle.

C Specification

An application creates an XrEyeTrackerFB handle using CreateEyeTrackerFB function.

 XrResult xrCreateEyeTrackerFB(
     XrSession                                   session,
     const XrEyeTrackerCreateInfoFB*             createInfo,
     XrEyeTrackerFB*                             eyeTracker);

Description

If the system does not support eye tracking, the runtime must return ERROR_FEATURE_UNSUPPORTED from CreateEyeTrackerFB. In this case, the runtime must return FALSE for XrSystemEyeTrackingPropertiesFB::supportsEyeTracking when the function GetSystemProperties is called, so that the application can avoid creating an eye tracker.

Valid Usage (Implicit)

• The XR_FB_eye_tracking_social extension must be enabled prior to calling CreateEyeTrackerFB
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrEyeTrackerCreateInfoFB structure
• eyeTracker must be a pointer to an XrEyeTrackerFB 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

XrEyeTrackerCreateInfoFB

Parameters:

session - an XrSession in which the eye tracker will be active.

createInfo - the XrEyeTrackerCreateInfoFB used to specify the eye tracker.

eyeTracker - the returned XrEyeTrackerFB handle.

xrDestroyEyeTrackerFB

public static int xrDestroyEyeTrackerFB(XrEyeTrackerFB eyeTracker)

Destroy an eye gaze handle.

C Specification

DestroyEyeTrackerFB function releases the eyeTracker and the underlying resources when the eye tracking experience is over.

 XrResult xrDestroyEyeTrackerFB(
     XrEyeTrackerFB                              eyeTracker);

Valid Usage (Implicit)

• The XR_FB_eye_tracking_social extension must be enabled prior to calling DestroyEyeTrackerFB
• eyeTracker must be a valid XrEyeTrackerFB handle

Thread Safety

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

Parameters:

eyeTracker - an XrEyeTrackerFB previously created by CreateEyeTrackerFB.

nxrGetEyeGazesFB

public static int nxrGetEyeGazesFB(XrEyeTrackerFB eyeTracker,
 long gazeInfo,
 long eyeGazes)

Unsafe version of: GetEyeGazesFB

xrGetEyeGazesFB

public static int xrGetEyeGazesFB(XrEyeTrackerFB eyeTracker,
 XrEyeGazesInfoFB gazeInfo,
 XrEyeGazesFB eyeGazes)

Locate eye gaze directions.

C Specification

The GetEyeGazesFB function is defined as:

 XrResult xrGetEyeGazesFB(
     XrEyeTrackerFB                              eyeTracker,
     const XrEyeGazesInfoFB*                     gazeInfo,
     XrEyeGazesFB*                               eyeGazes);

Description

The GetEyeGazesFB function obtains pose for a user’s eyes at a specific time and within a specific coordinate system.

Valid Usage (Implicit)

• The XR_FB_eye_tracking_social extension must be enabled prior to calling GetEyeGazesFB
• eyeTracker must be a valid XrEyeTrackerFB handle
• gazeInfo must be a pointer to a valid XrEyeGazesInfoFB structure
• eyeGazes must be a pointer to an XrEyeGazesFB structure

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_TIME_INVALID

See Also

XrEyeGazesFB, XrEyeGazesInfoFB

Parameters:

eyeTracker - an XrEyeTrackerFB previously created by CreateEyeTrackerFB.

gazeInfo - the information to get eye gaze.

eyeGazes - a pointer to XrEyeGazesFB receiving the returned eye poses and confidence.