update docs and cleanup

Avnerus · Avnerus · commit 236cfb82bda0 · 2024-02-20T11:08:14.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,16 @@
+## v1.2
+
+## v1.2.0
+ - Support for Photorealistic 3D Tiles by Google Maps ([demo: requires API key](https://nytimes.github.io/three-loader-3dtiles/dist/web/examples/demos/google-3dtiles/), [demo source](https://github.com/nytimes/three-loader-3dtiles/blob/main/examples/demos/google-3dtiles/index.html)).
+ - Upgrade to loaders.gl v4.1 and Three.js r160.
+   - Includes loaders.gl PRs [#2847](https://github.com/visgl/loaders.gl/pull/2847) and [#2851](https://github.com/visgl/loaders.gl/pull/2851).
+ - Faster build system with Vite.
+ - Support for `memoryAdjustedScreenSpaceError` and `memoryCacheOverflow` - Adjust the maximum screen space error based on GPU memory utilization.
+ - More accurate estimates of GPU memory utilization.
+ - `runtime.update()` function now takes `viewportHeight` instead of the whole `renderer` object (for screen space error calculations).
+ - Support providing an external `gltfLoader` in `options`, to reuse existing loader workers.
+ - Minor performance optimizations.
+
 ## v1.1
 
 ### v1.1.17
diff --git a/README.md b/README.md
@@ -170,7 +170,7 @@ npm run test
 
 ## Docs
 * API documentation is available [here](docs/three-loader-3dtiles.md). 
-* Code for the demos is in [`examples/demos`](examples/demos).
+* Code for the demos is in [examples/demos](https://github.com/nytimes/three-loader-3dtiles/tree/main/examples/demos).
 
 ## Alternatives
 To our knowledge, this is the only [loaders.gl](https://github.com/visgl/loaders.gl)-based Three.js library, but there are several implementations of 3D Tiles for Three.js. Notable examples:
diff --git a/docs/three-loader-3dtiles.loaderoptions.md b/docs/three-loader-3dtiles.loaderoptions.md
@@ -30,7 +30,7 @@ interface LoaderOptions
 |  [maximumScreenSpaceError?](./three-loader-3dtiles.loaderoptions.maximumscreenspaceerror.md) |  | number | _(Optional)_ determines the distance from tiles in which they are refined, depending on their geometrical size. increase the value to load lower lod tiles from the same view distance (increases performnace) - Default: <code>16</code>. |
 |  [maxRequests?](./three-loader-3dtiles.loaderoptions.maxrequests.md) |  | number | _(Optional)_ When thorttling requests, how many requests can launch simultaneously - Default: <code>64</code> |
 |  [memoryAdjustedScreenSpaceError?](./three-loader-3dtiles.loaderoptions.memoryadjustedscreenspaceerror.md) |  | boolean | _(Optional)_ Whether to adjust the screen space error to maintain the maximum memory limit - Default <code>true</code>. |
-|  [memoryCacheOverflow](./three-loader-3dtiles.loaderoptions.memorycacheoverflow.md) |  | number |  |
+|  [memoryCacheOverflow?](./three-loader-3dtiles.loaderoptions.memorycacheoverflow.md) |  | number | _(Optional)_ The maximum additional memory (in MB) to allow for cache headroom before adjusting the screen spacer error - Default: <code>1</code>. |
 |  [pointCloudColoring?](./three-loader-3dtiles.loaderoptions.pointcloudcoloring.md) |  | [PointCloudColoring](./three-loader-3dtiles.pointcloudcoloring.md) | _(Optional)_ When viewing Point Cloud tiles, how should the points be colored ([PointCloudColoring](./three-loader-3dtiles.pointcloudcoloring.md)<!-- -->) - Default: <code>PointCloudColoring.White</code> |
 |  [pointSize?](./three-loader-3dtiles.loaderoptions.pointsize.md) |  | number | _(Optional)_ Point size for Point Cloud tiles - Default: <code>1.0</code> |
 |  [preloadTilesCount?](./three-loader-3dtiles.loaderoptions.preloadtilescount.md) |  | number | _(Optional)_ When using a three.js loading manager, do not call <code>onLoad</code> until this number of tiles were loaded - Default: <code>undefined</code> |
diff --git a/docs/three-loader-3dtiles.loaderoptions.memorycacheoverflow.md b/docs/three-loader-3dtiles.loaderoptions.memorycacheoverflow.md
@@ -4,8 +4,10 @@
 
 ## LoaderOptions.memoryCacheOverflow property
 
+The maximum additional memory (in MB) to allow for cache headroom before adjusting the screen spacer error - Default: `1`<!-- -->.
+
 **Signature:**
 
 ```typescript
-memoryCacheOverflow: number;
+memoryCacheOverflow?: number;
 ```
diff --git a/etc/three-loader-3dtiles.api.md b/etc/three-loader-3dtiles.api.md
@@ -58,8 +58,7 @@ export interface LoaderOptions {
     maximumScreenSpaceError?: number;
     maxRequests?: number;
     memoryAdjustedScreenSpaceError?: boolean;
-    // (undocumented)
-    memoryCacheOverflow: number;
+    memoryCacheOverflow?: number;
     pointCloudColoring?: PointCloudColoring;
     pointSize?: number;
     preloadTilesCount?: number;
diff --git a/examples/demos/cesium/index.html b/examples/demos/cesium/index.html
@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
diff --git a/examples/demos/google-3dtiles/index.html b/examples/demos/google-3dtiles/index.html
@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
diff --git a/examples/demos/index.html b/examples/demos/index.html
@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
diff --git a/examples/demos/map-overlay/index.html b/examples/demos/map-overlay/index.html
@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
diff --git a/examples/demos/realitycapture/index.html b/examples/demos/realitycapture/index.html
@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/types.ts b/src/types.ts
diff --git a/vite.config.examples.js b/vite.config.examples.js
diff --git a/vite.config.lib.js b/vite.config.lib.js

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<!DOCTYPE html>`
`1`	`2`	`<html lang="en">`
`2`	`3`	`<head>`
`3`	`4`	`<meta charset="UTF-8">`