Class BurstCompilerOptions | Burst | 1.3.9
docs.unity3d.com
    Show / Hide Table of Contents

    Class BurstCompilerOptions

    Options available at Editor time and partially at runtime to control the behavior of the compilation and to enable/disable burst jobs.

    Inheritance
    Object
    BurstCompilerOptions
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Unity.Burst
    Syntax
    public sealed class BurstCompilerOptions

    Properties

    DisableOptimizations

    This property is no longer used and will be removed in a future major release.

    Declaration
    [Obsolete("This property is no longer used and will be removed in a future major release")]
    public bool DisableOptimizations { get; set; }
    Property Value
    Type Description
    Boolean

    EnableBurstCompilation

    Gets or sets a boolean to enable or disable compilation of burst jobs.

    Declaration
    public bool EnableBurstCompilation { get; set; }
    Property Value
    Type Description
    Boolean

    EnableBurstCompileSynchronously

    Gets or sets a boolean to force the compilation of all burst jobs synchronously.

    Declaration
    public bool EnableBurstCompileSynchronously { get; set; }
    Property Value
    Type Description
    Boolean
    Remarks

    This is only available at Editor time. Does not have an impact on player mode.

    EnableBurstDebug

    Declaration
    public bool EnableBurstDebug { get; set; }
    Property Value
    Type Description
    Boolean

    EnableBurstSafetyChecks

    Gets or sets a boolean to enable or disable safety checks.

    Declaration
    public bool EnableBurstSafetyChecks { get; set; }
    Property Value
    Type Description
    Boolean
    Remarks

    This is only available at Editor time. Does not have an impact on player mode.

    EnableFastMath

    This property is no longer used and will be removed in a future major release. Use the [BurstCompile(FloatMode = FloatMode.Fast)] on the method directly to enable this feature

    Declaration
    [Obsolete("This property is no longer used and will be removed in a future major release. Use the [BurstCompile(FloatMode = FloatMode.Fast)] on the method directly to enable this feature")]
    public bool EnableFastMath { get; set; }
    Property Value
    Type Description
    Boolean

    IsEnabled

    Gets a boolean indicating whether burst is enabled.

    Declaration
    public bool IsEnabled { get; }
    Property Value
    Type Description
    Boolean
    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