API
API|
@babylonjs/core|
DracoCompression

Class DracoCompression

Draco compression (https://google.github.io/draco/)

This class wraps the Draco module.

Encoder

The encoder is not currently implemented.

Decoder

By default, the configuration points to a copy of the Draco decoder files for glTF from the babylon.js cdn https://cdn.babylonjs.com/draco_wasm_wrapper_gltf.js. The configuration is shared with the DracoDecoder class.

To update the configuration, use the following code:

    DracoCompression.Configuration = {
        decoder: {
            wasmUrl: "<url to the WebAssembly library>",
            wasmBinaryUrl: "<url to the WebAssembly binary>",
            fallbackUrl: "<url to the fallback JavaScript library>",
        }
    };

Draco has two versions, one for WebAssembly and one for JavaScript. The decoder configuration can be set to only support WebAssembly or only support the JavaScript version. Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser. Use DracoCompression.DecoderAvailable to determine if the decoder configuration is available for the current context.

To decode Draco compressed data, get the default DracoCompression object and call decodeMeshToGeometryAsync:

    var geometry = await DracoCompression.Default.decodeMeshToGeometryAsync(data);

https://playground.babylonjs.com/#DMZIBD#0

Index
constructor
DefaultNumWorkers
Configuration DecoderAvailable Default
decodeMeshAsync decodeMeshToGeometryAsync decodeMeshToMeshDataAsync dispose whenReadyAsync ResetDefault
DefaultNumWorkers: number = ...

Default number of workers to create when creating the draco compression object.

  • Decode Draco compressed mesh data to Babylon vertex data.

    Parameters

    • data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>

      The ArrayBuffer or ArrayBufferView for the Draco compression data

    • Optionalattributes: { [kind: string]: number }

      A map of attributes from vertex buffer kinds to Draco unique ids

    Returns Promise<VertexData>

    A promise that resolves with the decoded vertex data

    Use decodeMeshToGeometryAsync for better performance in some cases

  • Decode Draco compressed mesh data to Babylon geometry.

    Parameters

    • name: string

      The name to use when creating the geometry

    • scene: Scene

      The scene to use when creating the geometry

    • data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>

      The ArrayBuffer or ArrayBufferView for the Draco compression data

    • Optionalattributes: { [kind: string]: number }

      A map of attributes from vertex buffer kinds to Draco unique ids

    Returns Promise<Geometry>

    A promise that resolves with the decoded geometry

  • Decode Draco compressed mesh data to mesh data.

    Parameters

    • data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>

      The ArrayBuffer or ArrayBufferView for the Draco compression data

    • Optionalattributes: { [kind: string]: number }

      A map of attributes from vertex buffer kinds to Draco unique ids

    • OptionalgltfNormalizedOverride: { [kind: string]: boolean }

      A map of attributes from vertex buffer kinds to normalized flags to override the Draco normalization

    Returns Promise<MeshData>

    A promise that resolves with the decoded mesh data

  • Reset the default draco compression object to null and disposing the removed default instance. Note that if the workerPool is a member of the static Configuration object it is recommended not to run dispose, unless the static worker pool is no longer needed.

    Parameters

    • OptionalskipDispose: boolean

      set to true to not dispose the removed default instance

    Returns void