Version: 2022.3
Language : English
Interaction with browser scripting
Memory in Unity WebGL

WebGL native plug-ins for Emscripten

Unity uses the Emscripten compiler toolchain to cross-compile the Unity runtime code written in C and C++ into WebAssembly (also called Wasm). Emscripten generates small code, is load-time and memory efficient, and aims to deliver close to native speed execution. For more information about Wasm in Unity, refer to the WebAssembly is here blog post.

Unity uses IL2CPPA Unity-developed scripting back-end which you can use as an alternative to Mono when building projects for some platforms. More info
See in Glossary
to convert the .NET game code in your C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary
to Wasm. IL2CPP takes .NET bytecode and converts it to corresponding C++ source files, which is then compiled using Emscripten to convert your scripts to Wasm.

Targeted versions

Unity bundles the Emscripten compiler with the WebGLA JavaScript API that renders 2D and 3D graphics in a web browser. The Unity WebGL build option allows Unity to publish content as JavaScript programs which use HTML5 technologies and the WebGL rendering API to run Unity content in a web browser. More info
See in Glossary
platform package, so that you don’t have to manually download it. The version of Emscripten that the Editor uses varies by Editor version:

Unity Version Emscripten version Supported native plug-inA set of code created outside of Unity that creates functionality in Unity. There are two kinds of plug-ins you can use in Unity: Managed plug-ins (managed .NET assemblies created with tools like Visual Studio) and Native plug-ins (platform-specific native code libraries). More info
See in Glossary
file formats
Unity 2022.2 and later Emscripten 3.1.8-unity .a, .bc
Unity 2021.2 and later Emscripten 2.0.19.6-unity .a, .bc
Unity 2019.2 to 2021.2 1.38.11-unity .bc
Unity 2018.4 up until Unity 2019.2 1.37.40-unity .bc
Unity 2018.2 up until Unity 2018.4 1.37.33-unity .bc

Notes:

  • The following list provides expansion for the acronyms of file formats listed in the above table:

    • GNU archive file format (.a)
    • WebAssembly Object Files (.o)
    • LLVM Bitcode file format (.bc)
  • With Emscripten versions before Emscripten 2.0, Unity recommends building Bitcode plug-ins (files of type .bc). From Emscripten 2.0 onwards, Unity recommends to build Wasm Object File plug-ins that are Wasm object files of type .o, bundled into GNU archive files of type .a.

You can determine the path to the exact version of Emscripten toolchain from the emscripten-version.txt located at:

C:\Program Files\Unity\Hub\Editor\<Editor version>\Editor\Data\PlaybackEngines\WebGLSupport\BuildTools\Emscripten\emscripten\emscripten-version.txt

Compile native plug-ins with Emscripten

If you’re creating native C/C++ plug-ins for your Unity application, you can either bundle the C/C++ code with your project (see Native plug-insA platform-specific native code library that is created outside of Unity for use in Unity. Allows you can access features like OS calls and third-party code libraries that would otherwise not be available to Unity. More info
See in Glossary
) or build the native code to a plug-in archive ahead of time with the Emscripten compiler toolchain.

If you choose to build plug-in code in advance, you should use the Emscripten compiler toolchain. To ensure LLVM binary format compatibility, the version of Emscripten that’s used to compile the plug-ins must match the version of Emscripten that Unity uses.

Typically, plug-ins are compiled to a static library archive format. For versions before Unity 2021.2 (Emscripten 2.0), LLVM Bitcode file format (.bc) is the preferred plug-in format.

From Unity 2021.2, the preferred plug-in format is GNU archive file format (.a) that contain WebAssembly Object Files (.o). Although, earlier LLVM Bitcode .bc plug-in files are still supported, using them might have a negative impact to compilation times.

Note: When migrating a native plugin from one Unity version to a version that uses a different version of Emscripten, Unity recommends to recompile the Unity plug-in from source, because the LLVM compiler project doesn’t guarantee binary compatibility of build artifact files across compiler versions.

Additional resources:

Interaction with browser scripting
Memory in Unity WebGL
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961