C Specification

The xrGetRenderModelAssetPropertiesEXT function is defined as:

// Provided by XR_EXT_render_model
XrResult xrGetRenderModelAssetPropertiesEXT(
    XrRenderModelAssetEXT                       asset,
    const XrRenderModelAssetPropertiesGetInfoEXT* getInfo,
    XrRenderModelAssetPropertiesEXT*            properties);

Parameters

Parameter Descriptions

Description

The application can use the xrGetRenderModelAssetPropertiesEXT function to get the array of animatable node names in the glTF asset.

The runtime must return node names in properties member XrRenderModelAssetPropertiesEXT::nodeProperties that are unique within the corresponding glTF asset.

The application must allocate an array of XrRenderModelAssetNodePropertiesEXT within properties, of size XrRenderModelAssetPropertiesEXT::nodePropertyCount, which must be equal to XrRenderModelPropertiesEXT::animatableNodeCount. If XrRenderModelAssetPropertiesEXT::nodePropertyCount is not equal to XrRenderModelPropertiesEXT::animatableNodeCount as populated by xrGetRenderModelPropertiesEXT, the runtime must return XR_ERROR_VALIDATION_FAILURE from xrGetRenderModelAssetPropertiesEXT. Because the number of animatable nodes is fixed per render model handle and retrievable with xrGetRenderModelPropertiesEXT, the two-call idiom for buffer sizing and allocation is not needed in this case.

The application may call xrDestroyRenderModelAssetEXT after successfully populating the buffer with this call, and similar successful use of xrGetRenderModelAssetDataEXT, as the only purpose of this handle is to manage the lifetime of the animatable node names (copied into application-allocated memory by this call) the loaded glTF asset (copied into application-allocated memory by xrGetRenderModelAssetDataEXT) within the runtime.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_VALIDATION_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_OUT_OF_MEMORY

See Also

XR_EXT_render_model, XrRenderModelAssetEXT, XrRenderModelAssetPropertiesEXT, XrRenderModelAssetPropertiesGetInfoEXT

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.