examples.md

BLAST

Overview - Language Reference - Namespace (doxygen)

See the unity sample directory in the root of this repository for unity sample scenes.

Usage Examples

Single use:

            Blast.InitInstance();
            BlastScript bs = BlastScript.FromText("result = 1 + value;");
            bs["value"] = 2;

            BlastError res = bs.Execute();

            Xunit.Assert.True(bs["result"] == (object)3f);
            Xunit.Assert.True(res == BlastError.success);

Repeated Use:

            Blast.InitInstance();

            // create a script package from text 
            BlastScript bs = BlastScript.FromText("result = 1 + value;");
          
            // prepare it for execution (compiles script package)
            bs.Prepare();

            // run in a loop, using different inputs 
            BlastError res = BlastError.success;
            for (int i = 0; i < 100000 && res == BlastError.success; i++)
            {
                bs["value"] = i;

                res = bs.Execute();
                if (res == BlastError.success)
                {
                    float result = (float)bs["result"];
                }
            }

SSMD | Single Script Multiple Data execution

General use:

        // prepare an ssmd compiled script as:
        // '#input a float4\n#input b float4\n#input c float4\na = a * b + c;'
                
        // a struct mapped to the data used in a script for ease of use
        [Serializable]
        [StructLayout(LayoutKind.Sequential)]
        public struct data
        {
            public float4 a;
            public float4 b;
            public float4 c;
        }
        
        // the processing of some random data 
        NativeArray<data> data_array = new NativeArray<data>(DataCount, Allocator.Persistent);
        {
            for (int i = 0; i < DataCount; i++)
            {
                data_array[i] = new data()
                {
                    a = 100f * i,
                    b = 101f * i,
                    c = 100.1f * i
                };
            }

            // execute the script
            BlastError result = script.Execute(data_array);

            if (result == BlastError.success)
            {
                // show results 
                StringBuilder sb = StringBuilderCache.Acquire();
                for (int i = 0; i < DataCount; i++)
                {
                    sb.AppendLine($"a = {data_array[i].a}");
                }
                DataView = StringBuilderCache.GetStringAndRelease(ref sb);
            }
            else
            {
                DataView = $"Error: {result}, check the logs for more details";
            }
        }
        data_array.Dispose();

Advanced use:

            int n = 1024; 
            using (Blast blast = Blast.Create(Allocator.Persistent))
            {
                BlastScript bs = BlastScript.FromText("result = 1 + value;");
                BlastError res = Blast.Package(blast.Engine, bs, BlastCompilerOptions.SSMD.Trace());

                unsafe
                {
                    // allocate datasegments  
                    byte* data = stackalloc byte[bs.Package.Package.SSMDDataSize * n];
                    BlastSSMDDataStack* ssmd_data = (BlastSSMDDataStack*)(void*)data;

                    // clone default data 
                    bs.Package.Package.CloneDataStack(n, ssmd_data); 

                    // set value (                    
                    for(int i = 0; i < n; i++)
                    {
                        ssmd_data[i].a[0] = i; 
                    }

                    // execute script with n * input data
                    res = blast.Execute(bs.Package.Package, IntPtr.Zero, new IntPtr(ssmd_data), n);
                }
            }