webgpu-computed 0.0.7 → 0.0.9

package/README.md

@@ -1,72 +1,76 @@
-🌐 Read this in other languages:
-- [简体中文](/webgpu-computed/README.md)
-
 # webgpu-computed
 
-A simplified WebGPU computing library that encapsulates tedious initialization and buffer management, allowing developers to focus on WGSL shader logic.
+🌐 其他语言版本：
+- [English](./README.en.md)
+
+一个简化的 WebGPU 计算库，封装了繁琐的初始化和缓冲区管理，让开发者专注于 WGSL 着色器逻辑。
 
-## Features
+## 特性
 
-- 🚀 Simplified WebGPU initialization
-- 📦 Automatic buffer management and layout calculation
-- 🔧 Support for complex data structures (vectors, matrices)
-- ⚡ High-performance GPU computing
-- 📚 Built-in common WGSL functions
-- ✅ Support node 
+- 🚀 简化的 WebGPU 初始化
+- 📦 自动缓冲区管理和布局计算
+- 🔧 支持复杂数据结构（向量、矩阵）
+- ⚡ 高性能 GPU 计算
+- 📚 内置常用 WGSL 函数
+- ✅ 支持 Node.js 环境
+- 🛠️ TypeScript 支持
+- 📖 详细的中文文档和示例
 
-## Installation
+## 安装
 
 ```bash
 npm install webgpu-computed
 ```
 
-## Quick Start
+## 快速开始
 
-### 1. Initialize WebGPU
+### 1. 初始化 WebGPU
 
-Before using any computing features, you need to initialize the WebGPU environment:
+在使用任何计算功能之前，需要初始化 WebGPU 环境：
 
 ```javascript
 import { GpuComputed } from 'webgpu-computed';
 
-// Initialize WebGPU
+// 初始化 WebGPU
 await GpuComputed.init();
-//After using the node environment, please call:
-//GpuComputed.destroy()
+
+// 在 Node.js 环境中使用后，请调用：
+// GpuComputed.destroy()
 ```
 
-### 2. Perform Simple Computation
+### 2. 执行简单计算
 
-Here is a simple vector addition example:
+以下是一个简单的向量加法示例：
 
 ```javascript
 import { GpuComputed } from 'webgpu-computed';
 
-// Prepare data
+// 准备数据
 const data = {
   inputA: [1.0, 2.0, 3.0, 4.0],
   inputB: [0.5, 1.5, 2.5, 3.5],
-  output: new Array(4).fill(0) // Output buffer
+  output: new Array(4).fill(0) // 输出缓冲区
 };
 
-// WGSL computation code
+// WGSL 计算代码
 const code = `
   output[index] = inputA[index] + inputB[index];
 `;
 
-// Execute computation
-const results = await GpuComputed.computed({
+// 执行计算
+GpuComputed.computed({
   code,
   data,
-  workgroupCount: [1] // Number of workgroups
-});
-
-console.log(results); // [[1.5, 3.5, 5.5, 7.5]]
+  synchronize: ["output"], // 需要返回的数据字段
+  workgroupCount: [1] // 工作组数量
+}).then(results => {
+    console.log(results); // [[1.5, 3.5, 5.5, 7.5]]
+})
 ```
 
-### 3. Using Complex Data Structures
+### 3. 使用复杂数据结构
 
-The library supports vector and matrix types:
+该库支持向量和矩阵类型：
 
 ```javascript
 const data = {
@@ -82,67 +86,169 @@ const code = `
   output[index].vel = positions[index].vel * 2.0;
 `;
 
-const results = await GpuComputed.computed({
+// 执行计算
+GpuComputed.computed({
   code,
   data,
-  workgroupCount: [1]
+  synchronize: ["output"], // 需要返回的数据字段
+  workgroupCount: [1] // 工作组数量
+}).then(results => {
+    console.log(results); // [[1.100000023841858,2.200000047683716,3.299999952316284,0,0.20000000298023224,0.4000000059604645,0.6000000238418579,0,4.400000095367432,5.5,6.599999904632568,0,0.800000011920929,1,1.2000000476837158,0]]
+})
+```
+
+### 4. 手动创建 GpuComputed 实例
+
+如果您需要更精细的控制，可以直接创建 GpuComputed 实例：
+
+```javascript
+import { GpuComputed } from 'webgpu-computed';
+
+// 1. 定义数据模板
+const template = {
+  inputA: [] as number[],
+  inputB: [] as number[],
+  output: [] as number[]
+};
+
+// 2. 创建实例
+const gpuComputed = new GpuComputed(template, {
+  code: `
+    output[index] = inputA[index] + inputB[index];
+  `,
+  workgroupSize: [32, 1, 1] // 可选：自定义工作组大小
+});
+
+// 3. 初始化管线
+await gpuComputed.initPipeline();
+
+// 4. 准备数据
+const data = {
+  inputA: [1.0, 2.0, 3.0, 4.0],
+  inputB: [0.5, 1.5, 2.5, 3.5],
+  output: new Array(4).fill(0)
+};
+
+// 5. 创建绑定组
+const bindGroup = gpuComputed.createBindGroup(data);
+
+// 6. 执行计算
+const results = await gpuComputed.computed(bindGroup, [1], ['output']);
+
+console.log(results[0]); // [1.5, 3.5, 5.5, 7.5]
+```
+
+#### 使用结构体数据
+
+```javascript
+// 定义结构体模板
+const structTemplate = {
+  particles: {
+    layout: [
+      { name: 'position', type: 'vec3' },
+      { name: 'velocity', type: 'vec3' },
+      { name: 'mass', type: 'f32' }
+    ]
+  },
+  output: {
+    layout: [
+      { name: 'position', type: 'vec3' },
+      { name: 'velocity', type: 'vec3' },
+      { name: 'mass', type: 'f32' }
+    ]
+  }
+};
+
+const gpuComputed = new GpuComputed(structTemplate, {
+  code: `
+    output[index].position = particles[index].position + particles[index].velocity;
+    output[index].velocity = particles[index].velocity * 2.0;
+    output[index].mass = particles[index].mass * 1.5;
+  `
 });
+
+await gpuComputed.initPipeline();
+
+const data = {
+  particles: [
+    { position: [1, 2, 3], velocity: [0.1, 0.2, 0.3], mass: 1.0 },
+    { position: [4, 5, 6], velocity: [0.4, 0.5, 0.6], mass: 2.0 }
+  ],
+  output: [
+    { position: [0, 0, 0], velocity: [0, 0, 0], mass: 0 },
+    { position: [0, 0, 0], velocity: [0, 0, 0], mass: 0 }
+  ]
+};
+
+const bindGroup = gpuComputed.createBindGroup(data);
+const results = await gpuComputed.computed(bindGroup, [1], ['output']);
+
+console.log(results[0]); // 映射后的数据
+```
+
+#### 数据映射
+
+当使用结构体时，可以使用 `dataMap` 方法将结果映射回原始结构：
+
+```javascript
+const mappedData = gpuComputed.dataMap(results[0], 'output');
+console.log(mappedData); // 返回结构化的对象数组
 ```
 
-## API Reference
+## API 参考
 
-### GpuComputed Class
+### GpuComputed 类
 
-#### Static Methods
+#### 静态方法
 
 ##### `GpuComputed.init()`
 
-Initializes the WebGPU environment. Must be called before using other features.
+初始化 WebGPU 环境。必须在使用其他功能之前调用。
 
-**Returns**: `Promise<void>`
+**返回值**: `Promise<void>`
 
-**Throws**: If the browser does not support WebGPU or fails to obtain adapter/device
+**抛出异常**: 如果浏览器不支持 WebGPU 或获取适配器/设备失败
 
 ##### `GpuComputed.computed(options)`
 
-Executes a GPU computation task.
+执行 GPU 计算任务。
 
-**Parameters**:
+**参数**:
 
-- `code` (string): WGSL computation code
-- `data` (object): Input/output data object
-- `workgroupCount` (array): Number of workgroups [x, y?, z?]
-- `workgroupSize` (array, optional): Workgroup size, default [32, 1, 1]
-- `globalInvocationIdName` (string, optional): Global invocation ID variable name, default "grid"
-- `workgroupIndexName` (string, optional): Workgroup index variable name, default "index"
-- `synchronize` (array, optional): Array of buffer names to synchronize back to CPU
-- `beforeCodes` (array, optional): WGSL code snippets before the computation function
-- `onSuccess` (function, optional): Success callback function
+- `code` (string): WGSL 计算代码
+- `data` (object): 输入/输出数据对象
+- `workgroupCount` (array): 工作组数量 [x, y?, z?]
+- `workgroupSize` (array, 可选): 工作组大小，默认 [32, 1, 1]
+- `globalInvocationIdName` (string, 可选): 全局调用 ID 变量名，默认 "grid"
+- `workgroupIndexName` (string, 可选): 工作组索引变量名，默认 "index"
+- `synchronize` (array, 可选): 需要同步回 CPU 的缓冲区名称数组
+- `beforeCodes` (array, 可选): 计算函数之前的 WGSL 代码片段
+- `onSuccess` (function, 可选): 成功回调函数
 
-**Returns**: `Promise<Array<Float32Array>>` - Data from synchronized buffers
+**返回值**: `Promise<Array<Float32Array>>` - 同步缓冲区的数据
 
-### Data Types
+### 数据类型
 
-Supports the following WGSL types:
+支持以下 WGSL 类型：
 
-- `f32`: Single-precision float
-- `vec2`: 2D vector
-- `vec3`: 3D vector
-- `vec4`: 4D vector
-- `mat3x3`: 3x3 matrix
-- `mat4x4`: 4x4 matrix
+- `f32`: 单精度浮点数
+- `vec2`: 2D 向量
+- `vec3`: 3D 向量
+- `vec4`: 4D 向量
+- `mat3x3`: 3x3 矩阵
+- `mat4x4`: 4x4 矩阵
 
-### Built-in WGSL Functions
+### 内置 WGSL 函数
 
-The library provides some commonly used WGSL helper functions:
+该库提供了一些常用的 WGSL 辅助函数：
 
-#### Quaternion Rotation
+#### 四元数旋转
 
 ```wgsl
 fn quat_rotate(q: vec4<f32>, v: vec3<f32>) -> vec3<f32>
 ```
 
-Usage example:
+使用示例：
 
 ```javascript
 import { WGSL_Fun } from 'webgpu-computed';
@@ -154,39 +260,39 @@ await GpuComputed.computed({
 })
 ```
 
-#### Point in OBB Detection
+#### 点在 OBB 中的检测
 
 ```wgsl
 fn point_in_obb(point: vec3<f32>, center: vec3<f32>, halfSize: vec3<f32>, quat: vec4<f32>) -> bool
 ```
 
-## Advanced Usage
+## 高级用法
 
-### Custom Workgroup Configuration
+### 自定义工作组配置
 
 ```javascript
 await GpuComputed.computed({
   code: '...',
   data: {...},
-  workgroupCount: [4, 4], // 16 workgroups
-  workgroupSize: [16, 16], // 256 threads per workgroup
+  workgroupCount: [4, 4], // 16 个工作组
+  workgroupSize: [16, 16], // 每个工作组 256 个线程
 });
 ```
 
-### Synchronizing Data Back to CPU
+### 将数据同步回 CPU
 
 ```javascript
 const results = await GpuComputed.computed({
   code: '...',
   data: {...},
-  synchronize: ['output'], // Specify buffers to synchronize
+  synchronize: ['output'], // 指定要同步的缓冲区
   workgroupCount: [1]
 });
 
-// results contains synchronized data
+// results 包含同步的数据
 ```
 
-### Callback Function
+### 回调函数
 
 ```javascript
 await GpuComputed.computed({
@@ -194,195 +300,198 @@ await GpuComputed.computed({
   data: {...},
   workgroupCount: [1],
   onSuccess: ({ code, bufferInfoList, results }) => {
-    console.log('Computation completed', results);
+    console.log('计算完成', results);
   }
 });
 ```
 
-## Browser Support
+## 示例项目
 
-- Chrome 113+
-- Edge 113+
-- Firefox (partial support)
-- Safari (partial support)
+```js
+import { GpuComputed } from "webgpu-computed"
+import * as WGSL_Fun from "webgpu-computed"
 
-Ensure the browser supports the WebGPU API.
+// 1. 初始化 WebGPU
+console.log('初始化 WebGPU...');
+await GpuComputed.init();
+console.log('WebGPU 初始化成功');
+
+// 2. 简单数组计算示例
+console.log('\n=== 简单数组计算 ===');
+const simpleData = {
+    inputA: [1.0, 2.0, 3.0, 4.0],
+    inputB: [0.5, 1.5, 2.5, 3.5],
+    output: new Array(4).fill(0)
+};
 
-## Example Project
+const simpleCode = `
+    output[index] = inputA[index] + inputB[index];
+`;
 
-```js
-    import { GpuComputed } from "webgpu-computed"
-
-    // 1. Initialize WebGPU
-    console.log('Initializing WebGPU...');
-    await GpuComputed.init();
-    console.log('WebGPU initialized successfully');
-
-    // 2. Simple array computation example
-    console.log('\n=== Simple Array Computation ===');
-    const simpleData = {
-        inputA: [1.0, 2.0, 3.0, 4.0],
-        inputB: [0.5, 1.5, 2.5, 3.5],
-        output: new Array(4).fill(0)
-    };
-
-    const simpleCode = `
-        output[index] = inputA[index] + inputB[index];
-    `;
-
-    const simpleResults = await GpuComputed.computed({
-        code: simpleCode,
-        data: simpleData,
-        workgroupCount: [1],
-        synchronize: ['output']
-    });
-
-    console.log('Simple computation result:', simpleResults[0]); // [1.5, 3.5, 5.5, 7.5]
-
-    // 3. Complex data structure example (struct)
-    console.log('\n=== Complex Data Structure Computation ===');
-    const complexData = {
-        particles: [
-            { position: [1.0, 2.0, 3.0], velocity: [0.1, 0.2, 0.3], mass: 1.0 },
-            { position: [4.0, 5.0, 6.0], velocity: [0.4, 0.5, 0.6], mass: 2.0 }
-        ],
-        output: [
-            { position: [0, 0, 0], velocity: [0, 0, 0], mass: 0 },
-            { position: [0, 0, 0], velocity: [0, 0, 0], mass: 0 }
-        ]
-    };
-
-    const complexCode = `
-        output[index].position = particles[index].position + particles[index].velocity;
-        output[index].velocity = particles[index].velocity * 2.0;
-        output[index].mass = particles[index].mass * 1.5;
-    `;
-
-    const complexResults = await GpuComputed.computed({
-        code: complexCode,
-        data: complexData,
-        workgroupCount: [1],
-        synchronize: ['output']
-    });
-
-    console.log('Complex computation result:', complexResults[0]);
-
-    // 4. Using built-in WGSL functions example
-    console.log('\n=== Using Built-in WGSL Functions ===');
-    const wgslFunData = {
-        points: [
-            {
-                x: 1.0, y: 0.0, z: 0.0
-            },
-            {
-                x: 0.0, y: 1.0, z: 0.0
-            },
-            {
-                x: -1.0, y: 0.0, z: 0.0
-            }
-        ],
-        obbCenter: [0.0, 0.0, 0.0],
-        obbHalfSize: [2.0, 2.0, 2.0],
-        obbRotation: [0.0, 0.0, 0.0, 1.0], // Unit quaternion, no rotation
-        results: new Array(3).fill(0)
-    };
-
-    const wgslFunCode = `
-        let point = vec3(points[index].x, points[index].y, points[index].z);
-        let center = vec3<f32>(obbCenter[0], obbCenter[1], obbCenter[2]);
-        let halfSize = vec3<f32>(obbHalfSize[0], obbHalfSize[1], obbHalfSize[2]);
-        let quat = vec4<f32>(obbRotation[0], obbRotation[1], obbRotation[2], obbRotation[3]);
-
-        if (point_in_obb(point, center, halfSize, quat)) {
-            results[index] = 1.0;
-        } else {
-            results[index] = 0.0;
-        }
-    `;
-
-    const wgslFunResults = await GpuComputed.computed({
-        code: wgslFunCode,
-        data: wgslFunData,
-        workgroupCount: [1],
-        beforeCodes: [WGSL_Fun.quat_rotate, WGSL_Fun.point_in_obb, /** Add your own function code */],
-        synchronize: ['results']
-    });
-
-    console.log('OBB detection result:', wgslFunResults[0]); // [1, 1, 1] All points are inside the OBB
-
-    // 5. Custom workgroup configuration example
-    console.log('\n=== Custom Workgroup Configuration ===');
-    const largeData = {
-        largeArray: new Array(1024).fill(0).map((_, i) => i * 1.0),
-        output: new Array(1024).fill(0)
-    };
-
-    const largeCode = `
-        output[index] = largeArray[index] * 2.0;
-    `;
-
-    const largeResults = await GpuComputed.computed({
-        code: largeCode,
-        data: largeData,
-        workgroupCount: [32], // 32 workgroups
-        workgroupSize: [32, 1, 1], // 32 threads per workgroup, total 1024 threads
-        synchronize: ['output']
-    });
-
-    console.log('Large array computation result (first 10):', largeResults[0].slice(0, 10));
-
-    // 6. Using callback function example
-    console.log('\n=== Using Callback Function ===');
-    const callbackData = {
-        values: [10.0, 20.0, 30.0],
-        squares: new Array(3).fill(0)
-    };
-
-    const callbackCode = `
-        squares[index] = values[index] * values[index];
-    `;
-
-    await GpuComputed.computed({
-        code: callbackCode,
-        data: callbackData,
-        workgroupCount: [1],
-        synchronize: ['squares'],
-        onSuccess: ({ code, bufferInfoList, results }) => {
-            console.log('Callback triggered, square computation result:', results[0]); // [100, 400, 900]
+const simpleResults = await GpuComputed.computed({
+    code: simpleCode,
+    data: simpleData,
+    workgroupCount: [1],
+    synchronize: ['output']
+});
+
+console.log('简单计算结果:', simpleResults[0]); // [1.5, 3.5, 5.5, 7.5]
+
+// 3. 复杂数据结构示例（结构体）
+console.log('\n=== 复杂数据结构计算 ===');
+const complexData = {
+    particles: [
+        { position: [1.0, 2.0, 3.0], velocity: [0.1, 0.2, 0.3], mass: 1.0 },
+        { position: [4.0, 5.0, 6.0], velocity: [0.4, 0.5, 0.6], mass: 2.0 }
+    ],
+    output: [
+        { position: [0, 0, 0], velocity: [0, 0, 0], mass: 0 },
+        { position: [0, 0, 0], velocity: [0, 0, 0], mass: 0 }
+    ]
+};
+
+const complexCode = `
+    output[index].position = particles[index].position + particles[index].velocity;
+    output[index].velocity = particles[index].velocity * 2.0;
+    output[index].mass = particles[index].mass * 1.5;
+`;
+
+const complexResults = await GpuComputed.computed({
+    code: complexCode,
+    data: complexData,
+    workgroupCount: [1],
+    synchronize: ['output']
+});
+
+console.log('复杂计算结果:', complexResults[0]);
+
+// 4. 使用内置 WGSL 函数示例
+console.log('\n=== 使用内置 WGSL 函数 ===');
+const wgslFunData = {
+    points: [
+        {
+            x: 1.0, y: 0.0, z: 0.0
+        },
+        {
+            x: 0.0, y: 1.0, z: 0.0
+        },
+        {
+            x: -1.0, y: 0.0, z: 0.0
         }
-    });
-
-    // 7. Multi-dimensional workgroup example
-    console.log('\n=== Multi-dimensional Workgroup ===');
-    const matrixData = {
-        matrixA: new Array(16).fill(0).map((_, i) => i * 1.0),
-        matrixB: new Array(16).fill(0).map((_, i) => (i + 1) * 1.0),
-        result: new Array(16).fill(0)
-    };
-
-    const matrixCode = `
-        let x = index % 4u;
-        let y = index / 4u;
-        let idx = y * 4u + x;
-        result[idx] = matrixA[idx] + matrixB[idx];
-    `;
-
-    const matrixResults = await GpuComputed.computed({
-        code: matrixCode,
-        data: matrixData,
-        workgroupCount: [4, 4], // 4x4 workgroup grid
-        workgroupSize: [1, 1, 1], // 1 thread per workgroup
-        synchronize: ['result']
-    });
-
-    console.log('Matrix computation result:', matrixResults[0]);
-
-    console.log('\nAll feature examples completed!');
+    ],
+    obbCenter: [0.0, 0.0, 0.0],
+    obbHalfSize: [2.0, 2.0, 2.0],
+    obbRotation: [0.0, 0.0, 0.0, 1.0], // 单位四元数，无旋转
+    results: new Array(3).fill(0)
+};
+
+const wgslFunCode = `
+    let point = vec3(points[index].x, points[index].y, points[index].z);
+    let center = vec3<f32>(obbCenter[0], obbCenter[1], obbCenter[2]);
+    let halfSize = vec3<f32>(obbHalfSize[0], obbHalfSize[1], obbHalfSize[2]);
+    let quat = vec4<f32>(obbRotation[0], obbRotation[1], obbRotation[2], obbRotation[3]);
+
+    if (point_in_obb(point, center, halfSize, quat)) {
+        results[index] = 1.0;
+    } else {
+        results[index] = 0.0;
+    }
+`;
+
+const wgslFunResults = await GpuComputed.computed({
+    code: wgslFunCode,
+    data: wgslFunData,
+    workgroupCount: [1],
+    beforeCodes: [WGSL_Fun.quat_rotate, WGSL_Fun.point_in_obb, /** 可添加自己的函数代码 */],
+    synchronize: ['results']
+});
+
+console.log('OBB 检测结果:', wgslFunResults[0]); // [1, 1, 1] 所有点都在 OBB 内
+
+// 5. 自定义工作组配置示例
+console.log('\n=== 自定义工作组配置 ===');
+const largeData = {
+    largeArray: new Array(1024).fill(0).map((_, i) => i * 1.0),
+    output: new Array(1024).fill(0)
+};
+
+const largeCode = `
+    output[index] = largeArray[index] * 2.0;
+`;
+
+const largeResults = await GpuComputed.computed({
+    code: largeCode,
+    data: largeData,
+    workgroupCount: [32], // 32 个工作组
+    workgroupSize: [32, 1, 1], // 每个工作组 32 个线程，总共 1024 个线程
+    synchronize: ['output']
+});
+
+console.log('大数组计算结果 (前 10 个):', largeResults[0].slice(0, 10));
+
+// 6. 使用回调函数示例
+console.log('\n=== 使用回调函数 ===');
+const callbackData = {
+    values: [10.0, 20.0, 30.0],
+    squares: new Array(3).fill(0)
+};
+
+const callbackCode = `
+    squares[index] = values[index] * values[index];
+`;
+
+await GpuComputed.computed({
+    code: callbackCode,
+    data: callbackData,
+    workgroupCount: [1],
+    synchronize: ['squares'],
+    onSuccess: ({ code, bufferInfoList, results }) => {
+        console.log('回调触发，平方计算结果:', results[0]); // [100, 400, 900]
+    }
+});
+
+// 7. 多维工作组示例
+console.log('\n=== 多维工作组 ===');
+const matrixData = {
+    matrixA: new Array(16).fill(0).map((_, i) => i * 1.0),
+    matrixB: new Array(16).fill(0).map((_, i) => (i + 1) * 1.0),
+    result: new Array(16).fill(0)
+};
+
+const matrixCode = `
+    let x = index % 4u;
+    let y = index / 4u;
+    let idx = y * 4u + x;
+    result[idx] = matrixA[idx] + matrixB[idx];
+`;
+
+const matrixResults = await GpuComputed.computed({
+    code: matrixCode,
+    data: matrixData,
+    workgroupCount: [4, 4], // 4x4 工作组网格
+    workgroupSize: [1, 1, 1], // 每个工作组 1 个线程
+    synchronize: ['result']
+});
+
+console.log('矩阵计算结果:', matrixResults[0]);
+
+console.log('\n所有功能示例完成！');
 ```
 
-## License
+## 浏览器支持
 
-ISC License
+- Chrome 113+
+- Edge 113+
+- Firefox (部分支持)
+- Safari (部分支持)
+
+确保浏览器支持 WebGPU API。
+
+## 贡献
 
----
+欢迎提交 Issue 和 Pull Request！
+
+## 许可证
+
+ISC License