wgpu-matrix - npm Package Compare versions

Comparing version 2.9.1 to 3.0.0

package.json

 {
   "name": "wgpu-matrix",
-  "version": "2.9.1",
+  "version": "3.0.0",
   "description": "fast matrix math library for WebGPU",
-  "main": "dist/2.x/wgpu-matrix.module.js",
-  "module": "dist/2.x/wgpu-matrix.module.js",
-  "types": "dist/2.x/wgpu-matrix.d.ts",
+  "main": "dist/3.x/wgpu-matrix.module.js",
+  "module": "dist/3.x/wgpu-matrix.module.js",
+  "types": "dist/3.x/wgpu-matrix.d.ts",
   "type": "module",
@@ -31,3 +31,3 @@ "sideEffects": false,
   "files": [
-    "dist/2.x/**"
+    "dist/3.x/**"
   ],
@@ -61,3 +61,2 @@ "keywords": [
     "express": "^4.19.2",
-    "google-closure-compiler": "^20230228.0.0",
     "mocha": "^10.4.0",
@@ -67,5 +66,5 @@ "rollup": "^4.17.2",
     "tslib": "^2.6.2",
-    "typedoc": "^0.25.13",
+    "typedoc": "^0.26.0-beta.2",
     "typescript": "^5.4.5"
   }
 }

README.md

@@ -57,3 +57,3 @@ # wgpu-matrix
   mat4,
-} from 'https://wgpu-matrix.org/dist/2.x/wgpu-matrix.module.js';
+} from 'https://wgpu-matrix.org/dist/3.x/wgpu-matrix.module.js';
 
@@ -105,3 +105,3 @@ const fov = 60 * Math.PI / 180
   mat4,
-} from 'https://wgpu-matrix.org/dist/2.x/wgpu-matrix.module.min.js';
+} from 'https://wgpu-matrix.org/dist/3.x/wgpu-matrix.module.min.js';
 
@@ -114,3 +114,3 @@ // ... etc ...
 ```html
-<script src="https://wgpu-matrix.org/dist/2.x/wgpu-matrix.js"></script>
+<script src="https://wgpu-matrix.org/dist/3.x/wgpu-matrix.js"></script>
 <script>
@@ -126,3 +126,3 @@ const { mat4, vec3 } = wgpuMatrix;
 ```html
-<script src="https://wgpu-matrix.org/dist/2.x/wgpu-matrix.min.js"></script>
+<script src="https://wgpu-matrix.org/dist/3.x/wgpu-matrix.min.js"></script>
 ...
@@ -258,2 +258,78 @@ ```
 
+### 2.x -> 3.x
+
+In JavaScript there should be no difference in the API except for the removable of `setDefaultType`.
+
+In TypeScript, 3.x should mostly be type compatible with 2.x. 
+3.x is an attempt to fix the casting that was necessary in 2.x.
+
+```js
+// 2.x
+device.queue.writeData(buffer, 0, mat4.identity() as Float32Array);  // sadness! 😭
+
+// 3.x
+device.queue.writeData(buffer, 0, mat4.identity());  // Yay! 🎉
+```
+
+In TypeScript the differences are as follows
+
+#### Functions have a default type but return what is passed to them as the dst.
+
+In 3.x each function has a default type but if you pass it
+a destination it returns the type of the destination
+
+```ts
+mat4.identity()                       // returns Float32Array
+mat4.identity(new Float32Array(16));  // returns Float32Array
+mat4.identity(new Float64Array(16));  // returns Float32Array
+mat4.identity(new Array(16));         // returns number[]
+```
+
+### Types are specific
+
+```ts
+const a: Mat4 = ...;    // a = Float32Array
+const b: Mat4d = ...;   // b = Float64Array
+const c: Mat4n = ...;   // c = number[]
+```
+
+This is means code like this
+
+```ts
+const position: Mat4 = [10, 20, 30];
+```
+
+No longer works because `Mat4` is a `Float32Array`.
+
+**BUT, functions take any of the normal types as an argument just like they used to**
+
+```js
+const position = [10, 20, 30];          // number[]
+const target = vec3.create(1, 2, 3);    // Float32Array
+const up = new Float64Array([0, 1, 0]); // Float64Array
+
+// Works fine, even those types are different, just like 2.x did
+const view = mat4.lookAt(position, target, up);  // Float32Array
+```
+
+If you really want types for each concrete type there's
+
+* `Float32Array` types: `Mat3`, `Mat4`, `Quat`, `Vec2`, `Vec3`, `Vec4`
+* `Float64Array` types: `Mat3d`, `Mat4d`, `Quatd`, `Vec2d`, `Vec3d`, `Vec4d`,
+* `number[]` types: `Mat3n`, `Mat4n`, `Quatn`, `Vec2n`, `Vec3n`, `Vec4n`
+
+### There are 3 sets of functions, each one returning a different default
+
+```ts
+mat4.identity()   // returns Float32Array
+mat4d.identity()  // returns Float64Array
+mat4n.identity()  // returns number[]
+```
+
+Similarly there's `mat3d`, `mat3n`, `quatd`, `quatn`,
+`vec2d`, `vec2n`, `vec3d`, `vec3n`, `vec4d`, `vec4n`.
+
+**Note: that in general you're unlikely to need any of these. Just use the
+same ones you were using in 2.x**
+
 ### 1.x -> 2.x
@@ -260,0 +336,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1828508

increased by5.87%

Dev dependency count

17

decreased by-5.56%

Number of package files

26

increased by4%

Number of lines in readme file

373

increased by25.59%

Worsened metrics

Lines of code

12796

decreased by-10.47%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes