Three.js - 统计信息

统计信息

统计数据在大型应用程序中起着重要作用。假设您正在创建一个包含许多对象和动画的大型 Three.js 项目。最好监视代码的性能,如 fps(每秒帧数)、分配的内存等。Three.js 的创建者还创建了一个小型 JavaScript 库 Stats.js 来监视渲染。

安装

与任何其他库一样,您可以按照前面讨论的三种方式中的任何一种将其添加到您的项目中。

您可以从 GitHub 下载它并将其导入到您的 HTML 页面。或者您可以将 CDN 链接添加到 HTML 页面。

<script src="https://cdnjs.cloudflare.com/ajax/libs/stats.js/r17/Stats.min.js"></script>

如果您使用的是节点应用程序,请安装 npm 包并将其导入到您的项目中。

npm install stats.js

yarn add stats.js
import * as stats from 'stats.js'

功能

您可以使用 Stats.js 监视以下属性。

  • FPS − 最后一秒渲染的帧数 (0)。
  • MS −渲染一帧所需的毫秒数 (1)。
  • MB − 已分配内存的兆字节数 (2)(使用 --enable-precise-memoryinfo 运行 Chrome)
  • 自定义 − 您可以定义要监视的内容 — 用户定义的面板支持 (3)。

它是如何工作的?

如果您正在监视帧速率,它会计算在最后一秒内调用更新的频率并显示该值。如果您正在跟踪渲染时间,它只会显示调用和更新函数之间的时间。

用法

您可以通过几个简单的步骤将此功能添加到您的代码中。

创建统计信息对象并使用 DOM 将其添加到 HTML 页面。

const stats = new Stats()
stats.showPanel(1) // 0: fps, 1: ms, 2: mb, 3+: custom
document.body.appendChild(stats.dom)

注意 − 您可以使用 showPanel() 显示所需的面板。默认情况下,Stats.js 显示 fps 面板,您可以通过单击面板在面板之间切换。

选择您要监控的代码。

stats.begin()
// 监控的代码放在这里
// 在我们的例子中是渲染函数
renderer.render(scene, camera)
stats.end()

如果您使用动画,则应该在渲染帧时更新统计数据。

function animate() {
   requestAnimationFrame(render)
   // our animations
   renderer.render(scene, camera)
   stats.update()
}

示例

查看此工作示例。

stats.js

<!DOCTYPE html>
<html lang="en">
   <head>
      <meta charset="UTF-8" />
      <meta http-equiv="X-UA-Compatible" content="ie=edge" />
      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      <title>Three.js - Stats.js</title>
      <style>
         * {
            margin: 0;
            padding: 0;
            box-sizing: border-box;
            font-family: -applesystem, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu,
            Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
         }
         html,
         body {
            height: 100vh;
            width: 100vw;
         }
         #threejs-container {
            position: block;
            width: 100%;
            height: 100%;
         }
      </style>
      <script src="https://cdnjs.cloudflare.com/ajax/libs/three.js/r128/three.min.js"></script>
      <script src="https://cdnjs.cloudflare.com/ajax/libs/dat-gui/0.7.7/dat.gui.js"></script>
      <script src="http://mrdoob.github.io/stats.js/build/stats.min.js"></script>
   </head>
   <body>
      <div id="threejs-container"></div>
      <script type="module">
         // Adding stats panel to moniter application statistics
         const gui = new dat.GUI()
         const stats = new Stats()
         //stats.showPanel(0)
         //stats.showPanel(1)
         document.body.appendChild(stats.dom)
         // width, height
         let width = window.innerWidth
         let height = window.innerHeight
         // 场景
         const scene = new THREE.Scene()
         scene.background = new THREE.Color(0x262626)
         // 相机
         const camera = new THREE.PerspectiveCamera(30, width / height, 0.1, 100)
         camera.position.set(0, 0, 10)
         // cube
         const geometry = new THREE.BoxGeometry(1, 1, 1)
         const material = new THREE.MeshBasicMaterial({
            color: 0xffffff,
            wireframe: true
         })
         const cube = new THREE.Mesh(geometry, material)
         scene.add(cube)
         // 响应性
         window.addEventListener('resize', () => {
            width = window.innerWidth
            height = window.innerHeight
            camera.aspect = width / height
            camera.updateProjectionMatrix()
            renderer.setSize(window.innerWidth, window.innerHeight)
            renderer.render(scene, camera)
         })
         // 渲染器
         const renderer = new THREE.WebGL1Renderer()
         renderer.setSize(width, height)
         renderer.setPixelRatio(Math.min(window.devicePixelRatio, 2))
         // 动画
         function animate() {
            requestAnimationFrame(animate)
            cube.rotation.x += 0.005
            cube.rotation.y += 0.01
            renderer.render(scene, camera)
            stats.update()
         }
         // 渲染场景
         const container = document.querySelector('#threejs-container')
         container.append(renderer.domElement)
         stats.begin()
         renderer.render(scene, camera)
         stats.end()
         animate()
      </script>
   </body>
</html>

输出

Show Panel

threejs_debug_and_stats.html