Options & API

Component Props


interface PerfProps {
  logsPerSecond?: number;
  overClock?: boolean;
  matrixUpdate?: boolean;
  deepAnalyze?: boolean;
  showGraph?: boolean;
  graphType?: "line" | "bar";
  minimal?: boolean;
  antialias?: boolean;
  position?: "top-right" | "top-left" | "bottom-right" | "bottom-left";
  displayType?: "tab" | "classic";
  chart?: {
    hz?: number;
    length?: number;
  };
}

logsPerSecond

Control how often the monitor refreshes metrics.


<PerfMonitor logsPerSecond={20} />

overClock

Disable monitor refresh limit to benchmark raw FPS.


<PerfMonitor overClock />

deepAnalyze

Enable detailed WebGL program inspection.


<PerfMonitor deepAnalyze />

matrixUpdate

Count matrixWorld updates per frame


<PerfMonitor matrixUpdate />

minimal

Compact condensed view.


<PerfMonitor minimal />

showGraph

Toggle performance graphs - default: true


<PerfMonitor showGraph={true} />

graphType

Graph style (default: “bar”)


<PerfMonitor graphType="bar" />

chart

Configure graph behaviour.


<PerfMonitor
  chart={{
    hz: 60,
    length: 200,
  }}
/>