xrGetRenderModelStateEXT(3)

C Specification

The xrGetRenderModelStateEXT function reads the current state of the animatable nodes in the render model.

// Provided by XR_EXT_render_model
XrResult xrGetRenderModelStateEXT(
    XrRenderModelEXT                            renderModel,
    const XrRenderModelStateGetInfoEXT*         getInfo,
    XrRenderModelStateEXT*                      state);

Parameters

Parameter Descriptions

renderModel is an XrRenderModelEXT previously created by xrCreateRenderModelEXT.
getInfo is a pointer to a valid XrRenderModelStateGetInfoEXT specifying parameters affecting the state to retrieve.
state is a pointer to an XrRenderModelStateEXT structure.

Description

The order of the elements in XrRenderModelStateEXT::nodeStates in state is the same as the order of node names returned by the xrGetRenderModelAssetPropertiesEXT function. The corresponding index in XrRenderModelStateEXT::nodeStates is the same as the index in XrRenderModelAssetPropertiesEXT::nodeProperties. The number of states is XrRenderModelPropertiesEXT::animatableNodeCount.

The runtime must return XR_ERROR_VALIDATION_FAILURE if XrRenderModelStateEXT::nodeStateCount is not equal to XrRenderModelPropertiesEXT::animatableNodeCount.

Valid Usage (Implicit)

The XR_EXT_render_model extension must be enabled prior to calling xrGetRenderModelStateEXT
renderModel must be a valid XrRenderModelEXT handle
getInfo must be a pointer to a valid XrRenderModelStateGetInfoEXT structure
state must be a pointer to an XrRenderModelStateEXT structure

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
XR_ERROR_TIME_INVALID

See Also

XR_EXT_render_model, XrRenderModelEXT, XrRenderModelStateEXT, XrRenderModelStateGetInfoEXT

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.