Skip to content

Commit af135a4

Browse files
ben-claytonben-clayton
committed
Add Tint compiler and WGSL language
1 parent 5ab8af0 commit af135a4

File tree

11 files changed

+268
-3
lines changed

11 files changed

+268
-3
lines changed

‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@
1616
[submodule "external/clspv/source"]
1717
path = external/clspv/source
1818
url = https://github.com/google/clspv.git
19+
[submodule "external/tint/source"]
20+
path = external/tint/source
21+
url = https://dawn.googlesource.com/tint

‎build.cake

+16
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,22 @@ Task("Build-Clspv")
447447
true);
448448
});
449449

450+
Task("Build-Tint")
451+
.Does(() => {
452+
RunAndCheckResult(MakeAbsolute(File("./external/tint/build.bat")), new ProcessSettings {
453+
WorkingDirectory = MakeAbsolute(Directory("./external/tint"))
454+
});
455+
456+
var binariesFolder = $"./src/ShaderPlayground.Core/Binaries/tint/trunk";
457+
EnsureDirectoryExists(binariesFolder);
458+
CleanDirectory(binariesFolder);
459+
460+
CopyFiles(
461+
"./external/tint/source/build/bin/Release/tint.exe",
462+
binariesFolder,
463+
true);
464+
});
465+
450466
Task("Build-Fxc-Shim")
451467
.Does(() => {
452468
DotNetCorePublish("./shims/ShaderPlayground.Shims.Fxc/ShaderPlayground.Shims.Fxc.csproj", new DotNetCorePublishSettings

‎external/tint/build.bat

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cd source
2+
3+
if NOT EXIST "./scripts/bootstrap.py" (
4+
call git submodule update --init .
5+
)
6+
7+
if NOT EXIST ".gclient" (
8+
copy standalone.gclient .gclient
9+
call gclient sync
10+
)
11+
12+
mkdir build
13+
cd build
14+
15+
cmake .. -DCMAKE_BUILD_TYPE=Release
16+
cmake --build . --config Release

‎external/tint/source

Submodule source added at a388d56

‎src/ShaderPlayground.Core.Tests/CompilerTests.cs

+25
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ float4 PSMain(PSInput input) : SV_TARGET
1515
return input.color;
1616
}";
1717

18+
private const string WglsCode = @"[[location(0)]] var<out> gl_FragColor : vec4<f32>;
19+
[[stage(fragment)]]
20+
fn main() -> void {
21+
var color : vec4<f32> = vec4<f32>(0.1, 0.2, 0.3, 1.0);
22+
gl_FragColor = color;
23+
return;
24+
}";
25+
1826
[Fact]
1927
public void CanCompileHlslToDxbcUsingFxc()
2028
{
@@ -128,5 +136,22 @@ public void CanPipeHlslToSpirVToMali()
128136
Assert.Null(result.Outputs[0].Language);
129137
Assert.Equal(663, result.Outputs[0].Value.Length);
130138
}
139+
140+
[Fact]
141+
public void CanCompileWsglToSpirv()
142+
{
143+
var result = Compiler.Compile(
144+
new ShaderCode(LanguageNames.Wgsl, WglsCode),
145+
new CompilationStep(
146+
CompilerNames.Tint,
147+
new Dictionary<string, string>
148+
{
149+
{ "ShaderStage", "fragment" },
150+
{ "OutputLanguage", LanguageNames.SpirV },
151+
{ "Version", "trunk" },
152+
}))[0];
153+
154+
Assert.True(result.Success);
155+
}
131156
}
132157
}

‎src/ShaderPlayground.Core/Compiler.cs

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
using ShaderPlayground.Core.Compilers.SpirVCross;
2222
using ShaderPlayground.Core.Compilers.SpirVCrossIspc;
2323
using ShaderPlayground.Core.Compilers.SpirvTools;
24+
using ShaderPlayground.Core.Compilers.Tint;
2425
using ShaderPlayground.Core.Compilers.XShaderCompiler;
2526
using ShaderPlayground.Core.Compilers.Yariv;
2627
using ShaderPlayground.Core.Compilers.Zstd;
@@ -37,6 +38,7 @@ public static class Compiler
3738
new OpenCLCLanguage(),
3839
new SlangLanguage(),
3940
new SpirvLanguage(),
41+
new WgslLanguage(),
4042
};
4143

4244
public static readonly IShaderCompiler[] AllCompilers =
@@ -68,6 +70,7 @@ public static class Compiler
6870
new SpirvStatsCompiler(),
6971
new SpirvToSmolvCompiler(),
7072
new SpirvToYarivCompiler(),
73+
new TintCompiler(),
7174
new YarivToSpirvCompiler(),
7275
new XscCompiler(),
7376
new ZstdCompiler(),

‎src/ShaderPlayground.Core/CompilerNames.cs

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ public static class CompilerNames
2020
public const string SpirvOpt = "spirv-opt";
2121
public const string SpirvRemap = "spirv-remap";
2222
public const string SpirvStats = "spirv-stats";
23+
public const string Tint = "tint";
2324
public const string XShaderCompiler = "xsc";
2425
public const string HlslCc = "hlslcc";
2526
public const string Slang = "slang";

‎src/ShaderPlayground.Core/Compilers/Tint/TintCompiler.cs

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
using ShaderPlayground.Core.Util;
2+
using System;
3+
using System.Collections.Generic;
4+
using System.Text;
5+
6+
namespace ShaderPlayground.Core.Compilers.Tint
7+
{
8+
internal sealed class TintCompiler : IShaderCompiler
9+
{
10+
public string Name { get; } = CompilerNames.Tint;
11+
public string DisplayName { get; } = "tint";
12+
public string Url { get; } = "https://dawn.googlesource.com/tint/";
13+
public string Description { get; } = "WebGPU Shader Language (WGSL) Compiler";
14+
15+
public string[] InputLanguages { get; } =
16+
{
17+
LanguageNames.SpirV,
18+
LanguageNames.SpirvAssembly,
19+
LanguageNames.Wgsl,
20+
};
21+
22+
private static readonly string ShaderStageName = "ShaderStage";
23+
private static readonly string EntryPointName = "EntryPoint";
24+
private static readonly string AllShaderStages = "<all>";
25+
private static readonly string EntryPointDescription = $"Entry point name.\nOnly used when 'Shader stage' is not '{AllShaderStages}'";
26+
27+
public ShaderCompilerParameter[] Parameters { get; } =
28+
{
29+
CommonParameters.CreateVersionParameter("tint"),
30+
new ShaderCompilerParameter(ShaderStageName, "Shader stage", ShaderCompilerParameterType.ComboBox, ShaderStageOptions, defaultValue: AllShaderStages),
31+
new ShaderCompilerParameter(EntryPointName, "Entry Point", ShaderCompilerParameterType.TextBox, defaultValue: "main", description: EntryPointDescription),
32+
CommonParameters.CreateOutputParameter(new[] {
33+
LanguageNames.SpirV,
34+
LanguageNames.SpirvAssembly,
35+
LanguageNames.Wgsl,
36+
LanguageNames.Metal,
37+
LanguageNames.Hlsl
38+
})
39+
};
40+
41+
private static readonly string[] ShaderStageOptions =
42+
{
43+
AllShaderStages,
44+
"compute",
45+
"vertex",
46+
"fragment",
47+
};
48+
49+
public ShaderCompilerResult Compile(ShaderCode shaderCode, ShaderCompilerArguments arguments)
50+
{
51+
var stage = arguments.GetString(ShaderStageName);
52+
var entryPoint = arguments.GetString(EntryPointName);
53+
var outputLanguage = arguments.GetString(CommonParameters.OutputLanguageParameterName);
54+
var exePath = CommonParameters.GetBinaryPath("tint", arguments, "tint.exe");
55+
56+
if (!RunTint(exePath, shaderCode, stage, entryPoint, outputLanguage, out var output, out var error))
57+
{
58+
return ErrorResult(outputLanguage, error);
59+
}
60+
61+
if (outputLanguage == LanguageNames.SpirV)
62+
{
63+
// SPIR-V is currently the only binary format that requires disassembling.
64+
if (!RunTint(exePath, shaderCode, stage, entryPoint, LanguageNames.SpirvAssembly, out var asm, out error))
65+
{
66+
return ErrorResult(outputLanguage, error);
67+
}
68+
return new ShaderCompilerResult(
69+
true,
70+
new ShaderCode(outputLanguage, output),
71+
0,
72+
new ShaderCompilerOutput("Disassembly", outputLanguage, Encoding.ASCII.GetString(asm)),
73+
new ShaderCompilerOutput("Build output", null, ""));
74+
}
75+
else
76+
{
77+
var disassembly = Encoding.ASCII.GetString(output);
78+
return new ShaderCompilerResult(
79+
true,
80+
new ShaderCode(outputLanguage, disassembly),
81+
0,
82+
new ShaderCompilerOutput("Disassembly", outputLanguage, disassembly),
83+
new ShaderCompilerOutput("Build output", null, ""));
84+
}
85+
86+
}
87+
88+
private static ShaderCompilerResult ErrorResult(string outputLanguage, string error)
89+
{
90+
return new ShaderCompilerResult(
91+
false,
92+
new ShaderCode(outputLanguage, (byte[])null),
93+
1,
94+
new ShaderCompilerOutput("Disassembly", outputLanguage, null),
95+
new ShaderCompilerOutput("Build output", null, error));
96+
}
97+
98+
private static bool RunTint(string exePath, ShaderCode code, string stage, string entryPoint, string outputLanguage,
99+
out byte[] output, out string error)
100+
{
101+
var args = new List<string>();
102+
switch (outputLanguage)
103+
{
104+
case LanguageNames.SpirV:
105+
args.Add("--format spirv");
106+
break;
107+
case LanguageNames.SpirvAssembly:
108+
args.Add("--format spvasm");
109+
break;
110+
case LanguageNames.Wgsl:
111+
args.Add("--format wgsl");
112+
break;
113+
case LanguageNames.Metal:
114+
args.Add("--format msl");
115+
break;
116+
case LanguageNames.Hlsl:
117+
args.Add("--format hlsl");
118+
break;
119+
}
120+
121+
if (stage != AllShaderStages)
122+
{
123+
args.Add($"-ep {stage} {entryPoint}");
124+
}
125+
126+
using (var inputFile = TempFile.FromShaderCode(code))
127+
{
128+
var outputFile = $"{inputFile.FilePath}.o";
129+
130+
args.Add($"-o {outputFile}");
131+
args.Add(inputFile);
132+
133+
ProcessHelper.Run(
134+
exePath,
135+
String.Join(" ", args),
136+
out var stdOutput,
137+
out var stdError);
138+
139+
output = FileHelper.ReadAllBytesIfExists(outputFile);
140+
FileHelper.DeleteIfExists(outputFile);
141+
error = stdError;
142+
if (output == null && error == "")
143+
{
144+
error = (stdOutput != "") ? stdOutput : "<no output>";
145+
}
146+
return error == "";
147+
}
148+
}
149+
}
150+
}

‎src/ShaderPlayground.Core/LanguageNames.cs

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ public static class LanguageNames
1616
public const string Smolv = "SMOL-V";
1717
public const string SpirV = "SPIR-V";
1818
public const string SpirvAssembly = "SPIR-V ASM";
19+
public const string Wgsl = "WGSL";
1920
public const string Yariv = "YARI-V";
2021
public const string Zlib = "zlib";
2122
public const string Zstd = "zst";

‎src/ShaderPlayground.Core/Languages/WgslLanguage.cs

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
namespace ShaderPlayground.Core.Languages
2+
{
3+
internal sealed class WgslLanguage : IShaderLanguage
4+
{
5+
public string Name { get; } = LanguageNames.Wgsl;
6+
7+
public string DefaultCode { get; } = DefaultWgslCode;
8+
9+
public string FileExtension { get; } = "wgsl";
10+
11+
private static readonly string DefaultWgslCode = @"# Vertex shader
12+
const pos : array<vec2<f32>, 3> = array<vec2<f32>, 3>(
13+
vec2<f32>( 0.0, 0.5),
14+
vec2<f32>(-0.5, -0.5),
15+
vec2<f32>( 0.5, -0.5)
16+
);
17+
18+
[[builtin(position)]] var<out> Position : vec4<f32>;
19+
[[builtin(vertex_idx)]] var<in> VertexIndex : i32;
20+
21+
[[stage(vertex)]]
22+
fn vtx_main() -> void {
23+
Position = vec4<f32>(pos[VertexIndex], 0.0, 1.0);
24+
return;
25+
}
26+
27+
# Fragment shader
28+
[[location(0)]] var<out> outColor : vec4<f32>;
29+
30+
[[stage(fragment)]]
31+
fn frag_main() -> void {
32+
outColor = vec4<f32>(1.0, 0.0, 0.0, 1.0);
33+
return;
34+
}
35+
";
36+
}
37+
}

‎src/ShaderPlayground.Core/Util/TempFile.cs

+15-3
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,31 @@ public static TempFile FromShaderCode(ShaderCode shaderCode)
2222
default:
2323
throw new InvalidOperationException();
2424
}
25-
25+
2626
return result;
2727
}
2828

2929
private static string GetFileExtension(string language)
3030
{
3131
switch (language)
3232
{
33+
case LanguageNames.Hlsl:
34+
return ".hlsl";
35+
36+
case LanguageNames.Metal:
37+
return ".metal";
38+
39+
case LanguageNames.SpirV:
40+
return ".spv";
41+
42+
case LanguageNames.SpirvAssembly:
43+
return ".spvasm";
44+
3345
case LanguageNames.Slang:
3446
return ".slang";
3547

36-
case LanguageNames.Hlsl:
37-
return ".hlsl";
48+
case LanguageNames.Wgsl:
49+
return ".wgsl";
3850

3951
default:
4052
return ".tmp";

0 commit comments

Comments
 (0)