subscribeProfileStatisticsEvents#

Fully qualified name: isaacsim::physics::manager::subscribeProfileStatisticsEvents

registration::SubscriptionId isaacsim::physics::manager::subscribeProfileStatisticsEvents(
registration::ProfileStatisticsNotificationFunction onEvent,
)#

Subscribes to physics simulation profiling events.

The callback receives profiling statistics from each backend that supports profiling.

Note

Do not modify profiling subscriptions from within onEvent.

Note

Exceptions raised by a backend subscription callback propagate to the caller. If an exception occurs after another backend accepted the subscription, that earlier backend subscription may remain active without an aggregate subscription identifier being returned.

Parameters:

onEvent – [in] Callback invoked when profiling statistics are available.

Returns:

A subscription identifier for use with unsubscribeProfileStatisticsEvents(), or registration::g_kInvalidSubscriptionId if no backend accepted the subscription.