C Specification

The xrDestroyRenderModelEXT function is defined as:

// Provided by XR_EXT_render_model
XrResult xrDestroyRenderModelEXT(
    XrRenderModelEXT                            renderModel);

Parameters

Parameter Descriptions

Description

xrDestroyRenderModelEXT function releases the XrRenderModelEXT handle and the underlying resources when finished with the render model tracking and animation.

Although any associated XrSpace handles created by xrCreateRenderModelSpaceEXT are not destroyed upon calling xrDestroyRenderModelEXT because the space is a child of the session handle, any render model spaces created from a now-destroyed render model handle must no longer return any XrSpaceLocationFlagBits or XrSpaceVelocityFlagBits set in XrSpaceLocation::locationFlags or XrSpaceVelocity::velocityFlags, respectively. That is, a space created from a render model handle that is now destroyed becomes no longer locatable.

Valid Usage (Implicit)
Thread Safety

  • Access to renderModel, and any child handles, must be externally synchronized

Return Codes
On success, this command returns

  • XR_SUCCESS

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

See Also

XR_EXT_render_model, XrRenderModelEXT

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.