C Specification

The XrEventDataStartColocationAdvertisementCompleteMETA event structure is defined as:

// Provided by XR_META_colocation_discovery
typedef struct XrEventDataStartColocationAdvertisementCompleteMETA {
    XrStructureType       type;
    const void*           next;
    XrAsyncRequestIdFB    advertisementRequestId;
    XrResult              result;
    XrUuid                advertisementUuid;
} XrEventDataStartColocationAdvertisementCompleteMETA;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

  • advertisementRequestId is an XrAsyncRequestIdFB that identifies which request this event is in response to. The runtime must ensure this value matches a advertisementRequestId returned during an xrStartColocationAdvertisementMETA call.

  • result is an XrResult that specifies the request result. The valid result values are: XR_SUCCESS, XR_ERROR_RUNTIME_FAILURE, XR_COLOCATION_DISCOVERY_ALREADY_ADVERTISING_META, XR_ERROR_COLOCATION_DISCOVERY_NO_DISCOVERY_METHOD_META, and XR_ERROR_COLOCATION_DISCOVERY_NETWORK_FAILED_META. If the application already has an active colocation advertisement, the runtime must return XR_COLOCATION_DISCOVERY_ALREADY_ADVERTISING_META in this field.

  • advertisementUuid is an XrUuid which is discoverable by other physically colocated devices running the same application. The runtime must return a unique XrUuid which has not been returned in a previous XrEventDataStartColocationAdvertisementCompleteMETA event, if result is XR_SUCCESS.

Description

This event conveys the results of the asynchronous operation started by xrStopColocationAdvertisementMETA.

Valid Usage (Implicit)

See Also

XR_META_colocation_discovery, XrAsyncRequestIdFB, XrColocationAdvertisementStartInfoMETA, XrResult, XrStructureType, XrUuid, xrStartColocationAdvertisementMETA

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.