Function usePerformanceMonitor

usePerformanceMonitor(
options?: UsePerformanceMonitorOptions,
): PerformanceMonitorState

Hook for monitoring Three.js performance in real-time

Parameters

options: UsePerformanceMonitorOptions = {}
Configuration options

Returns PerformanceMonitorState

Current performance state

Example

function CombatScene() {
  const { metrics, isGood, warnings } = usePerformanceMonitor({
    enabled: import.meta.env.DEV,
    thresholds: { minAcceptableFps: 55 }
  });

  return (
    <>
      {import.meta.env.DEV && (
        <Html position={[0, 5, 0]}>
          <div>FPS: {metrics.fps.toFixed(1)}</div>
        </Html>
      )}
      {/＊ 3D content ＊/}
    </>
  );
}