{"id":13774190,"url":"https://github.com/utsuboco/r3f-perf","last_synced_at":"2025-05-14T07:08:24.749Z","repository":{"id":40388267,"uuid":"326044399","full_name":"utsuboco/r3f-perf","owner":"utsuboco","description":"Easily monitor your ThreeJS performances.","archived":false,"fork":false,"pushed_at":"2024-12-20T13:58:53.000Z","size":4292,"stargazers_count":691,"open_issues_count":14,"forks_count":27,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-08T22:41:55.845Z","etag":null,"topics":["benchmark","monitor","performance","performance-analysis","performance-monitoring","profiling","r3f","react","threejs"],"latest_commit_sha":null,"homepage":"https://codesandbox.io/s/perlin-cubes-r3f-perf-wtp9t?file=/src/App.js","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/utsuboco.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-01T19:41:33.000Z","updated_at":"2025-05-07T13:48:51.000Z","dependencies_parsed_at":"2024-04-01T05:29:46.846Z","dependency_job_id":"4fdc9cc6-d69b-4e4f-b37b-f0c17248e266","html_url":"https://github.com/utsuboco/r3f-perf","commit_stats":{"total_commits":283,"total_committers":9,"mean_commits":"31.444444444444443","dds":0.07773851590106007,"last_synced_commit":"752adc19edbcabc43fc917519c5366718fa0b9d0"},"previous_names":["renaudrohlinger/r3f-perf"],"tags_count":61,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utsuboco%2Fr3f-perf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utsuboco%2Fr3f-perf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utsuboco%2Fr3f-perf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utsuboco%2Fr3f-perf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/utsuboco","download_url":"https://codeload.github.com/utsuboco/r3f-perf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253181442,"owners_count":21866994,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["benchmark","monitor","performance","performance-analysis","performance-monitoring","profiling","r3f","react","threejs"],"created_at":"2024-08-03T17:01:24.506Z","updated_at":"2025-05-14T07:08:24.727Z","avatar_url":"https://github.com/utsuboco.png","language":"TypeScript","readme":"![npm](https://img.shields.io/npm/v/r3f-perf) ![npm](https://img.shields.io/npm/dw/r3f-perf)\n\n# R3F-Perf\n\n**[Changelog](https://github.com/utsuboco/r3f-perf/blob/main/CHANGELOG.md)**\n\nEasily monitor the performances of your @react-three/fiber application.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eAdd the Perf component anywhere in your Canvas.\u003c/td\u003e\n    \u003ctd\u003e\n\u003ca href=\"https://wtp9t.csb.app/\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/15867665/215722804-3b4ee71c-d205-429b-8cae-f915bf60d56c.png\" /\u003e\u003c/td\u003e\n\u003c/a\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Installation\n\n```bash\nyarn add --dev r3f-perf\n```\n\n## Options\n\n```jsx\nlogsPerSecond?: 10, // Refresh rate of the logs\nantialias?: true, // Take a bit more performances but render the text with antialiasing\noverClock?: false, // Disable the limitation of the monitor refresh rate for the fps\ndeepAnalyze?: false, // More detailed informations about gl programs\nshowGraph?: true // show the graphs\nminimal?: false // condensed version with the most important informations (gpu/memory/fps/custom data)\ncustomData?: {\n  value: 0, // initial value,\n  name: '', // name to show\n  round: 2, // precision of the float\n  info: '', // additional information about the data (fps/ms for instance)\n}\nmatrixUpdate?: false // count the number of time matrixWorldUpdate is called per frame\nchart?: {\n  hz: 60, // graphs refresh frequency parameter\n  length: 120, // number of values shown on the monitor\n}\ncolorBlind?: false // Color blind colors for accessibility\nclassName?: '' // override CSS class\nstyle?: {} // override style\nposition?: 'top-right'|'top-left'|'bottom-right'|'bottom-left' // quickly set the position, default is top-right\n```\n\n## Usage\n\n```jsx\nimport { Canvas } from '@react-three/fiber'\nimport { Perf } from 'r3f-perf'\n\nfunction App() {\n  return (\n    \u003cCanvas\u003e\n      \u003cPerf /\u003e\n    \u003c/Canvas\u003e\n  )\n}\n```\n\n#### Usage without interface : PerfHeadless\n\n[Codesandbox Example](https://codesandbox.io/s/perlin-cubes-r3f-perf-headless-mh1jl7?file=/src/App.js)\n\n```jsx\nimport { Canvas } from '@react-three/fiber'\nimport { PerfHeadless, usePerf } from 'r3f-perf'\n\nconst PerfHook = () =\u003e {\n  // getPerf() is also available for non-reactive way\n  const [gl, log, getReport] = usePerf((s) =\u003e s[(s.gl, s.log, s.getReport)])\n  console.log(gl, log, getReport())\n  return \u003cPerfHeadless /\u003e\n}\n\nfunction App() {\n  return (\n    \u003cCanvas\u003e\n      \u003cPerfHook /\u003e\n    \u003c/Canvas\u003e\n  )\n}\n```\n\n## Custom Data\n\n```jsx\nimport { setCustomData, getCustomData } from 'r3f-perf'\n\nconst UpdateCustomData = () =\u003e {\n  // recommended to throttle to 1sec for readability\n  useFrame(() =\u003e {\n    setCustomData(55 + Math.random() * 5) // will update the panel with the current information\n  })\n  return null\n}\n```\n\n## SSR\n\nThe tool work with any server side rendering framework. You can try with Next and @react-three/fiber using this starter :\nhttps://github.com/pmndrs/react-three-next\n\n### Maintainers :\n\n- [`twitter 🐈‍⬛ @onirenaud`](https://twitter.com/onirenaud)\n- [`twitter @utsuboco`](https://twitter.com/utsuboco)\n","funding_links":[],"categories":["Debug","TypeScript"],"sub_categories":["Avatar"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futsuboco%2Fr3f-perf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Futsuboco%2Fr3f-perf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futsuboco%2Fr3f-perf/lists"}