rayvo 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,76 @@
+# Rayvo
+
+Three 风格 API，WebGPU 级吞吐。为海量对象而生的纯 WebGPU 3D 渲染框架。
+
+官网：[https://www.rayvo.cn/](https://www.rayvo.cn/)
+
+邮箱：[2294954766@qq.com](mailto:2294954766@qq.com)
+
+从实例化合批、GPU 视锥剔除到资源池化，默认路径面向十万级以上可见负载。API 文档、示例和压测都在官网上。
+
+- 文档：[https://www.rayvo.cn/docs/](https://www.rayvo.cn/docs/)
+- 示例：[https://www.rayvo.cn/examples/](https://www.rayvo.cn/examples/)
+
+## 安装
+
+```bash
+npm install rayvo
+```
+
+包入口同时提供 ESM、CommonJS 和 UMD。TypeScript 类型在 `dist/index.d.ts`。
+
+```ts
+import { WebGPURenderer, Scene, PerspectiveCamera, Mesh, BoxGeometry, MeshBasicMaterial } from 'rayvo'
+```
+
+```js
+const { WebGPURenderer, Scene } = require('rayvo')
+```
+
+浏览器脚本使用全局 `rayvo`：
+
+```html
+<script src="https://unpkg.com/rayvo/dist/index.umd.js"></script>
+```
+
+## 用法
+
+```ts
+import {
+    WebGPURenderer,
+    Scene,
+    PerspectiveCamera,
+    Mesh,
+    BoxGeometry,
+    MeshBasicMaterial,
+} from 'rayvo'
+
+const canvas = document.querySelector('canvas')!
+const renderer = new WebGPURenderer({ canvas })
+await renderer.init()
+renderer.setSize(canvas.clientWidth, canvas.clientHeight)
+
+const scene = new Scene(renderer)
+const camera = new PerspectiveCamera(50, canvas.clientWidth / canvas.clientHeight, 0.1, 100)
+camera.position.set(0, 1, 4)
+camera.lookAt(0, 0, 0)
+
+scene.add(new Mesh(new BoxGeometry(1, 1, 1), new MeshBasicMaterial()))
+
+function frame() {
+    renderer.render(scene, camera)
+    requestAnimationFrame(frame)
+}
+frame()
+```
+
+需要支持 WebGPU 的浏览器。`Scene` 要传入已经创建的 `WebGPURenderer`。
+
+## 特性
+
+- **实例化渲染**：相同几何自动合批，万级对象只需少数 DrawCall。
+- **GPU 视锥剔除**：Compute 侧剔除，支撑十万级以上场景吞吐。
+- **帧图与资源复用**：依赖驱动的通道编排，纹理与缓冲按需复用。
+- **内存池化**：统一 Buffer 分配，降低运行时分配与 GC 抖动。
+- **管线缓存**：异步编译与状态复用，压低首帧卡顿。
+- **材质系统**：节点化着色与动态 WGSL，覆盖 unlit 到 PBR。