XR_ANDROID_eye_tracking

Name String

XR_ANDROID_eye_tracking

Loại tiện ích

Tiện ích phiên bản

Số máy nhánh đã đăng ký

457

Bản sửa đổi

1

Trạng thái phê chuẩn

Chưa được phê chuẩn

Phần mở rộng và các phần phụ thuộc vào phiên bản

OpenXR 1.0

Ngày sửa đổi gần đây nhất

2025-01-17

Trạng thái IP

Không có thông báo xác nhận quyền sở hữu nào đã biết về quyền sở hữu trí tuệ.

Cộng tác viên

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

Tổng quan

Tiện ích này cho phép các ứng dụng lấy vị trí và hướng của mắt người dùng, cũng như trạng thái theo dõi ánh mắt.

Dữ liệu theo dõi ánh mắt được cung cấp ở hai chế độ: thô và chi tiết. Tính năng theo dõi thô cung cấp thông tin ước tính thô về mắt của người dùng, trong khi tính năng theo dõi chi tiết cung cấp thông tin ước tính chính xác hơn. Tính năng theo dõi thô dành cho những ứng dụng muốn cung cấp một hình ảnh đại diện cơ bản, trong khi tính năng theo dõi chi tiết dành cho những ứng dụng chính xác hơn.

Để tương tác, bạn nên sử dụng XR_EXT_eye_gaze_interaction.

Quyền

Các ứng dụng Android phải có quyền android.permission.EYE_TRACKING_COARSE hoặc android.permission.EYE_TRACKING_FINE trong tệp kê khai. Những quyền này được coi là quyền có mức độ bảo vệ nguy hiểm. Ứng dụng phải yêu cầu cấp quyền trong thời gian chạy để sử dụng các chức năng này:

(cấp độ bảo vệ: nguy hiểm)

Kiểm tra khả năng của hệ thống

Cấu trúc XrSystemEyeTrackingPropertiesANDROID được xác định như sau:

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

Nội dung mô tả thành viên

  • type là XrStructureType của cấu trúc này.
  • next là NULL hoặc con trỏ đến cấu trúc tiếp theo trong chuỗi cấu trúc. Không có cấu trúc nào như vậy được xác định trong OpenXR cốt lõi hoặc tiện ích này.
  • supportsEyeTracking là một XrBool32 cho biết liệu hệ thống hiện tại có hỗ trợ tính năng theo dõi ánh mắt hay không.

Một ứng dụng có thể kiểm tra xem hệ thống có khả năng theo dõi ánh mắt hay không bằng cách mở rộng XrSystemProperties bằng cấu trúc XrSystemEyeTrackingPropertiesANDROID khi gọi xrGetSystemProperties .

Nếu và chỉ khi một thời gian chạy trả về XR_FALSE cho supportsEyeTracking , thì thời gian chạy phải trả về XR_ERROR_FEATURE_UNSUPPORTED từ xrCreateEyeTrackerANDROID .

Cách sử dụng hợp lệ (ngầm)

Tạo một tay cầm theo dõi mắt

XR_DEFINE_HANDLE(XrEyeTrackerANDROID)

Xử lý XrEyeTrackerANDROID đại diện cho một thiết bị theo dõi mắt để theo dõi mắt và lập bản đồ chính xác vị trí mà người dùng đang nhìn.

Dữ liệu theo dõi ánh mắt là thông tin cá nhân nhạy cảm và có liên quan chặt chẽ đến quyền riêng tư và tính toàn vẹn của cá nhân. Các ứng dụng lưu trữ hoặc chuyển dữ liệu theo dõi ánh mắt luôn phải yêu cầu người dùng chấp nhận một cách chủ động và cụ thể để làm như vậy.

Ứng dụng sử dụng mã nhận dạng này để truy cập vào dữ liệu theo dõi ánh mắt bằng các hàm khác trong tiện ích này.

Tính năng theo dõi ánh mắt cung cấp thông tin về tư thế và trạng thái của mắt trong cảnh.

Hàm xrCreateEyeTrackerANDROID được xác định như sau:

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

Nội dung mô tả về tham số

Một ứng dụng tạo một đối tượng XrEyeTrackerANDROID bằng hàm xrCreateEyeTrackerANDROID.

Nếu hệ thống không hỗ trợ tính năng theo dõi ánh mắt, thì thời gian chạy phải trả về XR_ERROR_FEATURE_UNSUPPORTED từ xrCreateEyeTrackerANDROID .

Cách sử dụng hợp lệ (ngầm)

Mã trả về

Thành công

  • XR_SUCCESS
  • XR_SESSION_LOSS_PENDING

Thất bại

  • 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

Cấu trúc XrEyeTrackerCreateInfoANDROID được xác định như sau:

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

Nội dung mô tả thành viên

  • type là XrStructureType của cấu trúc này.
  • next là NULL hoặc con trỏ đến cấu trúc tiếp theo trong chuỗi cấu trúc. Không có cấu trúc nào như vậy được xác định trong OpenXR cốt lõi hoặc tiện ích này.

Cấu trúc XrEyeTrackerCreateInfoANDROID mô tả thông tin để tạo một đối tượng XrEyeTrackerANDROID.

Cách sử dụng hợp lệ (ngầm)

Hàm xrDestroyEyeTrackerANDROID được xác định như sau:

XrResult xrDestroyEyeTrackerANDROID(
    XrEyeTrackerANDROID                         eyeTracker);

Nội dung mô tả về tham số

Hàm xrDestroyEyeTrackerANDROID sẽ giải phóng eyeTracker và các tài nguyên cơ bản khi hoàn tất trải nghiệm theo dõi ánh mắt.

Cách sử dụng hợp lệ (ngầm)

Độ an toàn cho luồng

  • Quyền truy cập vào eyeTracker và mọi đối tượng con phải được đồng bộ hoá bên ngoài

Mã trả về

Thành công

  • XR_SUCCESS

Thất bại

  • XR_ERROR_FUNCTION_UNSUPPORTED
  • XR_ERROR_HANDLE_INVALID

Lấy thông tin về mắt

Hàm xrGetCoarseTrackingEyesInfoANDROID được xác định như sau:

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

Nội dung mô tả về tham số

  • eyeTracker là một XrEyeTrackerANDROID do xrCreateEyeTrackerANDROID tạo trước đó .
  • getInfo là một con trỏ đến XrEyesGetInfoANDROID dùng để cung cấp thông tin cho việc truy vấn tư thế và trạng thái của mắt.
  • eyesOutput là một con trỏ đến XrEyesANDROID chứa thông tin về mắt được trả về, bao gồm cả tư thế và trạng thái.

Hàm xrGetCoarseTrackingEyesInfoANDROID lấy thông tin về trạng thái và tư thế của mắt theo cách bảo vệ quyền riêng tư của người dùng.

Thời gian chạy phải trả về XR_ERROR_PERMISSION_INSUFFICIENT nếu ứng dụng không có quyền android.permission.EYE_TRACKING_COARSE.

Tư thế mắt được thể hiện trong XrEyesGetInfoANDROID :: baseSpace tại XrEyesGetInfoANDROID :: time .

Tại bất kỳ thời điểm nào, cả vị trí và hướng của tư thế mắt đều được theo dõi hoặc không được theo dõi. Điều này có nghĩa là thời gian chạy phải đặt cả XR_SPACE_LOCATION_POSITION_TRACKED_BIT và XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT hoặc xoá cả XR_SPACE_LOCATION_POSITION_TRACKED_BIT và XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT trên XrEyesANDROID :: eyes được cung cấp , đồng thời đặt XrEyesANDROID :: mode để cho biết trạng thái theo dõi.

Cách sử dụng hợp lệ (ngầm)

Mã trả về

Thành công

  • XR_SUCCESS
  • XR_SESSION_LOSS_PENDING

Thất bại

  • 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

Hàm xrGetFineTrackingEyesInfoANDROID được xác định như sau:

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

Nội dung mô tả về tham số

Hàm xrGetFineTrackingEyesInfoANDROID lấy thông tin về trạng thái và tư thế của mắt với độ chính xác cao hơn xrGetCoarseTrackingEyesInfoANDROID .

Thời gian chạy phải trả về XR_ERROR_PERMISSION_INSUFFICIENT nếu ứng dụng không có quyền android.permission.EYE_TRACKING_FINE.

Thông tin về mắt được phân giải và tương ứng với không gian cơ sở tại thời điểm gọi đến xrGetFineTrackingEyesInfoANDROID bằng XrEyesGetInfoANDROID :: time , XrEyesGetInfoANDROID :: baseSpace . Thời gian chạy phải phân giải vị trí do XrEyesGetInfoANDROID :: baseSpace xác định tại thời điểm gọi.

Tại bất kỳ thời điểm nào, cả vị trí và hướng của tư thế mắt đều được theo dõi hoặc không được theo dõi. Điều này có nghĩa là thời gian chạy phải đặt cả XR_SPACE_LOCATION_POSITION_TRACKED_BIT và XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT hoặc xoá cả XR_SPACE_LOCATION_POSITION_TRACKED_BIT và XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT trên XrEyesANDROID :: eyes được cung cấp , đồng thời đặt XrEyesANDROID :: mode để cho biết trạng thái theo dõi.

Cách sử dụng hợp lệ (ngầm)

Mã trả về

Thành công

  • XR_SUCCESS
  • XR_SESSION_LOSS_PENDING

Thất bại

  • 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

Cấu trúc XrEyesGetInfoANDROID chứa thông tin cần thiết để truy xuất tư thế và trạng thái của mắt.

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

Nội dung mô tả thành viên

  • type là XrStructureType của cấu trúc này.
  • next là NULL hoặc con trỏ đến cấu trúc tiếp theo trong chuỗi cấu trúc. Không có cấu trúc nào như vậy được xác định trong OpenXR cốt lõi hoặc tiện ích này.
  • time là XrTime mà tại đó đánh giá toạ độ so với baseSpace .
  • baseSpace là XrSpace mà tư thế mắt sẽ tương ứng tại time .

Cách sử dụng hợp lệ (ngầm)

Cấu trúc XrEyesANDROID chứa thông tin về mắt được theo dõi.

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

Nội dung mô tả thành viên

  • type là XrStructureType của cấu trúc này.
  • next là NULL hoặc con trỏ đến cấu trúc tiếp theo trong chuỗi cấu trúc. Không có cấu trúc nào như vậy được xác định trong OpenXR cốt lõi hoặc tiện ích này.
  • eyes là một mảng XrEyeANDROID , có kích thước XR_EYE_MAX_ANDROID , cho mắt trái và mắt phải theo chỉ mục của XrEyeIndexANDROID .
  • mode là XrEyeTrackingModeANDROID cho biết mắt nào hiện đang được theo dõi.

Cách sử dụng hợp lệ (ngầm)

Cấu trúc XrEyeANDROID mô tả trạng thái, vị trí và hướng của mắt.

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

Nội dung mô tả thành viên

  • eyeState là XrEyeStateANDROID của mắt.
  • eyePose là một XrPosef xác định vị trí và hướng của đồng tử trong khung tham chiếu của XrEyesGetInfoANDROID tương ứng :: baseSpace . Hướng nhận dạng ở đây biểu thị một trục toạ độ với +Z vào mắt người dùng, +X sang phải và +Y lên trên.

Cách sử dụng hợp lệ (ngầm)

  • Bạn phải bật tiện ích XR_ANDROID_eye_tracking trước khi sử dụng XrEyeANDROID
  • eyeState phải là một giá trị XrEyeStateANDROID hợp lệ

Liệt kê XrEyeStateANDROID để xác định các trạng thái khác nhau của mắt được theo dõi.

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;

Các enum có ý nghĩa như sau:

Nội dung mô tả enum

XR_EYE_STATE_INVALID_ANDROID

Cho biết mắt đang ở trạng thái lỗi hoặc không xuất hiện.

XR_EYE_STATE_GAZING_ANDROID

Cho biết mắt hiện đang nhìn.

XR_EYE_STATE_SHUT_ANDROID

Cho biết mắt hiện đang nhắm do nháy mắt hoặc chớp mắt.

Liệt kê XrEyeIndexANDROID để xác định chỉ mục của mắt trái hoặc mắt phải.

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

Các enum có ý nghĩa như sau:

Nội dung mô tả enum

XR_EYE_INDEX_LEFT_ANDROID

Mắt trái.

XR_EYE_INDEX_RIGHT_ANDROID

Mắt phải.

Liệt kê XrEyeTrackingModeANDROID để xác định các trạng thái khác nhau của mắt được theo dõi.

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;

Các enum có ý nghĩa như sau:

Nội dung mô tả enum

XR_EYE_TRACKING_MODE_NOT_TRACKING_ANDROID

Cho biết tính năng theo dõi ánh mắt hiện không hoạt động.

XR_EYE_TRACKING_MODE_RIGHT_ANDROID

Cho biết chỉ mắt phải đang theo dõi.

XR_EYE_TRACKING_MODE_LEFT_ANDROID

Cho biết chỉ mắt trái đang được theo dõi.

XR_EYE_TRACKING_MODE_BOTH_ANDROID

Cho biết cả mắt trái và mắt phải đều đang được theo dõi.

Mã ví dụ để theo dõi ánh mắt

Đoạn mã ví dụ sau đây minh hoạ cách lấy thông tin về mắt so với không gian hiển thị.

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));

Các loại đối tượng mới

Lệnh mới

Cấu trúc mới

Enum mới

Hằng số Enum mới

  • XR_ANDROID_EYE_TRACKING_EXTENSION_NAME
  • XR_ANDROID_eye_tracking_SPEC_VERSION
  • XR_EYE_MAX_ANDROID

  • Mở rộng XrObjectType :

    • XR_OBJECT_TYPE_EYE_TRACKER_ANDROID

  • Mở rộng 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

Vấn đề

Nhật ký phiên bản

  • Bản sửa đổi 1, ngày 17/1/2025 (Kenny Vercaemer)

    • Nội dung mô tả ban đầu của tiện ích