Merge pull request #53 from Devon7925/update-playground

Update slang playground version

Author: natevm

.github/workflows/build-vsix.yml

@@ -3,6 +3,8 @@ name: Build VSIX
 on:
   push:
     branches: [ main ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
   build:

client/src/nativeClientMain.ts

@@ -87,13 +87,25 @@ export async function activate(context: ExtensionContext) {
 		workspace.registerTextDocumentContentProvider('slang-synth', synthCodeProvider)
 	);
 
-	// Initialize language server options, including the implicit playground.slang file.
-	const playgroundUri = vscode.Uri.file(path.join(context.extensionPath, 'external', 'slang-playground', 'engine', 'slang-compilation-engine', 'src', 'slang', 'playground.slang'));
-	const playgroundDocument = await vscode.workspace.openTextDocument(playgroundUri);
+	// Initialize language server options, including the implicit playground.slang file and other embedded slang files.
+	const slangDir = path.join(context.extensionPath, 'external', 'slang-playground', 'engine', 'slang-compilation-engine', 'src', 'slang');
+	let embeddedSlangFiles: { uri: string, content: string }[] = [];
+	if (fs.existsSync(slangDir)) {
+		const names = fs.readdirSync(slangDir);
+		for (const name of names) {
+			if(!name.endsWith(".slang")) continue;
+			const fileUri = vscode.Uri.file(path.join(slangDir, name));
+			const fileDocument = await vscode.workspace.openTextDocument(fileUri);
+			embeddedSlangFiles.push({ uri: fileUri.toString(), content: fileDocument.getText() });
+		}
+	}
 	const initializationOptions: ServerInitializationOptions = {
 		extensionUri: context.extensionUri.toString(true),
 		workspaceUris: vscode.workspace.workspaceFolders ? vscode.workspace.workspaceFolders.map(folder => folder.uri.fsPath) : [],
-		files: [... await getSlangFilesWithContents(), {uri: playgroundUri.toString(), content: playgroundDocument.getText() }]
+		files: [
+			... await getSlangFilesWithContents(),
+			...embeddedSlangFiles
+		]
 	}
 	worker = new Worker(path.join(context.extensionPath, 'server', 'dist', 'nativeServerMain.js'), {
 		workerData: initializationOptions

client/src/sharedClient.ts

@@ -9,8 +9,8 @@ function getSlangLogChannel(): vscode.OutputChannel {
 	return slangLogChannel;
 }
 
-import type { CompiledPlayground, CompileRequest, EntrypointsRequest, EntrypointsResult, PlaygroundMessage, Result, Shader, UniformController } from 'slang-playground-shared';
-import { isControllerRendered, RUNNABLE_ENTRY_POINT_NAMES } from "slang-playground-shared";
+import type { CompiledPlayground, CompileRequest, EntrypointsRequest, EntrypointsResult, PlaygroundMessage, Result, Shader } from 'slang-playground-shared';
+import { isControllerRendered } from "slang-playground-shared";
 
 // Maps to track open panels by file URI and command type
 const playgroundPanels = new Map<string, vscode.WebviewPanel>();
@@ -82,17 +82,11 @@ export async function sharedActivate(context: ExtensionContext, slangHandler: Sl
 		commands.registerCommand('slang.playgroundRun', async () => {
 			const userSource = window.activeTextEditor.document.getText();
 			const userURI = window.activeTextEditor.document.uri;
-			const shaderType = checkShaderType(userSource);
-			if (shaderType == null) {
-				vscode.window.showErrorMessage("Error: In order to run the shader, please define either imageMain or printMain function in the shader code.");
-				return;
-			}
 			const compileResult = await slangHandler.compilePlayground({
 				target: "WGSL",
-				entrypoint: shaderType,
+				entrypoint: null,
 				sourceCode: userSource,
 				shaderPath: window.activeTextEditor.document.uri.toString(false),
-				noWebGPU: false,
 				uri: userURI.toString(),
 			});
 			if (compileResult.succ == false) {
@@ -126,7 +120,7 @@ export async function sharedActivate(context: ExtensionContext, slangHandler: Sl
 			panel.onDidDispose(() => playgroundPanels.delete(playgroundKey));
 			panel.webview.html = getWebviewContent(context, panel, 'client/dist/webviewBundle.js', 'client/dist/webviewBundle.css');
 
-			if (shaderType === 'printMain') {
+			if (compilation.outputTypes.includes("printing")) {
 				const outputKey = userURI.toString() + ':output';
 				if (outputPanels.has(outputKey)) {
 					try { outputPanels.get(outputKey)!.dispose(); } catch { }
@@ -210,7 +204,7 @@ export async function sharedActivate(context: ExtensionContext, slangHandler: Sl
 
 	function updateContext(editor: vscode.TextEditor | undefined) {
 		const text = editor?.document.getText() || "";
-		const shouldShow = text.match("void\\s+printMain\\s*\\(") != null || text.match("float4\\s+imageMain\\s*\\(") != null;
+		const shouldShow = text.match("import playground;") != null;
 		vscode.commands.executeCommand('setContext', 'isPlaygroundFile', shouldShow);
 	}
 
@@ -257,10 +251,14 @@ export async function sharedActivate(context: ExtensionContext, slangHandler: Sl
 			entrypoint: selectedEntrypoint,
 			sourceCode: userSource,
 			shaderPath: window.activeTextEditor.document.uri.toString(false),
-			noWebGPU: true,
 		});
 		if (compilationResult.succ == false) {
+			const logChannel = getSlangLogChannel();
 			vscode.window.showErrorMessage(compilationResult.message);
+			if (compilationResult.log) {
+				logChannel.appendLine(compilationResult.log);
+				logChannel.show(true);
+			}
 			return;
 		}
 		const shader = compilationResult.result;
@@ -282,10 +280,14 @@ export async function sharedActivate(context: ExtensionContext, slangHandler: Sl
 			entrypoint: "",
 			sourceCode: userSource,
 			shaderPath: window.activeTextEditor.document.uri.toString(false),
-			noWebGPU: true,
 		});
 		if (compilationResult.succ == false) {
+			const logChannel = getSlangLogChannel();
 			vscode.window.showErrorMessage(compilationResult.message);
+			if (compilationResult.log) {
+				logChannel.appendLine(compilationResult.log);
+				logChannel.show(true);
+			}
 			return;
 		}
 		const shader = compilationResult.result;
@@ -345,15 +347,3 @@ export async function sharedActivate(context: ExtensionContext, slangHandler: Sl
 	</html>
 `;
 }
-
-export function checkShaderType(userSource: string) {
-    // we did a pre-filter on the user input source code.
-    let shaderTypes = RUNNABLE_ENTRY_POINT_NAMES.filter((entryPoint) => userSource.includes(entryPoint));
-
-    // Only one of the main function should be defined.
-    // In this case, we will know that the shader is not runnable, so we can only compile it.
-    if (shaderTypes.length !== 1)
-        return null;
-
-    return shaderTypes[0];
-}

external/slang-playground

@@ -5,7 +5,7 @@ No data is sent to any server.
 
 ## Compiling Shaders (the "Compile" button)
 
-You can compile shaders to many targets supported by Slang here, including SPIR-V, HLSL, GLSL, Metal, and
+You can compile shaders to many targets supported by Slang here, including SPIR-V, HLSL, GLSL, Metal, CUDA, and
 WGSL.
 Generating DXIL requires DXC, which doesn't run in the browser so it's not supported here. You will have the opportunuty to select entrypoints for targets that don't support multiple entrypoints.
 You can compile shaders with either the button in the top right of the editor, or the command `Slang Compile`.
@@ -14,13 +14,36 @@ You can compile shaders with either the button in the top right of the editor, o
 
 In addition to compiling shaders, this playground extension can also run simple shaders via WebGPU.
 You can run shaders with either the button in the top right of the editor, or the command `Run Playground`.
-The playground supports running two types of shaders:
+The playground supports running compute shaders that produce an image, text output, or both. All runnable shaders must be compute shaders marked with the `[shader("compute")]` attribute. You can use `import rendering` or `import printing` to display shader results.
 
-* **Image Compute Shader**: This is a compute shader that returns a pixel value at a given image
-    coordinate, similar to ShaderToys.
-    An image compute shader must define a `float4 imageMain(uint2 dispatchThreadID, int2 screenSize)` function.
-* **Print Shader**: This is a shader that prints text to the output pane.
-    A print shader must define a `void printMain()` function.
+### Rendering
+
+The `rendering` module provides the following function:
+
+`void drawPixel(uint2 location, IFunc<float4, int2> renderFunction)`
+
+This will render to the output at the provided location based on the result of the provided function. The provided function takes in the screen size as an `int2`. It also creates an `outputTexture` texture, so you can create an entrypoint that executes for every pixel like so:
+
+```slang
+import playground;
+import rendering;
+
+[shader("compute")]
+[numthreads(16, 16, 1)]
+[playground::CALL::SIZE_OF("outputTexture")]
+void imageMain(uint2 dispatchThreadID: SV_DispatchThreadID)
+{
+    drawPixel(dispatchThreadID, (int2 _) => float4(0.3, 0.7, 0.55, 1.0));
+}
+```
+
+### Printing
+
+The `printing` module provides the following function:
+
+### `void printf<T>(String format, expand each T values) where T : IPrintf`
+
+Prints the values formatted according to the format.
 
 ## Shader Commands
 
@@ -54,6 +77,10 @@ Initialize a `float` buffer with uniform random floats between 0 and 1.
 
 Gives a `float` uniform the current time in milliseconds.
 
+### `[playground::FRAME_ID]`
+
+Gives a `float` uniform the current frame index (starting from 0).
+
 ### `[playground::MOUSE_POSITION]`
 
 Gives a `float4` uniform mouse data.
@@ -85,17 +112,13 @@ Dispatch a compute pass using the resource size to determine the work-group size
 Dispatch a compute pass with the given grid of threads.
 The number of work-groups will be determined by dividing by the number of threads per work-group and rounding up.
 
-### `[playground::CALL::ONCE]`
-
-Only dispatch the compute pass once at the start of rendering. Should be used in addition to another CALL command.
+### `[playground::CALL_INDIRECT("BUFFER-NAME", 0)]`
 
-## Playground functions
+Dispatch a compute pass with an indirect command buffer and an offset in bytes.
 
-The playground shader also provides the following functions:
-
-### `void printf<T>(String format, expand each T values) where T : IPrintf`
+### `[playground::CALL::ONCE]`
 
-Prints the values formatted according to the format. Only available in print shaders.
+Only dispatch the compute pass once at the start of rendering. Should be used in addition to another CALL command.
 
 ## Shader Reflection