Android XR for OpenXR | Android Developers

Android XR SDK がデベロッパープレビュー 3 に到達しました。皆様からのフィードバックをお待ちしております。お試しいただき、ご不明な点がありましたら、サポートページからお問い合わせください。

XR_ANDROID_eye_tracking

名前文字列

XR_ANDROID_eye_tracking

拡張機能の種類

インスタンス拡張機能

登録済み拡張機能番号

457

リビジョン

批准ステータス

批准されていません

拡張機能とバージョンの依存関係

OpenXR 1.0

最終更新日

2025-01-17

IP ステータス

既知の IP クレームはありません。

寄与者

Spencer Quin（Google）
Jared Finder（Google）
Levana Chen（Google）
Kenny Vercaemer（Google）
Prasanthi Gurumurthy（Google）
Nihav Jain（Google）

概要

この拡張機能を使用すると、アプリケーションはユーザーの目の位置と向き、およびアイトラッキングのステータスを取得できます。

アイトラッキングデータは、粗いモードと細かいモードの 2 つのモードで提供されます。粗いトラッキングでは、ユーザーの目の粗い推定値が提供されますが、細かいトラッキングでは、より正確な推定値が提供されます。粗いトラッキングは、基本的なアバターのような表現を提供したいアプリケーションを対象としていますが、細かいトラッキングは、より正確なアプリケーションを対象としています。

インタラクションには、XR_EXT_eye_gaze_interaction を使用する必要があります 。

権限

Android アプリケーションは、マニフェストに android.permission.EYE_TRACKING_COARSE 権限または android.permission.EYE_TRACKING_FINE 権限を記載する必要があります 。これらの権限は危険な権限と見なされます。アプリケーションは、これらの関数を使用するために、実行時に権限をリクエストする必要があります 。

xrCreateEyeTrackerANDROID（権限のいずれか 1 つ）
xrGetCoarseTrackingEyesInfoANDROID（android.permission.EYE_TRACKING_COARSE）
xrGetFineTrackingEyesInfoANDROID（android.permission.EYE_TRACKING_FINE）

（保護レベル: 危険）

システム機能の検査

XrSystemEyeTrackingPropertiesANDROID 構造体は次のように定義されます。

typedef struct XrSystemEyeTrackingPropertiesANDROID {
    XrStructureType    type;
    void*              next;
    XrBool32           supportsEyeTracking;
} XrSystemEyeTrackingPropertiesANDROID;

メンバーの説明

type は、この構造体の XrStructureType です。
next は、NULL または構造体チェーン内の次の構造体へのポインタです。このような構造体は、コア OpenXR またはこの拡張機能では定義されていません。
supportsEyeTracking は、現在のシステムがアイトラッキングをサポートしているかどうかを示す XrBool32 です。

アプリケーションは、xrGetSystemProperties を呼び出すときに XrSystemProperties を XrSystemEyeTrackingPropertiesANDROID 構造体で拡張することで、システムがアイトラッキングに対応しているかどうかを検査できます 。

ランタイムが XR_FALSE に対して supportsEyeTracking を返す場合のみ、ランタイムは xrCreateEyeTrackerANDROID から XR_ERROR_FEATURE_UNSUPPORTED を返す必要があります。

有効な使用方法（暗黙的）

XrSystemEyeTrackingPropertiesANDROID を使用する前に、XR_ANDROID_eye_tracking 拡張機能を有効にする必要があります
type は XR_TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_ANDROIDである**必要があります**
next は、NULL または構造体チェーン内の次の構造体への有効なポインタである**必要があります**。

アイトラッカーハンドルの作成

XR_DEFINE_HANDLE(XrEyeTrackerANDROID)

XrEyeTrackerANDROID ハンドルは、目をトラッキングし、ユーザーが見ている場所を正確にマッピングするアイトラッカーを表します。

アイトラッキングデータは機密性の高い個人情報であり、個人のプライバシーと完全性に密接に関連しています。アイトラッキングデータを保存または転送するアプリケーションでは、常にユーザーに明示的な同意を求めることを強くおすすめします。

アプリケーションは、このハンドルを使用して、この拡張機能の他の関数を使用してアイトラッキングデータにアクセスします。

アイトラッキングは、シーン内の目のポーズとステータスの表現を提供します。

xrCreateEyeTrackerANDROID 関数は次のように定義されます。

XrResult xrCreateEyeTrackerANDROID(
    XrSession                                   session,
    const XrEyeTrackerCreateInfoANDROID*        createInfo,
    XrEyeTrackerANDROID*                        eyeTracker);

パラメータの説明

session は、XrSession ハンドルで、アイトラッキングが有効になります。
createInfo は、アイトラッキングの指定に使用される XrEyeTrackerCreateInfoANDROID です。
eyeTracker は、返される XrEyeTrackerANDROID ハンドルです。

アプリケーションは、XrEyeTrackerANDROID ハンドルを xrCreateEyeTrackerANDROID 関数を使用して作成します。

システムがアイトラッキングをサポートしていない場合、ランタイムは 返す必要があります XR_ERROR_FEATURE_UNSUPPORTED xrCreateEyeTrackerANDROID から。

有効な使用方法（暗黙的）

XR_ANDROID_eye_tracking 拡張機能を xrCreateEyeTrackerANDROID を呼び出す前に有効にする必要があります。
session は有効な XrSession ハンドルである必要があります
createInfo は、有効な XrEyeTrackerCreateInfoANDROID 構造体へのポインタである**必要があります** 。
eyeTracker は、XrEyeTrackerANDROID ハンドルへのポインタである**必要があります**。

戻りコード

成功

XR_SUCCESS
XR_SESSION_LOSS_PENDING

失敗

XR_ERROR_FEATURE_UNSUPPORTED
XR_ERROR_FUNCTION_UNSUPPORTED
XR_ERROR_HANDLE_INVALID
XR_ERROR_INSTANCE_LOST
XR_ERROR_LIMIT_REACHED
XR_ERROR_OUT_OF_MEMORY
XR_ERROR_RUNTIME_FAILURE
XR_ERROR_SESSION_LOST
XR_ERROR_VALIDATION_FAILURE

XrEyeTrackerCreateInfoANDROID 構造体は次のように定義されます。

typedef struct XrEyeTrackerCreateInfoANDROID {
    XrStructureType    type;
    const void*        next;
} XrEyeTrackerCreateInfoANDROID;

メンバーの説明

type は、この構造体の XrStructureType です。
next は、NULL または構造体チェーン内の次の構造体へのポインタです。このような構造体は、コア OpenXR またはこの拡張機能では定義されていません。

XrEyeTrackerCreateInfoANDROID 構造体は、XrEyeTrackerANDROID ハンドルを作成するための情報を記述します。

有効な使用方法（暗黙的）

XrEyeTrackerCreateInfoANDROID を使用する前に、XR_ANDROID_eye_tracking 拡張機能を有効にする必要があります
type は XR_TYPE_EYE_TRACKER_CREATE_INFO_ANDROIDである**必要があります**
next は、NULL または構造体チェーン内の次の構造体への有効なポインタである**必要があります**。

xrDestroyEyeTrackerANDROID 関数は次のように定義されます。

XrResult xrDestroyEyeTrackerANDROID(
    XrEyeTrackerANDROID                         eyeTracker);

パラメータの説明

eyeTracker は、XrEyeTrackerANDROID で以前に作成された xrCreateEyeTrackerANDROID です。

xrDestroyEyeTrackerANDROID 関数は、アイトラッキングエクスペリエンスが終了すると、eyeTracker と基盤となるリソースを解放します。

有効な使用方法（暗黙的）

XR_ANDROID_eye_tracking 拡張機能を xrDestroyEyeTrackerANDROID を呼び出す前に有効にする 必要があります
eyeTracker は有効な XrEyeTrackerANDROID ハンドルである必要があります

スレッドセーフ

eyeTracker と子ハンドルへのアクセスは、外部で同期する必要があります 。

戻りコード

成功

XR_SUCCESS

失敗

XR_ERROR_FUNCTION_UNSUPPORTED
XR_ERROR_HANDLE_INVALID

目の情報の取得

xrGetCoarseTrackingEyesInfoANDROID 関数は次のように定義されます。

XrResult xrGetCoarseTrackingEyesInfoANDROID(
    XrEyeTrackerANDROID                         eyeTracker,
    const XrEyesGetInfoANDROID*                 getInfo,
    XrEyesANDROID*                              eyesOutput);

パラメータの説明

eyeTracker は、XrEyeTrackerANDROID で以前に作成された xrCreateEyeTrackerANDROID です。
getInfo は、目のポーズと状態のクエリに使用する情報を提供する XrEyesGetInfoANDROID へのポインタです。
eyesOutput は、ポーズや状態などの返された目の情報を含む XrEyesANDROID へのポインタです。

xrGetCoarseTrackingEyesInfoANDROID 関数は、ユーザーのプライバシーを保護する方法で、目の状態とポーズの情報を取得します。

アプリケーションに android.permission.EYE_TRACKING_COARSE 権限がない場合、ランタイムは XR_ERROR_PERMISSION_INSUFFICIENT を返す必要があります 。

目のポーズは、XrEyesGetInfoANDROID :: time の XrEyesGetInfoANDROID :: baseSpace で表されます。

目のポーズの位置と方向は、いつでもトラッキングまたはトラッキング解除されます。つまり、ランタイムは、指定された XrEyesANDROID :: eyes で XR_SPACE_LOCATION_POSITION_TRACKED_BIT と XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT の両方を設定するか、XR_SPACE_LOCATION_POSITION_TRACKED_BIT と XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT の両方をクリアし、XrEyesANDROID :: mode を設定してトラッキング状態を示す必要があります 。

有効な使用方法（暗黙的）

xrGetCoarseTrackingEyesInfoANDROID を呼び出す前に、XR_ANDROID_eye_tracking 拡張機能を有効にする必要があります 。
eyeTracker は有効な XrEyeTrackerANDROID ハンドルである必要があります
getInfo は、有効な XrEyesGetInfoANDROID 構造体へのポインタである**必要があります**
eyesOutput は、XrEyesANDROID 構造体へのポインタである**必要があります**

戻りコード

成功

XR_SUCCESS
XR_SESSION_LOSS_PENDING

失敗

XR_ERROR_FUNCTION_UNSUPPORTED
XR_ERROR_HANDLE_INVALID
XR_ERROR_INSTANCE_LOST
XR_ERROR_LIMIT_REACHED
XR_ERROR_OUT_OF_MEMORY
XR_ERROR_PERMISSION_INSUFFICIENT
XR_ERROR_RUNTIME_FAILURE
XR_ERROR_SESSION_LOST
XR_ERROR_TIME_INVALID
XR_ERROR_VALIDATION_FAILURE

xrGetFineTrackingEyesInfoANDROID 関数は次のように定義されます。

XrResult xrGetFineTrackingEyesInfoANDROID(
    XrEyeTrackerANDROID                         eyeTracker,
    const XrEyesGetInfoANDROID*                 getInfo,
    XrEyesANDROID*                              eyesOutput);

パラメータの説明

eyeTracker は、XrEyeTrackerANDROID で以前に作成された xrCreateEyeTrackerANDROID です。
getInfo は、必要な出力を指定するために使用される XrEyesGetInfoANDROID へのポインタです。
eyesOutput は、ポーズや状態などの返された目の情報を含む XrEyesANDROID へのポインタです。

xrGetFineTrackingEyesInfoANDROID 関数は、xrGetCoarseTrackingEyesInfoANDROID よりも高い精度で目の状態とポーズの情報を取得します。

アプリケーションに android.permission.EYE_TRACKING_FINE 権限がない場合、ランタイムは XR_ERROR_PERMISSION_INSUFFICIENT を返す必要があります 。

目の情報は、xrGetFineTrackingEyesInfoANDROID の呼び出し時のベース空間に対して、XrEyesGetInfoANDROID :: time 、XrEyesGetInfoANDROID :: baseSpace を使用して解決され、相対的に解決されます。ランタイムは、呼び出し時に XrEyesGetInfoANDROID :: baseSpace で定義された場所を解決する必要があります 。

有効な使用方法（暗黙的）

XR_ANDROID_eye_tracking 拡張機能を xrGetFineTrackingEyesInfoANDROID を呼び出す前に有効にする 必要があります 。
eyeTracker は有効な XrEyeTrackerANDROID ハンドルである必要があります
getInfo は、有効な XrEyesGetInfoANDROID 構造体へのポインタである**必要があります**
eyesOutput は、XrEyesANDROID 構造体へのポインタである**必要があります**

戻りコード

成功

XR_SUCCESS
XR_SESSION_LOSS_PENDING

失敗

XR_ERROR_FUNCTION_UNSUPPORTED
XR_ERROR_HANDLE_INVALID
XR_ERROR_INSTANCE_LOST
XR_ERROR_LIMIT_REACHED
XR_ERROR_OUT_OF_MEMORY
XR_ERROR_PERMISSION_INSUFFICIENT
XR_ERROR_RUNTIME_FAILURE
XR_ERROR_SESSION_LOST
XR_ERROR_TIME_INVALID
XR_ERROR_VALIDATION_FAILURE

XrEyesGetInfoANDROID 構造体には、目のポーズと状態を取得するために必要な情報が含まれています。

typedef struct XrEyesGetInfoANDROID {
    XrStructureType    type;
    const void*        next;
    XrTime             time;
    XrSpace            baseSpace;
} XrEyesGetInfoANDROID;

メンバーの説明

type は、この構造体の XrStructureType です。
next は、NULL または構造体チェーン内の次の構造体へのポインタです。このような構造体は、コア OpenXR またはこの拡張機能では定義されていません。
time は、baseSpace を基準とした座標を評価する XrTime です。
baseSpace は、目のポーズが time で相対的に配置される XrSpace です。

有効な使用方法（暗黙的）

XR_ANDROID_eye_tracking 拡張機能を XrEyesGetInfoANDROID を使用する前に有効にする必要があります
type は XR_TYPE_EYES_GET_INFO_ANDROIDである**必要があります**
next は、NULL または構造体チェーン内の次の構造体への有効なポインタである**必要があります**。
baseSpace は有効な XrSpace ハンドルである必要があります

XrEyesANDROID 構造体には、トラッキングされた目に関する情報が含まれています。

typedef struct XrEyesANDROID {
    XrStructureType             type;
    void*                       next;
    XrEyeANDROID                eyes[XR_EYE_MAX_ANDROID];
    XrEyeTrackingModeANDROID    mode;
} XrEyesANDROID;

メンバーの説明

type は、この構造体の XrStructureType です。
next は、NULL または構造体チェーン内の次の構造体へのポインタです。このような構造体は、コア OpenXR またはこの拡張機能では定義されていません。
eyes は、XrEyeIndexANDROID でインデックス付けされた左右の目の XR_EYE_MAX_ANDROID サイズの XrEyeANDROID の配列です。
mode は、現在トラッキングしている目を示す XrEyeTrackingModeANDROID です。

有効な使用方法（暗黙的）

XrEyesANDROID を使用する前に、XR_ANDROID_eye_tracking 拡張機能を有効にする必要があります
type は XR_TYPE_EYES_ANDROIDである**必要があります**
next は、NULL または構造体チェーン内の次の構造体への有効なポインタである**必要があります**。
eyes の任意の要素は、有効な XrEyeANDROID 構造体である必要があります。
mode は有効な XrEyeTrackingModeANDROID 値である必要があります

XrEyeANDROID 構造体は、目の状態、位置、向きを表します。

typedef struct XrEyeANDROID {
    XrEyeStateANDROID    eyeState;
    XrPosef              eyePose;
} XrEyeANDROID;

メンバーの説明

eyeState は、目の XrEyeStateANDROID です。
eyePose は、対応する XrEyesGetInfoANDROID :: baseSpace の参照フレーム内の目の瞳孔の位置と向きを定義する XrPosef です。ここで、同一の向きは、ユーザーの目に +Z、右に +X、上に +Y の座標軸を表します。

有効な使用方法（暗黙的）

XrEyeANDROID を使用する前に、XR_ANDROID_eye_tracking 拡張機能を有効にする必要があります
eyeState は有効な XrEyeStateANDROID 値である必要があります

XrEyeStateANDROID 列挙型は、トラッキングされた目のさまざまな状態を識別します。

typedef enum XrEyeStateANDROID {
    XR_EYE_STATE_INVALID_ANDROID = 0,
    XR_EYE_STATE_GAZING_ANDROID = 1,
    XR_EYE_STATE_SHUT_ANDROID = 2,
    XR_EYE_STATE_MAX_ENUM_ANDROID = 0x7FFFFFFF
} XrEyeStateANDROID;

列挙型には次の意味があります。

列挙型の説明

XR_EYE_STATE_INVALID_ANDROID

目がエラー状態にあるか、存在しないことを示します。

XR_EYE_STATE_GAZING_ANDROID

目が現在凝視していることを示します。

XR_EYE_STATE_SHUT_ANDROID

まばたきや瞬きで目が閉じていることを示します。

XrEyeIndexANDROID 列挙型は、左目または右目のインデックスを識別します。

typedef enum XrEyeIndexANDROID {
    XR_EYE_INDEX_LEFT_ANDROID = 0,
    XR_EYE_INDEX_RIGHT_ANDROID = 1,
    XR_EYE_INDEX_MAX_ENUM_ANDROID = 0x7FFFFFFF
} XrEyeIndexANDROID;

列挙型には次の意味があります。

列挙型の説明

XR_EYE_INDEX_LEFT_ANDROID

左目。

XR_EYE_INDEX_RIGHT_ANDROID

右目。

XrEyeTrackingModeANDROID 列挙型は、トラッキングされた目のさまざまな状態を識別します。

typedef enum XrEyeTrackingModeANDROID {
    XR_EYE_TRACKING_MODE_NOT_TRACKING_ANDROID = 0,
    XR_EYE_TRACKING_MODE_RIGHT_ANDROID = 1,
    XR_EYE_TRACKING_MODE_LEFT_ANDROID = 2,
    XR_EYE_TRACKING_MODE_BOTH_ANDROID = 3,
    XR_EYE_TRACKING_MODE_MAX_ENUM_ANDROID = 0x7FFFFFFF
} XrEyeTrackingModeANDROID;

列挙型には次の意味があります。

列挙型の説明

XR_EYE_TRACKING_MODE_NOT_TRACKING_ANDROID

アイトラッキングが現在アクティブでないことを示します。

XR_EYE_TRACKING_MODE_RIGHT_ANDROID

右目のみがトラッキングしていることを示します。

XR_EYE_TRACKING_MODE_LEFT_ANDROID

左目のみがトラッキングしていることを示します。

XR_EYE_TRACKING_MODE_BOTH_ANDROID

左右両方の目がトラッキングしていることを示します。

アイトラッキングのサンプルコード

次のサンプルコードは、ビュー空間を基準とした目の情報を取得する方法を示しています。

XrSession session; // previously initialized, e.g. created at app startup.
XrSpace viewSpace; // space created for XR_REFERENCE_SPACE_TYPE_VIEW.

// The function pointers are previously initialized using xrGetInstanceProcAddr.
PFN_xrCreateEyeTrackerANDROID xrCreateEyeTrackerANDROID; // previously initialized
PFN_xrDestroyEyeTrackerANDROID xrDestroyEyeTrackerANDROID; // previously initialized
PFN_xrGetCoarseTrackingEyesInfoANDROID xrGetCoarseTrackingEyesInfoANDROID; // previously initialized
PFN_xrGetFineTrackingEyesInfoANDROID xrGetFineTrackingEyesInfoANDROID; // previously initialized

// This will use the XrSession that is bound to the eye tracker done at time of creation.
XrEyeTrackerANDROID eyeTracker;
XrEyeTrackerCreateInfoANDROID createInfo{
    .type = XR_TYPE_EYE_TRACKER_CREATE_INFO_ANDROID,
    .next = nullptr};
CHK_XR(xrCreateEyeTrackerANDROID(session, &createInfo, &eyeTracker));

while (1) {
    // ...
    // For every frame in frame loop
    // ...

    XrFrameState frameState;  // previously returned from xrWaitFrame
    const XrTime time = frameState.predictedDisplayTime;
    XrEyesANDROID fineEyesInfo{.type = XR_TYPE_EYES_ANDROID,
                               .next = nullptr,
                               .mode = XR_EYE_TRACKING_MODE_BOTH_ANDROID};
    XrEyesANDROID coarseEyesInfo{.type = XR_TYPE_EYES_ANDROID,
                                 .next = nullptr,
                                 .mode = XR_EYE_TRACKING_MODE_BOTH_ANDROID};
    XrEyesGetInfoANDROID eyesGetInfo{.type = XR_TYPE_EYES_GET_INFO_ANDROID,
                                     .next = nullptr,
                                     .time = time,
                                     .baseSpace = viewSpace};
    CHK_XR(xrGetCoarseTrackingEyesInfoANDROID(eyeTracker, &eyesGetInfo, &coarseEyesInfo));
    CHK_XR(xrGetFineTrackingEyesInfoANDROID(eyeTracker, &eyesGetInfo, &fineEyesInfo));

    // eyes tracking information is now available:
    // drawLeftEye(eyesInfo.eyes[XR_EYE_INDEX_LEFT_ANDROID].eyePose);
    // drawRightEye(eyesInfo.eyes[XR_EYE_INDEX_RIGHT_ANDROID].eyePose);

    // ...
    // Finish frame loop
    // ...
}

// after usage
CHK_XR(xrDestroyEyeTrackerANDROID(eyeTracker));

新しいオブジェクトの種類

XrEyeTrackerANDROID

新しい構造体

XrEyeANDROID
XrEyeTrackerCreateInfoANDROID
XrEyesANDROID
XrEyesGetInfoANDROID
XrSystemProperties の拡張 :
- XrSystemEyeTrackingPropertiesANDROID

新しい列挙型

XrEyeIndexANDROID
XrEyeStateANDROID
XrEyeTrackingModeANDROID

新しい列挙型定数

XR_ANDROID_EYE_TRACKING_EXTENSION_NAME
XR_ANDROID_eye_tracking_SPEC_VERSION
XR_EYE_MAX_ANDROID
XrObjectType の拡張 :
- XR_OBJECT_TYPE_EYE_TRACKER_ANDROID
XrStructureType の拡張 :
- XR_TYPE_EYES_ANDROID
- XR_TYPE_EYES_GET_INFO_ANDROID
- XR_TYPE_EYE_TRACKER_CREATE_INFO_ANDROID
- XR_TYPE_SYSTEM_EYE_TRACKING_PROPERTIES_ANDROID

問題

変更履歴

リビジョン 1、2025-01-17（Kenny Vercaemer）
- 拡張機能の最初の説明

XR_ANDROID_eye_tracking

概要

権限

システム機能の検査

メンバーの説明

有効な使用方法（暗黙的）

アイトラッカー ハンドルの作成

パラメータの説明

有効な使用方法（暗黙的）

戻りコード

メンバーの説明

有効な使用方法（暗黙的）

パラメータの説明

有効な使用方法（暗黙的）

スレッドセーフ

戻りコード

目の情報の取得

パラメータの説明

有効な使用方法（暗黙的）

戻りコード

パラメータの説明

有効な使用方法（暗黙的）

戻りコード

メンバーの説明

有効な使用方法（暗黙的）

メンバーの説明

有効な使用方法（暗黙的）

メンバーの説明

有効な使用方法（暗黙的）

アイ トラッキングのサンプルコード

新しいオブジェクトの種類

新しいコマンド

新しい構造体

新しい列挙型

新しい列挙型定数

問題

変更履歴

アイトラッカーハンドルの作成

アイトラッキングのサンプルコード