WebIO
Hierarchy
- PlatformIO
- WebIO
Constructor
Constructs a new WebIO service. Instances are reusable.
Properties
Methods
Converts a GLB-formatted Uint8Array to a JSONDocument.
Sets the Logger used by this I/O instance. Defaults to Logger.DEFAULT_INSTANCE.
Reads a Document from the given URI.
Loads a URI and returns a JSONDocument struct, without parsing.
Converts a GLB-formatted Uint8Array to a Document.
Converts glTF-formatted JSON and a resource map to a Document.
Registers dependencies used (e.g. by extensions) in the I/O process.
Registers extensions, enabling I/O class to read and write glTF assets requiring them.
Sets the vertex layout method used by this I/O instance. Defaults to VertexLayout.INTERLEAVED.
Converts a Document to a GLB-formatted Uint8Array.
Converts a Document to glTF-formatted JSON and a resource map.
Made by Don McCurdy. Documentation built with greendoc and published under Creative Commons Attribution 3.0.
I/O service for Web.
The most common use of the I/O service is to read/write a Document with a given path. Methods are also available for converting in-memory representations of raw glTF files, both binary (Uint8Array) and JSON (JSONDocument).
Usage:
import { WebIO } from '@gltf-transform/core'; const io = new WebIO({credentials: 'include'}); // Read. let document; document = await io.read('model.glb'); // → Document document = await io.readBinary(glb); // Uint8Array → Document // Write. const glb = await io.writeBinary(document); // Document → Uint8Array