XrSpaceLocationsKHR(3)

C Specification

The XrSpaceLocationsKHR structure is defined as:

// Provided by XR_KHR_locate_spaces
// XrSpaceLocationsKHR is an alias for XrSpaceLocations
typedef struct XrSpaceLocations {
    XrStructureType         type;
    void*                   next;
    uint32_t                locationCount;
    XrSpaceLocationData*    locations;
} XrSpaceLocations;

typedef XrSpaceLocations XrSpaceLocationsKHR;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain, such as XrSpaceVelocitiesKHR.
locationCount is a uint32_t specifying the count of elements in the locations array.
locations is an array of XrSpaceLocationsKHR for the runtime to populate with the locations of the specified spaces in the XrSpacesLocateInfoKHR::baseSpace at the specified XrSpacesLocateInfoKHR::time.

Description

The XrSpaceLocationsKHR structure contains an array of space locations in the member locations, to be used as output for xrLocateSpacesKHR. The application must allocate this array to be populated with the function output. The locationCount value must be the same as XrSpacesLocateInfoKHR::spaceCount, otherwise, the xrLocateSpacesKHR function must return XR_ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

The XR_KHR_locate_spaces extension must be enabled prior to using XrSpaceLocationsKHR
Note: XrSpaceLocationsKHR is an alias for XrSpaceLocations, so the following items replicate the implicit valid usage for XrSpaceLocations
type must be XR_TYPE_SPACE_LOCATIONS
next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrSpaceVelocities
locations must be a pointer to an array of locationCount XrSpaceLocationData structures
The locationCount parameter must be greater than 0

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

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

XrSpaceLocationsKHR(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright