Skip to content

Commit 66ef688

Browse files
ibgreenibgreen
authored
docs: 4.4 release docs (#3338)
1 parent b8a23bc commit 66ef688

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+278
-494
lines changed

‎apps/tile-converter/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
"@types/inquirer": "^9.0.7"
9292
},
9393
"peerDependencies": {
94-
"@loaders.gl/core": "4.4.0-alpha.1"
94+
"@loaders.gl/core": "~4.4.0"
9595
},
9696
"gitHead": "8a9e77743ea90a7be4ebec572416bb50ca9d73c3"
9797
}

‎docs/README.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ loaders.gl provides a wide selection of loaders organized into categories:
3535
| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3636
| [Table Loaders](/docs/specifications/category-table) | Streaming tabular loaders for [CSV](/docs/modules/csv/api-reference/csv-loader), [JSON](/docs/modules/json/api-reference/json-loader), [Arrow](/docs/modules/arrow/api-reference/arrow-loader) etc |
3737
| [Geospatial Loaders](/docs/specifications/category-gis) | Loaders for geospatial formats such as [GeoJSON](/docs/modules/json/api-reference/geojson-loader) [KML](/docs/modules/kml/api-reference/kml-loader), [WKT/WKB](/docs/modules/wkt/api-reference/wkt-loader), [Mapbox Vector Tiles](/docs/modules/mvt/api-reference/mvt-loader) etc. |
38-
| [Image Loaders](/docs/specifications/category-image) | Loaders for [images](/docs/modules/images/api-reference/image-loader), [compressed textures](/docs/modules/textures/api-reference/compressed-texture-loader), [supercompressed textures (Basis)](/docs/modules/textures/api-reference/basis-loader), [composite image textures](/docs/modules/textures/api-reference/image-texture-cube-loader), [binary images](/docs/modules/images/api-reference/binary-image-api) and more. |
38+
| [Image Loaders](/docs/specifications/category-image) | Loaders for [images](/docs/modules/images/api-reference/image-loader), [compressed textures](/docs/modules/textures/api-reference/compressed-texture-loader), [supercompressed textures (Basis)](/docs/modules/textures/api-reference/basis-loader), [composite image textures](/docs/modules/textures/api-reference/texture-cube-loader), [binary images](/docs/modules/images/api-reference/binary-image-api) and more. |
3939
| [Pointcloud and Mesh Loaders](/docs/specifications/category-mesh) | Loaders for point cloud and simple mesh formats such as [Draco](/docs/modules/draco/api-reference/draco-loader), [LAS](/docs/modules/las/api-reference/las-loader), [PCD](/docs/modules/pcd/api-reference/pcd-loader), [PLY](/docs/modules/ply/api-reference/ply-loader), [OBJ](/docs/modules/obj/api-reference/obj-loader), and [Terrain](/docs/modules/terrain/api-reference/terrain-loader). |
4040
| [Scenegraph Loaders](/docs/specifications/category-scenegraph) | [glTF](/docs/modules/gltf/api-reference/gltf-loader) loader |
4141
| [Tiled Data Loaders](/docs/specifications/category-3d-tiles) | Loaders for 3D tile formats such as [3D Tiles](/docs/modules/3d-tiles/api-reference/tiles-3d-loader), [I3S](/docs/modules/i3s/api-reference/i3s-loader) and potree |

‎docs/modules/core/api-reference/loader-options.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,6 @@
22

33
APIs in `@loaders.gl/core` takes an `options?: LoaderOptions` parameter. The options are documented on this page.
44

5-
## Loader specific options
6-
7-
The options object can contain loader specific options. The options for each loader are supplied in a sub object,
8-
see the documentation for each loader for details:
9-
10-
```typescript
11-
{
12-
csv: {
13-
shape: 'row-object-table'
14-
},
15-
json: {
16-
shape: 'row-object-table'
17-
}
18-
}
19-
```
20-
215
## Top-level options
226

237
Top level options are interpreted by the core API and apply to all loaders.
@@ -38,13 +22,29 @@ Top level options are interpreted by the core API and apply to all loaders.
3822
| `options.modules` | `object` | - | Supply bundled JS/WASM runtime modules or URL overrides. See the [dependency guide](/docs/developer-guide/dependencies) and individual loader or writer docs for supported keys. |
3923
| `options.CDN` (🚧 experimental) | `string` | - | Controls certain script loading from CDN. `true` loads from `unpkg.com/@loaders.gl`. `false` load from local urls. `string` alternate CDN url. |
4024

25+
## Loader specific options
26+
27+
The options object can contain loader specific options. The options for each loader are supplied in a sub object,
28+
see the documentation for each loader for details:
29+
30+
```typescript
31+
{
32+
csv: {
33+
shape: 'row-object-table'
34+
},
35+
json: {
36+
shape: 'row-object-table'
37+
}
38+
}
39+
```
40+
4141
## Batched parsing options
4242

43-
| Option | Type | Default | Description |
44-
| ---------------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
45-
| `options.metadata` | `boolean` | `false` | An initial batch with `batchType: 'metadata'` will be added with information about the data being loaded. |
46-
| `options.batches.chunkSize?` | `number` | N/A | When set, "atomic" inputs (like `ArrayBuffer` or `string`) are chunked, enabling batched parsing. | No effect if input is already an iterator or stream. |
47-
| `options.transforms` | `*[]` | `[]` | An array with transform functions that can be applied to the input data before parsing. |
43+
| Option | Type | Default | Description |
44+
| ---------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
45+
| `options.metadata` | `boolean` | `false` | An initial batch with `batchType: 'metadata'` will be added with information about the data being loaded. |
46+
| `options.batches.chunkSize?` | `number` | N/A | When set, "atomic" inputs (like `ArrayBuffer` or `string`) are chunked, enabling batched parsing. No effect if input is already an iterator or stream. |
47+
| `options.transforms` | `*[]` | `[]` | An array with transform functions that can be applied to the input data before parsing. |
4848

4949
Notes:
5050

‎docs/modules/mlt/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# @loaders.gl/mlt
22

3+
<p class="badges">
4+
<img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" />
5+
</p>
6+
37
Support for loading [MapLibre Tile](/docs/modules/mlt/formats/mlt) vector tiles.
48

59
## Installation

‎docs/modules/textures/README.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,28 @@ npm install @loaders.gl/core
2323

2424
The `@loaders.gl/textures` module handles the following formats:
2525

26-
| Format | Description |
27-
| --------------------------------------------------------------------------- | ------------------------------------------------------------- |
28-
| [`Compressed Textures`](/docs/modules/textures/formats/compressed-textures) | Overview of GPU texture container and compression formats |
29-
| [`KTX / KTX2`](/docs/modules/textures/formats/ktx) | Khronos texture container formats for mipmapped textures |
30-
| [`DDS`](/docs/modules/textures/formats/dds) | Microsoft DirectDraw Surface texture container |
31-
| [`PVR`](/docs/modules/textures/formats/pvr) | PowerVR texture container format |
32-
| [`Basis Universal`](/docs/modules/textures/formats/basis) | Supercompressed texture format for runtime transcoding |
33-
| [`Crunch`](/docs/modules/textures/formats/crunch) | Lossy compressed texture distribution format for GPU textures |
34-
| [`Radiance HDR`](/docs/modules/textures/formats/hdr) | High-dynamic-range RGBE textures stored in `.hdr` files |
26+
| Format | Description |
27+
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
28+
| [`Compressed Textures`](/docs/modules/textures/formats/compressed-textures) | Overview of GPU texture container and compression formats |
29+
| [`KTX / KTX2`](/docs/modules/textures/formats/ktx) | Khronos texture container formats for mipmapped textures |
30+
| [`DDS`](/docs/modules/textures/formats/dds) | Microsoft DirectDraw Surface texture container |
31+
| [`PVR`](/docs/modules/textures/formats/pvr) | PowerVR texture container format |
32+
| [`Basis Universal`](/docs/modules/textures/formats/basis) | Supercompressed texture format for runtime transcoding |
33+
| [`Crunch`](/docs/modules/textures/formats/crunch) | Lossy compressed texture distribution format for GPU textures |
34+
| [`Radiance HDR`](/docs/modules/textures/formats/hdr) | High-dynamic-range RGBE textures stored in `.hdr` files <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" /> |
3535

3636
## API
3737

38-
| Loader | Description |
39-
| ------------------------------------------------------------------------------------------- | ----------------------------------------------- |
40-
| [`BasisLoader`](/docs/modules/textures/api-reference/basis-loader) | Basis Universal textures as `TextureLevel[][]` |
41-
| [`CompressedTextureLoader`](/docs/modules/textures/api-reference/compressed-texture-loader) | KTX, DDS and PVR mip chains as `TextureLevel[]` |
42-
| [`RadianceHDRLoader`](/docs/modules/textures/api-reference/radiance-hdr-loader) | Radiance `.hdr` textures as `Texture` |
43-
| [`CrunchWorkerLoader`](/docs/modules/textures/api-reference/crunch-loader) | Crunch mip chains as `TextureLevel[]` |
44-
| [`TextureLoader`](/docs/modules/textures/api-reference/texture-loader) | Manifest-driven single image or mip chain |
45-
| [`TextureArrayLoader`](/docs/modules/textures/api-reference/texture-array-loader) | Manifest-driven texture arrays |
46-
| [`TextureCubeLoader`](/docs/modules/textures/api-reference/texture-cube-loader) | Manifest-driven cubemaps |
47-
| [`TextureCubeArrayLoader`](/docs/modules/textures/api-reference/texture-cube-array-loader) | Manifest-driven cube arrays |
38+
| Loader | Description |
39+
| ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
40+
| [`BasisLoader`](/docs/modules/textures/api-reference/basis-loader) | Basis Universal textures as `TextureLevel[][]` |
41+
| [`CompressedTextureLoader`](/docs/modules/textures/api-reference/compressed-texture-loader) | KTX, DDS and PVR mip chains as `TextureLevel[]` |
42+
| [`RadianceHDRLoader`](/docs/modules/textures/api-reference/radiance-hdr-loader) | Radiance `.hdr` textures as `Texture` <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" /> |
43+
| [`CrunchWorkerLoader`](/docs/modules/textures/api-reference/crunch-loader) | Crunch mip chains as `TextureLevel[]` |
44+
| [`TextureLoader`](/docs/modules/textures/api-reference/texture-loader) | Manifest-driven single image or mip chain <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" /> |
45+
| [`TextureArrayLoader`](/docs/modules/textures/api-reference/texture-array-loader) | Manifest-driven texture arrays <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" /> |
46+
| [`TextureCubeLoader`](/docs/modules/textures/api-reference/texture-cube-loader) | Manifest-driven cubemaps <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" /> |
47+
| [`TextureCubeArrayLoader`](/docs/modules/textures/api-reference/texture-cube-array-loader) | Manifest-driven cube arrays <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" /> |
4848

4949
## Return Types
5050

@@ -80,10 +80,10 @@ See [`BasisLoader`](/docs/modules/textures/api-reference/basis-loader) and [`Com
8080

8181
The textures module also includes manifest-driven loaders for composite image textures:
8282

83-
- [`TextureLoader`](/docs/modules/textures/api-reference/texture-loader) for a single image or mip chain
84-
- [`TextureArrayLoader`](/docs/modules/textures/api-reference/texture-array-loader) for texture arrays, including mipmapped layers
85-
- [`TextureCubeLoader`](/docs/modules/textures/api-reference/texture-cube-loader) for cubemaps, including mipmapped faces
86-
- [`TextureCubeArrayLoader`](/docs/modules/textures/api-reference/texture-cube-array-loader) for cube arrays
83+
- [`TextureLoader`](/docs/modules/textures/api-reference/texture-loader) for a single image or mip chain <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" />
84+
- [`TextureArrayLoader`](/docs/modules/textures/api-reference/texture-array-loader) for texture arrays, including mipmapped layers <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" />
85+
- [`TextureCubeLoader`](/docs/modules/textures/api-reference/texture-cube-loader) for cubemaps, including mipmapped faces <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" />
86+
- [`TextureCubeArrayLoader`](/docs/modules/textures/api-reference/texture-cube-array-loader) for cube arrays <img src="https://img.shields.io/badge/From-v4.4-blue.svg?style=flat-square" alt="From-v4.4" />
8787

8888
These loaders resolve relative member URLs against the manifest URL, or against `options.core.baseUrl` when parsing an in-memory manifest.
8989
Member assets are parsed with `ImageLoader` by default, and additional loaders passed to top-level `load()` are also available for manifest members.

‎docs/modules/textures/api-reference/radiance-hdr-loader.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Loader for Radiance RGBE `.hdr` textures.
88

99
See also: [`Radiance HDR`](/docs/modules/textures/formats/hdr)
1010

11-
| Loader | Characteristic |
12-
| -------------- | ----------------------------------------------------------- |
13-
| File Format | Radiance HDR / RGBE |
14-
| File Extension | `.hdr` |
15-
| File Type | Binary |
16-
| Data Format | [`Texture`](/docs/modules/textures/README#texture-category) |
17-
| Supported APIs | `load`, `parse`, `parseSync` |
11+
| Loader | Characteristic |
12+
| -------------- | ---------------------------------------------------- |
13+
| File Format | Radiance HDR / RGBE |
14+
| File Extension | `.hdr` |
15+
| File Type | Binary |
16+
| Data Format | [`Texture`](/docs/modules/textures#texture-category) |
17+
| Supported APIs | `load`, `parse`, `parseSync` |
1818

1919
## Usage
2020

‎docs/modules/textures/api-reference/texture-array-loader.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
A loader for texture arrays described by a JSON manifest.
88

9-
| Loader | Characteristic |
10-
| -------------- | ----------------------------------------------------------- |
11-
| File Format | JSON manifest |
12-
| File Extension | `.json` |
13-
| File Type | Text |
14-
| Data Format | [`Texture`](/docs/modules/textures/README#texture-category) |
15-
| Supported APIs | `load`, `parse` |
9+
| Loader | Characteristic |
10+
| -------------- | ---------------------------------------------------- |
11+
| File Format | JSON manifest |
12+
| File Extension | `.json` |
13+
| File Type | Text |
14+
| Data Format | [`Texture`](/docs/modules/textures#texture-category) |
15+
| Supported APIs | `load`, `parse` |
1616

1717
## Usage
1818

0 commit comments

Comments
 (0)