public Class FBEyeTrackingSocial

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

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

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

The extension name.

The extension specification version.

Extends XrObjectType.

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

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

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

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

Unsafe version of: CreateEyeTrackerFB

Unsafe version of: GetEyeGazesFB

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 supportsEyeTracking in XrSystemEyeTrackingPropertiesFB 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:XrSession

an XrSession in which the eye tracker will be active.

createInfo:XrEyeTrackerCreateInfoFB

the XrEyeTrackerCreateInfoFB used to specify the eye tracker.

eyeTracker:PointerBuffer

the returned XrEyeTrackerFB handle.

Annotations

@NativeType:XrResult

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:XrEyeTrackerFB

an XrEyeTrackerFB previously created by CreateEyeTrackerFB.

Annotations

@NativeType:XrResult

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:XrEyeTrackerFB

an XrEyeTrackerFB previously created by CreateEyeTrackerFB.

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

gazeInfo:XrEyeGazesInfoFB

the information to get eye gaze.

Annotations

@NativeType:XrResult