Class BurstCompileAttribute
This attribute is used to tag jobs or function-pointers as being Burst compiled, and optionally set compilation parameters.
Inherited Members
Namespace: Unity.Burst
Assembly: Unity.Burst.dll
Syntax
[AttributeUsage(AttributeTargets.Assembly|AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Method)]
public class BurstCompileAttribute : Attribute
Constructors
Name | Description |
---|---|
BurstCompileAttribute() | Tags a struct/method/class as being Burst compiled, with the default FloatPrecision, FloatMode and CompileSynchronously. |
BurstCompileAttribute(FloatPrecision, FloatMode) | Tags a struct/method/class as being Burst compiled, with the specified FloatPrecision and FloatMode. |
Properties
Name | Description |
---|---|
CompileSynchronously | Gets or sets whether or not to Burst compile the code immediately on first use, or in the background over time. |
Debug | Gets or sets whether to compile the code in a way that allows it to be debugged.
If this is set to |
DisableDirectCall | Gets or sets a boolean to disable the translation of a static method call as direct call to the generated native method. By default, when compiling static methods with Burst and calling them from C#, they will be translated to a direct call to the Burst generated method. code. |
DisableSafetyChecks | Gets or sets whether to disable safety checks for the current job or function pointer.
If this is set to |
FloatMode | Gets or sets the float mode of operation for this Burst compilation. |
FloatPrecision | Gets or sets the floating point precision to use for this Burst compilation. Allows you to trade accuracy for speed of computation, useful when you don't require much precision. |
OptimizeFor | How should this entry-point be optimized. |