C Specification

The XrEventDataColocationAdvertisementCompleteMETA structure is defined as:

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

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 specifying the original start advertisement async request id. The runtime must return a value which matches a previously returned advertisementRequestId value from an xrStartColocationAdvertisementMETA request.

  • result is an XrResult representing the advertisement process result. The valid result values are: XR_SUCCESS, XR_ERROR_RUNTIME_FAILURE, and XR_ERROR_COLOCATION_DISCOVERY_NO_DISCOVERY_METHOD_META.

Description

The runtime must queue exactly one XrEventDataColocationAdvertisementCompleteMETA event whenever an active colocation advertisement is stopped. This includes if the colocation advertisement is stopped due to an application calling xrStopColocationAdvertisementMETA, or the runtime needs to stop the colocation advertisement for any reason. If the colocation advertisement is stopped due to an application calling xrStopColocationAdvertisementMETA, the runtime must queue the XrEventDataColocationAdvertisementCompleteMETA event before queuing the corresponding XrEventDataStopColocationAdvertisementCompleteMETA event. When the XrSession is destroyed, the runtime must stop all active advertisements started from the same XrSession.

Valid Usage (Implicit)

See Also

XR_META_colocation_discovery, XrAsyncRequestIdFB, XrResult, XrStructureType, xrStartColocationAdvertisementMETA, xrStopColocationAdvertisementMETA

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.