XR_ANDROID_spatial_component_subsumed_by

Name String

XR_ANDROID_spatial_component_subsumed_by

擴充功能類型

執行個體擴充功能

擴充功能註冊編號

792

修訂版本

1

批准狀態

未批准

擴充功能和版本依附元件

XR_EXT_spatial_entity
和
XR_EXT_spatial_plane_tracking

上次修改日期

2025-08-19

IP 狀態

沒有已知的智慧財產權聲明。

著作人

Brian Chen, Google
Kyle Chen, Google
Levana Chen, Google
Nihav Jain, Google
Spencer Quin, Google

總覽

這項擴充功能以 XR_EXT_spatial_entity 為基礎,並為 XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT 提供新元件,以公開包含目前實體的 XrSpatialEntityIdEXT。

當執行階段取得足夠的環境資訊,偵測到 2 個追蹤平面實際上相同時,系統會將具有其中一個平面 ID 的 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件附加到另一個平面。之後,應用程式只需要處理不含 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件的實體。

這項擴充功能也推出新的篩選器,應用程式可以將其鏈結至 XrSpatialDiscoverySnapshotCreateInfoEXT,篩除任何具有 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件的實體。

權限

Android 應用程式必須在資訊清單中列出 android.permission.SCENE_UNDERSTANDING_COARSE 權限,因為這項擴充功能會追蹤環境中的平面。android.permission.SCENE_UNDERSTANDING_COARSE 權限視為危險權限。

(防護等級:危險)

執行階段支援

如果執行階段能夠將一個平面納入另一個平面,則必須在 xrEnumerateSpatialCapabilityComponentTypesEXT 中,將 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 列舉為 XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT 功能支援的元件,藉此表示這項功能。

XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 附加實體的所有元件資料,必須與包含該實體的實體相同。

由元件涵蓋

元件資料

XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 的資料使用 XrSpatialEntityIdEXT 結構,代表歸類實體的 ID。

用於查詢資料的元件清單結構

XrSpatialComponentSubsumedByListANDROID 結構定義如下:

typedef struct XrSpatialComponentSubsumedByListANDROID {
    XrStructureType          type;
    void*                    next;
    uint32_t                 subsumedUniqueIdCount;
    XrSpatialEntityIdEXT*    subsumedUniqueIds;
} XrSpatialComponentSubsumedByListANDROID;

成員說明

  • type 是這個結構的 XrStructureType。
  • next 是 NULL,或指向結構鏈中下一個結構的指標。
  • subsumedUniqueIdCount 是 uint32_t,用於描述 subsumedUniqueIds 陣列中的元素數量。
  • subsumedUniqueIds 是 XrSpatialEntityIdEXT 的陣列。

應用程式可以查詢 XrSpatialSnapshotEXT 中空間實體的 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件,方法是將 XR_TYPE_SPATIAL_COMPONENT_SUBSUMED_BY_LIST_ANDROID 新增至 XrSpatialComponentDataQueryResultEXT 的下一個鏈結。

如果 XR_TYPE_SPATIAL_COMPONENT_SUBSUMED_BY_LIST_ANDROID 位於 XrSpatialComponentDataQueryResultEXT :: next 的下一個鏈結中,但 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 未包含在 XrSpatialComponentDataQueryConditionEXT :: componentTypes 中,執行階段必須從 xrQuerySpatialComponentDataEXT 傳回 XR_ERROR_VALIDATION_FAILURE。

如果 subsumedUniqueIdCount 小於 XrSpatialComponentDataQueryResultEXT :: entityIdCountOutput,執行階段必須從 xrQuerySpatialComponentDataEXT 傳回 XR_ERROR_SIZE_INSUFFICIENT。

有效用途 (隱含)

  • 必須先啟用 XR_ANDROID_spatial_component_subsumed_by 擴充功能,才能使用 XrSpatialComponentSubsumedByListANDROID
  • type「必須」為 XR_TYPE_SPATIAL_COMPONENT_SUBSUMED_BY_LIST_ANDROID
  • next「必須」為 NULL,或指向結構鏈中下一個結構的有效指標
  • subsumedUniqueIds「必須」是指向 subsumedUniqueIdCount XrSpatialEntityIdEXT 值陣列的指標
  • subsumedUniqueIdCount 參數必須大於 0

設定

如果 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 列舉在 XrSpatialCapabilityComponentTypesEXT :: componentTypes 中,用於 XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT 功能,則應用程式可以啟用該功能,方法是將列舉加入 XrSpatialCapabilityConfigurationBaseHeaderEXT :: enabledComponents 清單中,該清單位於支援此元件的功能的 XrSpatialCapabilityConfigurationBaseHeaderEXT 衍生結構中。

篩選歸類實體

XrSpatialDiscoveryUniqueEntitiesFilterANDROID 結構定義如下:

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

成員說明

  • type 是這個結構的 XrStructureType。
  • next 是 NULL,或指向結構鏈中下一個結構的指標。

應用程式可以在 XrSpatialDiscoverySnapshotCreateInfoEXT 的 next 鏈結中加入 XrSpatialDiscoveryUniqueEntitiesFilterANDROID,取得不屬於其他實體的實體快照。

如果應用程式將 XrSpatialDiscoveryUniqueEntitiesFilterANDROID 鏈結至 XrSpatialDiscoverySnapshotCreateInfoEXT,並在 XrSpatialDiscoverySnapshotCreateInfoEXT :: componentTypes 中加入 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件,執行階段必須傳回 XR_ERROR_VALIDATION_FAILURE。

如果應用程式將 XrSpatialDiscoveryUniqueEntitiesFilterANDROID 鏈結至 XrSpatialDiscoverySnapshotCreateInfoEXT,但未在 XrSpatialDiscoverySnapshotCreateInfoEXT :: componentTypes 中列出任何元件,則執行階段必須在快照中納入所有空間實體,這些實體必須具備 XrSpatialCapabilityConfigurationBaseHeaderEXT :: enabledComponents 中列舉的元件組合,用於為 spatialContext 設定的功能,但具有 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件的實體除外。

有效用途 (隱含)

範例程式碼

設定平面追蹤功能

以下程式碼範例示範如何建立具有 XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT 功能、支援 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 的空間情境。

// Check runtime supported capabilities
uint32_t capabilityCount = 0;
CHK_XR(xrEnumerateSpatialCapabilitiesEXT(instance, systemId, 0, &capabilityCount, nullptr));
std::vector<XrSpatialCapabilityEXT> capabilities(capabilityCount);
CHK_XR(xrEnumerateSpatialCapabilitiesEXT(instance, systemId, capabilityCount, &capabilityCount, capabilities.data()));

if (std::find(capabilities.begin(), capabilities.end(), XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT) == capabilities.end()) {
  return;
}

// Enumerate supported components for plane tracking capability
XrSpatialCapabilityComponentTypesEXT planeComponents{
  .type = XR_TYPE_SPATIAL_CAPABILITY_COMPONENT_TYPES_EXT,
};
CHK_XR(xrEnumerateSpatialCapabilityComponentTypesEXT(instance, systemId, XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT, &planeComponents));
std::vector<XrSpatialComponentTypeEXT> planeCapabilityComponents(planeComponents.componentTypeCountOutput);
planeComponents.componentTypeCapacityInput = planeCapabilityComponents.size();
planeComponents.componentTypes = planeCapabilityComponents.data();
CHK_XR(xrEnumerateSpatialCapabilityComponentTypesEXT(instance, systemId, XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT, &planeComponents));

const auto supportsComponent = [&planeCapabilityComponents](XrSpatialComponentTypeEXT component) {
  return std::find(planeCapabilityComponents.begin(), planeCapabilityComponents.end(), component) != planeCapabilityComponents.end();
};


std::vector<XrSpatialComponentTypeEXT> planeTrackingComponents {
  XR_SPATIAL_COMPONENT_TYPE_BOUNDED_2D_EXT,
  XR_SPATIAL_COMPONENT_TYPE_PLANE_ALIGNMENT_EXT,
};

if (supportsComponent(XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID)) {
  planeTrackingComponents.push_back(XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID);
}

// Create capability config for plane tracking
XrSpatialCapabilityConfigurationPlaneTrackingEXT planeTrackingConfig {
  .type = XR_TYPE_SPATIAL_CAPABILITY_CONFIGURATION_PLANE_TRACKING_EXT,
  .next = nullptr,
  .capability = XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT,
  .enabledComponentCount = (uint32_t)planeTrackingComponents.size(),
  .enabledComponents = planeTrackingComponents.data(),
};

// Create spatial context
std::vector<const XrSpatialCapabilityConfigurationBaseHeaderEXT*> capabilityConfigs;
capabilityConfigs.push_back(reinterpret_cast<const XrSpatialCapabilityConfigurationBaseHeaderEXT*>(&planeTrackingConfig));

XrSpatialContextCreateInfoEXT contextCreateInfo {
  .type = XR_TYPE_SPATIAL_CONTEXT_CREATE_INFO_EXT,
  .next = nullptr,
  .capabilityConfigCount = (uint32_t)capabilityConfigs.size(),
  .capabilityConfigs = capabilityConfigs.data(),
};

CHK_XR(xrCreateSpatialContextAsyncEXT(session, &contextCreateInfo, &future))

// Completes creating spatial context
XrCreateSpatialContextCompletionEXT contextCompletion{
XR_TYPE_CREATE_SPATIAL_CONTEXT_COMPLETION_EXT};

CHK_XR(xrCreateSpatialContextCompleteEXT(session, future, &contextCompletion))

查詢元件資料

以下程式碼範例示範如何從使用 XR_SPATIAL_CAPABILITY_PLANE_TRACKING_EXT 設定的內容中查詢 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件資料。

// previously created
XrSpatialSnapshotEXT snapshot;

// Query subsumed_by components
std::array<XrSpatialComponentTypeEXT, 1> enabledComponents = {
  XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID
};

XrSpatialComponentDataQueryConditionEXT queryCond {
  .type = XR_TYPE_SPATIAL_COMPONENT_DATA_QUERY_CONDITION_EXT,
  .componentTypeCount = 1,
  .componentTypes     = enabledComponents.data(),
};

XrSpatialComponentDataQueryResultEXT queryResult {
  .type = XR_TYPE_SPATIAL_COMPONENT_DATA_QUERY_RESULT_EXT,
};

CHK_XR(xrQuerySpatialComponentDataEXT(
           snapshot, &queryCond, &queryResult));

// Query again with allocated memory
std::vector<XrSpatialEntityIdEXT> subsumedUniqueIds;
subsumedUniqueIds.resize(queryResult.entityIdCountOutput);
XrSpatialComponentSubsumedByListANDROID subsumedByList {
  .type = XR_TYPE_SPATIAL_COMPONENT_SUBSUMED_BY_LIST_ANDROID,
  .subsumedUniqueIdCount = static_cast<uint32_t>(subsumedUniqueIds.size()),
  .subsumedUniqueIds = subsumedUniqueIds.data(),
};

queryResult.next = &subsumedByList;
CHK_XR(xrQuerySpatialComponentDataEXT(
           snapshot, &queryCond, &queryResult));

for (uint32_t i = 0; i < queryResult.entityIdCountOutput; ++i) {
  // Plane was subsumed, remove it from processing logic
  // removeEntityFromProcessingLogic(queryResult.entityIds[i], /*replaceWith=*/ subsumedByList.subsumedUniqueIds[i]);
}

// Cleanup
xrDestroySpatialSnapshotEXT(snapshot);

篩選掉歸入實體

以下程式碼範例示範如何使用篩選器,從探索快照中篩除附加 XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID 元件的實體,以及查詢包含實體的實體 ID。

// Init filter
XrSpatialDiscoveryUniqueEntitiesFilterANDROID filter {
  .type = XR_TYPE_SPATIAL_DISCOVERY_UNIQUE_ENTITIES_FILTER_ANDROID,
};

// Chain filter to the snapshot create info
// WARNING: Chaining the filter while include subsumed_by component in the
// componentTypes is invalid
XrSpatialDiscoverySnapshotCreateInfoEXT discoverySnapshotCreateInfo {
  .type = XR_TYPE_SPATIAL_DISCOVERY_SNAPSHOT_CREATE_INFO_EXT,
  .next = &filter
};

XrFutureEXT future {XR_NULL_FUTURE_EXT};
CHK_XR(xrCreateSpatialDiscoverySnapshotAsyncEXT(spatialContext, &discoverySnapshotCreateInfo, &future))

waitUntilReady(future);

// Complete async operation.
XrCreateSpatialDiscoverySnapshotCompletionInfoEXT
  createSnapshotCompletionInfo {
    .type   = XR_TYPE_CREATE_SPATIAL_DISCOVERY_SNAPSHOT_COMPLETION_INFO_EXT,
    .baseSpace = space,
    .time      = updateTime,
    .future    = future,
  };

XrCreateSpatialDiscoverySnapshotCompletionEXT completion {
  .type = XR_TYPE_CREATE_SPATIAL_DISCOVERY_SNAPSHOT_COMPLETION_EXT,
};

CHK_XR(xrCreateSpatialDiscoverySnapshotCompleteEXT(
           spatialContext, &createSnapshotCompletionInfo,
           &completion));

if(completion.futureResult != XR_SUCCESS) return;

// Subsumed entities has already been filtered out in this snapshot,
// now query the various components of the entities.

// Cleanup
xrDestroySpatialSnapshotEXT(completion.snapshot);

新結構

新列舉常數

  • XR_ANDROID_SPATIAL_COMPONENT_SUBSUMED_BY_EXTENSION_NAME
  • XR_ANDROID_spatial_component_subsumed_by_SPEC_VERSION
  • 擴充 XrSpatialComponentTypeEXT:

    • XR_SPATIAL_COMPONENT_TYPE_SUBSUMED_BY_ANDROID
  • 擴充 XrStructureType:

    • XR_TYPE_SPATIAL_COMPONENT_SUBSUMED_BY_LIST_ANDROID
    • XR_TYPE_SPATIAL_DISCOVERY_UNIQUE_ENTITIES_FILTER_ANDROID

問題

版本記錄

  • 修訂版本 1,2025-11-19 (Brian Chen)

    • 初始擴充功能說明。