C Specification

The XrSpaceQueryInfoFB structure is defined as:

// Provided by XR_FB_spatial_entity_query
typedef struct XrSpaceQueryInfoFB {
    XrStructureType                         type;
    const void*                             next;
    XrSpaceQueryActionFB                    queryAction;
    uint32_t                                maxResultCount;
    XrDuration                              timeout;
    const XrSpaceFilterInfoBaseHeaderFB*    filter;
    const XrSpaceFilterInfoBaseHeaderFB*    excludeFilter;
} XrSpaceQueryInfoFB;

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.

  • queryAction is the type of query to perform.

  • maxResultCount is the maximum number of entities to be found.

  • timeout is the number of nanoseconds before the operation should time out. A value of XR_INFINITE_DURATION indicates no timeout.

  • filter is NULL or a pointer to a valid structure based on XrSpaceFilterInfoBaseHeaderFB.

  • excludeFilter is NULL or a pointer to a valid structure based on XrSpaceFilterInfoBaseHeaderFB.

Description

May be used to query for spaces and perform a specific action on the spaces returned. The available actions are enumerated in XrSpaceQueryActionFB. The filter info provided to the filter member of the struct is used as an inclusive filter. The filter info provided to the excludeFilter member of the structure is used to exclude spaces from the results returned from the filter. All spaces that match the criteria in filter, and that do not match the criteria in excludeFilter, must be included in the results returned. This is to allow for a more selective style query.

Valid Usage (Implicit)

See Also

XR_FB_spatial_entity_query, XrDuration, XrSpaceFilterInfoBaseHeaderFB, XrSpaceQueryActionFB, XrSpaceQueryInfoBaseHeaderFB, XrStructureType

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-2024, The Khronos Group Inc.

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