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 preview cdn https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js.

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 Webssembly 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 decodeMeshAsync:

    var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
see

https://www.babylonjs-playground.com/#N3EK4B#0

Hierarchy

  • DracoCompression

Implements

Index

Constructors

constructor

Find examples in Playground
  • Constructor

    Parameters

    • Optional numWorkers: number

      The number of workers for async operations. Specify 0 to disable web workers and run synchronously in the current context.

    Returns DracoCompression

Properties

Static Configuration

Find examples in Playground

Static DecoderAvailable

Find examples in Playground
DecoderAvailable: boolean

Returns true if the decoder configuration is available.

Static Default

Find examples in Playground

Default instance for the draco compression object.

Static DefaultNumWorkers

Find examples in Playground
DefaultNumWorkers: number

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

Methods

decodeMeshAsync

Find examples in Playground
  • decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: object): Promise<VertexData>
  • Decode Draco compressed mesh data to vertex data.

    Parameters

    • data: ArrayBuffer | ArrayBufferView

      The ArrayBuffer or ArrayBufferView for the Draco compression data

    • Optional attributes: object

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

      • [kind: string]: number

    Returns Promise<VertexData>

    A promise that resolves with the decoded vertex data

dispose

Find examples in Playground
  • dispose(): void
  • Stop all async operations and release resources.

    Returns void

whenReadyAsync

Find examples in Playground
  • whenReadyAsync(): Promise<void>
  • Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.

    Returns Promise<void>

    a promise that resolves when ready

Generated using TypeDoc