17003106d2
This adds a few new functions to the JavaScript bindings. It also adds our JavaScript docs into the CMake build system for machines that meet the Python requirements.
105 lines
4.4 KiB
JavaScript
105 lines
4.4 KiB
JavaScript
/*
|
|
* Copyright (C) 2018 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/*
|
|
* WHY DOES THIS FILE EXIST?
|
|
* -------------------------
|
|
*
|
|
* For each generated wasm file, emscripten generates a corollary JS file that is used to load the
|
|
* wasm and set up its imports / exports. This file is a hand-authored addendum to the JS file that
|
|
* emscripten generates, and we use it to store JavaScript-side utilities such as the asset
|
|
* downloader and BufferDescriptor wrapper.
|
|
*
|
|
* Note that we should avoid certain modern JavaScript features in this file (e.g., for-of loops)
|
|
* because emscripten uses a fairly rusty minifier.
|
|
*/
|
|
|
|
// Keep a counter of remaining asynchronous tasks (e.g., downloading assets) that must occur before
|
|
// allowing the app to initialize. As soon as the counter hits zero, we know it is time to call the
|
|
// app's onready callback. There is always at least 1 initialization task for loading the WASM
|
|
// module.
|
|
Filament.remainingInitializationTasks = 1;
|
|
|
|
/// init ::function:: Downloads assets, loads the Filament module, and invokes a callback when done.
|
|
///
|
|
/// All JavaScript clients must call the init function, passing in a list of asset URL's and a
|
|
/// callback. This callback gets invoked only after all assets have been downloaded and the Filament
|
|
/// WebAssembly module has been loaded. Clients should only pass asset URL's that absolutely must
|
|
/// be ready at initialization time.
|
|
///
|
|
/// When the callback is called, each downloaded asset is available in the `Filament.assets` global
|
|
/// object, which contains a mapping from URL's to Uint8Array objects.
|
|
///
|
|
/// assets ::argument:: Array of strings containing URL's of required assets.
|
|
/// onready ::argument:: callback that gets invoked after all assets have been downloaded and the \
|
|
/// Filament WebAssembly module has been loaded.
|
|
Filament.init = function(assets, onready) {
|
|
Filament.onReady = onready;
|
|
Filament.remainingInitializationTasks += assets.length;
|
|
Filament.assets = {};
|
|
|
|
// Usage of glmatrix is optional. If it exists, then go ahead and augment it with some
|
|
// useful math functions.
|
|
if (typeof glMatrix !== 'undefined') {
|
|
Filament.loadMathExtensions();
|
|
}
|
|
|
|
// Issue a fetch for each asset. After the last asset is downloaded, trigger the callback.
|
|
assets.forEach(function(name) {
|
|
fetch(name).then(function(response) {
|
|
if (!response.ok) {
|
|
throw new Error(name);
|
|
}
|
|
return response.arrayBuffer();
|
|
}).then(function(arrayBuffer) {
|
|
Filament.assets[name] = new Uint8Array(arrayBuffer);
|
|
if (--Filament.remainingInitializationTasks === 0) {
|
|
Filament.onReady();
|
|
}
|
|
});
|
|
});
|
|
};
|
|
|
|
// The postRun method is called by emscripten after it finishes compiling and instancing the
|
|
// WebAssembly module. The JS classes that correspond to core Filament classes (e.g., Engine)
|
|
// are not guaranteed to exist until this function is called.
|
|
Filament.postRun = function() {
|
|
Filament.loadClassExtensions();
|
|
if (--Filament.remainingInitializationTasks == 0 && Filament.onReady) {
|
|
Filament.onReady();
|
|
}
|
|
};
|
|
|
|
/// fetch ::function:: Downloads assets and invokes a callback when done.
|
|
/// assets ::argument:: Array of strings containing URL's of required assets.
|
|
/// onready ::argument:: callback that gets invoked after all assets have been downloaded.
|
|
Filament.fetch = function(assets, onDone) {
|
|
var remainingAssets = assets.length;
|
|
assets.forEach(function(name) {
|
|
fetch(name).then(function(response) {
|
|
if (!response.ok) {
|
|
throw new Error(name);
|
|
}
|
|
return response.arrayBuffer();
|
|
}).then(function(arrayBuffer) {
|
|
Filament.assets[name] = new Uint8Array(arrayBuffer);
|
|
if (--remainingAssets === 0) {
|
|
onDone();
|
|
}
|
|
});
|
|
});
|
|
};
|