PICO Unity XR SDK
Static Public Member Functions | List of all members
PXR_EyeTracking Class Reference

Static Public Member Functions

static bool GetHeadPosMatrix (out Matrix4x4 matrix)
 Gets the PosMatrix of the head. More...
 
static bool GetCombineEyeGazePoint (out Vector3 point)
 Gets the position of the combined gaze point. More...
 
static bool GetCombineEyeGazeVector (out Vector3 vector)
 Gets the direction of the combined gaze point. More...
 
static bool GetLeftEyeGazeOpenness (out float openness)
 Gets the openness/closeness of the left eye. More...
 
static bool GetRightEyeGazeOpenness (out float openness)
 Gets the openness/closeness of the right eye. More...
 
static bool GetLeftEyePoseStatus (out uint status)
 Gets whether the data of the current left eye is available. More...
 
static bool GetRightEyePoseStatus (out uint status)
 Gets whether the data of the current right eye is available. More...
 
static bool GetCombinedEyePoseStatus (out uint status)
 Gets whether the data of the combined eye is available. 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). 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). More...
 
static bool GetFoveatedGazeDirection (out Vector3 direction)
 Gets the foveated gaze direction (i.e., the central point of fixed foveated rendering). More...
 
static bool GetFoveatedGazeTrackingState (out uint state)
 Gets whether the current foveated gaze tracking data is available. More...
 

Member Function Documentation

◆ GetHeadPosMatrix()

static bool GetHeadPosMatrix ( out Matrix4x4  matrix)
static

Gets the PosMatrix of the head.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
matrixA Matrix4x4 value returned by the result.
Returns
  • true: success
  • false: failure

◆ GetCombineEyeGazePoint()

static bool GetCombineEyeGazePoint ( out Vector3  point)
static

Gets the position of the combined gaze point.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
pointA vector3 value returned by the result.
Returns
  • true: success
  • false: failure

◆ GetCombineEyeGazeVector()

static bool GetCombineEyeGazeVector ( out Vector3  vector)
static

Gets the direction of the combined gaze point.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
vectorA vector3 value returned by the result.
Returns
  • true: success
  • false: failure

◆ GetLeftEyeGazeOpenness()

static bool GetLeftEyeGazeOpenness ( out float  openness)
static

Gets the openness/closeness of the left eye.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
opennessA float value returned by the result. The value ranges from 0.0 to 1.0. 0.0 incicates completely closed, 1.0 indicates completely open.
Returns
  • true: success
  • false: failure

◆ GetRightEyeGazeOpenness()

static bool GetRightEyeGazeOpenness ( out float  openness)
static

Gets the openness/closeness of the right eye.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
opennessA float value returned by the result. The value ranges from 0.0 to 1.0. 0.0 indicates completely closed, 1.0 indicates completely open.
Returns
  • true: success
  • false: failure

◆ GetLeftEyePoseStatus()

static bool GetLeftEyePoseStatus ( out uint  status)
static

Gets whether the data of the current left eye is available.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
statusAn int value returned by the result:
  • 0: not available
  • 1: available
Returns
  • true: success
  • false: failure

◆ GetRightEyePoseStatus()

static bool GetRightEyePoseStatus ( out uint  status)
static

Gets whether the data of the current right eye is available.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
statusAn int value returned by the result:
  • 0: not available
  • 1: available
Returns
  • true: success
  • false: failure

◆ GetCombinedEyePoseStatus()

static bool GetCombinedEyePoseStatus ( out uint  status)
static

Gets whether the data of the combined eye is available.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
statusAn int value returned by the result: 0: not available 1: available
Returns
  • true: success
  • false: failure

◆ 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).

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
positionA vector3 value returned by the result.
Returns
  • true: success
  • false: failure

◆ 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).

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
positionA vector3 value returned by the result.
Returns
  • true: success
  • false: failure

◆ GetFoveatedGazeDirection()

static bool GetFoveatedGazeDirection ( out Vector3  direction)
static

Gets the foveated gaze direction (i.e., the central point of fixed foveated rendering).

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
directionA vector3 value returned by the result.
Returns
  • true: success
  • false: failure

◆ GetFoveatedGazeTrackingState()

static bool GetFoveatedGazeTrackingState ( out uint  state)
static

Gets whether the current foveated gaze tracking data is available.

Note
Supported by PICO Neo3 Pro Eye, PICO 4 Pro/Enterprise.
Parameters
statusAn int value returned by the result:
  • 0: not available
  • 1: available
Returns
  • true: success
  • false: failure