C Specification

The XrSpacesLocateInfo structure is defined as:

// Provided by XR_VERSION_1_1
typedef struct XrSpacesLocateInfo {
    XrStructureType    type;
    const void*        next;
    XrSpace            baseSpace;
    XrTime             time;
    uint32_t           spaceCount;
    const XrSpace*     spaces;
} XrSpacesLocateInfo;

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 or this extension.

  • baseSpace identifies the underlying space in which to locate spaces.

  • time is the time for which the location is requested.

  • spaceCount is a uint32_t specifying the count of elements in the spaces array.

  • spaces is an array of valid XrSpace handles to be located.

Description

The time, the baseSpace, and each space in spaces all follow the same specifics as the corresponding inputs to the xrLocateSpace function.

The baseSpace and all of the XrSpace handles in the spaces array must be valid and share the same parent XrSession.

If the time is invalid, the xrLocateSpaces must return XR_ERROR_TIME_INVALID.

The spaceCount must be a positive number, i.e. the array spaces must not be empty. Otherwise, the runtime must return XR_ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

  • type must be XR_TYPE_SPACES_LOCATE_INFO

  • next must be NULL or a valid pointer to the next structure in a structure chain

  • baseSpace must be a valid XrSpace handle

  • spaces must be a pointer to an array of spaceCount valid XrSpace handles

  • The spaceCount parameter must be greater than 0

  • Both of baseSpace and the elements of spaces must have been created, allocated, or retrieved from the same XrSession

See Also

XR_VERSION_1_1, XrSpace, XrStructureType, XrTime, xrLocateSpaces, xrLocateSpacesKHR

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.