docs.unity3d.com
    Show / Hide Table of Contents

    Class EyeGazeInteraction

    This OpenXRInteractionFeature enables the use of eye gaze interaction profiles in OpenXR. It enables XR_EXT_eye_gaze_interaction in the underlying runtime. This creates a new InputDevice with the EyeTracking characteristic. This new device has both gazePosition and gazeRotation input features, as well as isTracked and trackingState usages to determine if the gaze is available.

    Inheritance
    Object
    Object
    ScriptableObject
    OpenXRFeature
    OpenXRInteractionFeature
    EyeGazeInteraction
    Inherited Members
    OpenXRInteractionFeature.AddActionMap(OpenXRInteractionFeature.ActionMapConfig)
    OpenXRInteractionFeature.OnEnabledChange()
    OpenXRFeature.enabled
    OpenXRFeature.xrGetInstanceProcAddr
    OpenXRFeature.HookGetInstanceProcAddr(IntPtr)
    OpenXRFeature.OnSubsystemCreate()
    OpenXRFeature.OnSubsystemStart()
    OpenXRFeature.OnSubsystemStop()
    OpenXRFeature.OnSubsystemDestroy()
    OpenXRFeature.OnSystemChange(UInt64)
    OpenXRFeature.OnSessionCreate(UInt64)
    OpenXRFeature.OnAppSpaceChange(UInt64)
    OpenXRFeature.OnSessionStateChange(Int32, Int32)
    OpenXRFeature.OnSessionBegin(UInt64)
    OpenXRFeature.OnSessionEnd(UInt64)
    OpenXRFeature.OnSessionExiting(UInt64)
    OpenXRFeature.OnSessionDestroy(UInt64)
    OpenXRFeature.OnInstanceDestroy(UInt64)
    OpenXRFeature.OnSessionLossPending(UInt64)
    OpenXRFeature.OnInstanceLossPending(UInt64)
    OpenXRFeature.OnFormFactorChange(Int32)
    OpenXRFeature.OnViewConfigurationTypeChange(Int32)
    OpenXRFeature.OnEnvironmentBlendModeChange(XrEnvironmentBlendMode)
    OpenXRFeature.PathToString(UInt64)
    OpenXRFeature.StringToPath(String)
    OpenXRFeature.GetCurrentInteractionProfile(UInt64)
    OpenXRFeature.GetCurrentInteractionProfile(String)
    OpenXRFeature.GetCurrentAppSpace()
    OpenXRFeature.GetViewConfigurationTypeForRenderPass(Int32)
    OpenXRFeature.SetEnvironmentBlendMode(XrEnvironmentBlendMode)
    OpenXRFeature.GetEnvironmentBlendMode()
    OpenXRFeature.CreateSubsystem<TDescriptor, TSubsystem>(List<TDescriptor>, String)
    OpenXRFeature.StartSubsystem<T>()
    OpenXRFeature.StopSubsystem<T>()
    OpenXRFeature.DestroySubsystem<T>()
    OpenXRFeature.OnEnable()
    OpenXRFeature.OnDisable()
    OpenXRFeature.GetAction(InputAction)
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.OpenXR.Features.Interactions
    Syntax
    public class EyeGazeInteraction : OpenXRInteractionFeature

    Fields

    extensionString

    The OpenXR Extension string. This is used by OpenXR to check if this extension is available or enabled. See eye gaze interaction extension documentation for more information on this OpenXR extension.

    Declaration
    public const string extensionString = "XR_EXT_eye_gaze_interaction"
    Field Value
    Type Description
    String

    featureId

    The feature id string. This is used to give the feature a well known id for reference.

    Declaration
    public const string featureId = "com.unity.openxr.feature.input.eyetracking"
    Field Value
    Type Description
    String

    Methods

    OnInstanceCreate(UInt64)

    Called after xrCreateInstance.

    Declaration
    protected override bool OnInstanceCreate(ulong instance)
    Parameters
    Type Name Description
    UInt64 instance
    Returns
    Type Description
    Boolean
    Overrides
    OpenXRInteractionFeature.OnInstanceCreate(UInt64)

    RegisterActionMapsWithRuntime()

    Register action maps for this device with the OpenXR Runtime. Called at runtime before Start.

    Declaration
    protected override void RegisterActionMapsWithRuntime()
    Overrides
    OpenXRInteractionFeature.RegisterActionMapsWithRuntime()

    RegisterDeviceLayout()

    Registers the EyeGazeInteraction.EyeGazeDevice layout with the Input System.

    Declaration
    protected override void RegisterDeviceLayout()
    Overrides
    OpenXRInteractionFeature.RegisterDeviceLayout()

    UnregisterDeviceLayout()

    Removes the EyeGazeInteraction.EyeGazeDevice layout from the Input System.

    Declaration
    protected override void UnregisterDeviceLayout()
    Overrides
    OpenXRInteractionFeature.UnregisterDeviceLayout()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023