Class WasmOutputSettings | Platforms Web | 0.8.0-preview.7
docs.unity3d.com
    Show / Hide Table of Contents

    Class WasmOutputSettings

    Inheritance
    Object
    WasmOutputSettings
    Namespace: Unity.Build.Web.DotsRuntime
    Syntax
    public class WasmOutputSettings : IDotsRuntimeBuildModifier, IBuildComponent

    Fields

    EmbedCpuProfiler

    Declaration
    [Tooltip("If enabled, the generated build will embed an ad hoc CPU frame rate counter and a frame time profiling graph. CPU profiling incurs a small performance overhead.")]
    public bool EmbedCpuProfiler
    Field Value
    Type Description
    Boolean

    EmbedMemoryProfiler

    Declaration
    [Tooltip("If enabled, the generated build will embed an ad hoc Wasm heap memory usage profiler. Use this for advanced memory debugging from Wasm heap perspective. Memory profiling incurs a large performance overhead.")]
    public bool EmbedMemoryProfiler
    Field Value
    Type Description
    Boolean

    EmitRuntimeAllocationDebugChecks

    Declaration
    [Tooltip("If enabled, the generated build will be annotated for validity of low-level memory allocation operations. Enable to track sources of memory allocation and buffer overrun corruptions. Incurs a large performance overhead.")]
    public bool EmitRuntimeAllocationDebugChecks
    Field Value
    Type Description
    Boolean

    EmitRuntimeMemoryDebugChecks

    Declaration
    [Tooltip("If enabled, the generated build will be annotated for validity of low-level memory load and store operations. Enable to track sources of memory access corruptions. Incurs a large performance overhead.")]
    public bool EmitRuntimeMemoryDebugChecks
    Field Value
    Type Description
    Boolean

    IncludeSymbolsForBrowserCallstacks

    Declaration
    [Tooltip("If enabled, the generated .wasm file will retain function name information, to be able to see proper callstack names in the browser, and for profiling and debugging in Browser Devtools. Enabling symbols carries a lare size increase, so remember to disable this when shipping!")]
    public bool IncludeSymbolsForBrowserCallstacks
    Field Value
    Type Description
    Boolean

    MinifyHTMLFile

    Declaration
    [Tooltip("If enabled, the generated .html file will be minified for smallest build output. Ignored in Debug and Develop builds.")]
    public bool MinifyHTMLFile
    Field Value
    Type Description
    Boolean

    MinifyOutputWithClosure

    Declaration
    [Tooltip("If enabled, Closure compiler is used to minify JavaScript code. This is generally recommended for smallest build output, but it does require carefully adhering to Closure's name minification rules. For more information, refer to https://github.com/google/closure-compiler/. Ignored in Debug and Develop builds.")]
    public bool MinifyOutputWithClosure
    Field Value
    Type Description
    Boolean

    OutputSingleHTMLFile

    Declaration
    [Tooltip("If enabled, Wasm build will generate a single .html file as build output, that embeds HTML, JS, Wasm and Asset data. However, this increases build size and slows down startup, so it is not recommended unless deploying to an environment that requires it.")]
    public bool OutputSingleHTMLFile
    Field Value
    Type Description
    Boolean

    WebTemplateFolder

    Declaration
    [Tooltip("Specifies the location of the web template folder. Specified folder is treated as relative to the project root. If this value is empty, then the default web template will be used.")]
    public string WebTemplateFolder
    Field Value
    Type Description
    String

    Methods

    Modify(JsonObject)

    Declaration
    public void Modify(JsonObject jsonObject)
    Parameters
    Type Name Description
    Unity.Serialization.Json.JsonObject jsonObject
    Implements
    IDotsRuntimeBuildModifier.Modify(JsonObject)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023