PICO Unity XR SDK
PXR_EyeTracking Class Reference

Static Public Member Functions

static bool GetHeadPosMatrix (out Matrix4x4 matrix)
 Gets the PosMatrix of the head. This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetCombineEyeGazePoint (out Vector3 point)
 Gets the position of the combined gaze point for left and right eye. This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetCombineEyeGazeVector (out Vector3 vector)
 Gets the direction of the combined gaze point for left and right eye. This interface is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetLeftEyeGazeOpenness (out float openness)
 Gets the openness of the left eye. This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetRightEyeGazeOpenness (out float openness)
 Gets the openness of the right eye. This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetLeftEyePoseStatus (out uint status)
 Gets the pose status of the left eye. This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetRightEyePoseStatus (out uint status)
 Gets the pose status of the right eye. This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetCombinedEyePoseStatus (out uint status)
 Gets the combined pose status for left and right eye. This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetLeftEyePositionGuide (out Vector3 position)
 Gets the position of the left eye in a coordinate system. The upper-right point of the sensor is taken as the origin (0, 0) and the lower-left point is taken as (1, 1). This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetRightEyePositionGuide (out Vector3 position)
 Gets the position of the right eye in a coordinate system. The upper-right point of the sensor is taken as the origin (0, 0) and the lower-left point is taken as (1, 1). This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetFoveatedGazeDirection (out Vector3 direction)
 Gets the gaze direction for foveated rendering (i.e., the central point of fixed foveated rendering). This function is only available for Neo2 Eye and Neo3 Pro. More...
 
static bool GetFoveatedGazeTrackingState (out uint state)
 Gets the current state of the signal for foveated gaze direction. This function is only available for Neo 2 Eye and Neo 3 Pro. More...
 

Static Private Member Functions

static bool GetEyeTrackingDevice (out InputDevice device)
 Gets the input device for eye tracking data. This function is only available for Neo2 Eye and Neo3 Pro. More...
 

Member Function Documentation

◆ GetCombinedEyePoseStatus()

static bool GetCombinedEyePoseStatus ( out uint  status)
static

Gets the combined pose status for left and right eye. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
statusAn int value that indicates the combined pose status returned by the result: 0-not good; 1-good.
Returns
Whether the pose status has been returned: true-returned; false-failed to return.

◆ GetCombineEyeGazePoint()

static bool GetCombineEyeGazePoint ( out Vector3  point)
static

Gets the position of the combined gaze point for left and right eye. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
pointA vector3 value that indicates the position returned by the result.
Returns
Whether the position has been returned: true-returned; false-failed to return.

◆ GetCombineEyeGazeVector()

static bool GetCombineEyeGazeVector ( out Vector3  vector)
static

Gets the direction of the combined gaze point for left and right eye. This interface is only available for Neo2 Eye and Neo3 Pro.

Parameters
vectorA vector3 value that indicates the direction returned by the result.
Returns
Whether the direction has been returned: true-returned; false-failed to return.

◆ GetEyeTrackingDevice()

static bool GetEyeTrackingDevice ( out InputDevice  device)
staticprivate

Gets the input device for eye tracking data. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
deviceThe input device returned by the result.
Returns
Whether the input device has been returned: true-returned; false-failed to return.

◆ GetFoveatedGazeDirection()

static bool GetFoveatedGazeDirection ( out Vector3  direction)
static

Gets the gaze direction for foveated rendering (i.e., the central point of fixed foveated rendering). This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
directionA vector3 value that indicates the direction returned by the result.
Returns
Whether the vector 3 direction has been returned: true-returned; false-failed to return.

◆ GetFoveatedGazeTrackingState()

static bool GetFoveatedGazeTrackingState ( out uint  state)
static

Gets the current state of the signal for foveated gaze direction. This function is only available for Neo 2 Eye and Neo 3 Pro.

Parameters
statusAn int value that indicates the signal's state returned by the result: 0-not good; 1-good.
Returns
Whether the state has been returned: true-returned; false-failed to return.

◆ GetHeadPosMatrix()

static bool GetHeadPosMatrix ( out Matrix4x4  matrix)
static

Gets the PosMatrix of the head. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
matrixThe Matrix4x4 returned by the result.
Returns
Whether Matrix4x4 has been returned: true-returned; false-failed to return.

◆ GetLeftEyeGazeOpenness()

static bool GetLeftEyeGazeOpenness ( out float  openness)
static

Gets the openness of the left eye. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
opennessA float value that indicates the eye openness returned by the result. The valid value ranges from 0.0 to 1.0. 0.0 incicates completely closed, 1.0 indicates completely open.
Returns
Whether the openness of the left eye has been returned: true-returned; false-failed to return.

◆ GetLeftEyePoseStatus()

static bool GetLeftEyePoseStatus ( out uint  status)
static

Gets the pose status of the left eye. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
statusAn int value that indicates the pose status returned by the result: 0-not good; 1-good.
Returns
Whether the pose status has been returned: true-returned; false-failed to return.

◆ GetLeftEyePositionGuide()

static bool GetLeftEyePositionGuide ( out Vector3  position)
static

Gets the position of the left eye in a coordinate system. The upper-right point of the sensor is taken as the origin (0, 0) and the lower-left point is taken as (1, 1). This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
positionA vector3 value that indicates the position returned by the result.
Returns
Whether the position has been returned: true-returned; false-failed to return.

◆ GetRightEyeGazeOpenness()

static bool GetRightEyeGazeOpenness ( out float  openness)
static

Gets the openness of the right eye. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
opennessA float value that indicates the eye openness returned by the result. The valid value ranges from 0.0 to 1.0. 0.0 indicates completely closed, 1.0 indicates completely open.
Returns
Whether the openness of the right eye has been returned: true-returned; false-failed to return.

◆ GetRightEyePoseStatus()

static bool GetRightEyePoseStatus ( out uint  status)
static

Gets the pose status of the right eye. This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
statusAn int value that indicates the pose status returned by the result: 0-not good; 1-good.
Returns
Whether the pose status has been returned: true-returned; false-failed to return.

◆ GetRightEyePositionGuide()

static bool GetRightEyePositionGuide ( out Vector3  position)
static

Gets the position of the right eye in a coordinate system. The upper-right point of the sensor is taken as the origin (0, 0) and the lower-left point is taken as (1, 1). This function is only available for Neo2 Eye and Neo3 Pro.

Parameters
positionA vector3 value that indicates the position returned by the result.
Returns
Whether the vector 3 position has been returned: true-returned; false-failed to return.

The documentation for this class was generated from the following file: