Interface IMixedRealityEyeGazeProvider

Implements the Gaze Provider for an Input Source.

Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public interface IMixedRealityEyeGazeProvider : IMixedRealityGazeProvider

Properties

IsEyeCalibrationValid

Whether the user is eye calibrated. It returns 'null', if the value has not yet received data from the eye tracking system.

Declaration
bool? IsEyeCalibrationValid { get; }
Property Value
Type Description
Nullable<Boolean>

IsEyeTrackingDataValid

Whether eye tracking data is available. It may be unavailable due to timeout or lack of tracking hardware or permissions.

Declaration
bool IsEyeTrackingDataValid { get; }
Property Value
Type Description
Boolean

IsEyeTrackingEnabled

If true, eye-based tracking will be used when available.

Declaration
bool IsEyeTrackingEnabled { get; set; }
Property Value
Type Description
Boolean
Remarks

The usage of eye-based tracking depends on having the Gaze Input permission set and user approved, along with proper device eye calibration. This will fallback to head-based gaze when eye-based tracking is not available.

IsEyeTrackingEnabledAndValid

Whether eye tracking data is currently been used for gaze rather then head pose. Eye Tracking must be both enabled and have valid data.

Declaration
bool IsEyeTrackingEnabledAndValid { get; }
Property Value
Type Description
Boolean

LatestEyeGaze

The most recent eye tracking ray

Declaration
Ray LatestEyeGaze { get; }
Property Value
Type Description
Ray

Timestamp

DateTime in UTC when the signal was last updated.

Declaration
DateTime Timestamp { get; }
Property Value
Type Description
DateTime

Methods

UpdateEyeGaze(IMixedRealityEyeGazeDataProvider, Ray, DateTime)

Tells the eye gaze provider that eye gaze has updated.

Declaration
void UpdateEyeGaze(IMixedRealityEyeGazeDataProvider provider, Ray eyeRay, DateTime timestamp)
Parameters
Type Name Description
IMixedRealityEyeGazeDataProvider provider

The provider raising the event.
Ray eyeRay
DateTime timestamp
Remarks

This method is to be called by implementations of the IMixedRealityEyeGazeDataProvider interface, not by application code.

UpdateEyeTrackingStatus(IMixedRealityEyeGazeDataProvider, Boolean)

Tells the eye gaze provider about the eye tracking status (e.g., whether the user is calibrated);

Declaration
void UpdateEyeTrackingStatus(IMixedRealityEyeGazeDataProvider provider, bool userIsEyeCalibrated)
Parameters
Type Name Description
IMixedRealityEyeGazeDataProvider provider

The provider raising the event.
Boolean userIsEyeCalibrated

Boolean whether the user is eye calibrated or not.
Remarks

Note that this function is not invoked when eye tracking is lost - use IsEyeTrackingAvailable to detect when eye tracking is lost.