How does CrossShader compare to SPIRV-Cross for shader conversion?

CrossShader wraps SPIRV-Cross along with other compilers, providing a unified interface for multiple languages, but SPIRV-Cross might offer more direct control for SPIR-V specific tasks. CrossShader is better for projects needing conversions across all supported languages without switching tools.

How to convert an HLSL shader to Metal using CrossShader in Node.js?

Set the input format to HLSL and output format to Metal in the configuration options, then pass the shader code to the compile function. Refer to the TypeScript types for exact parameter settings, ensuring you specify the correct shader stage and versions as shown in the examples.

Does CrossShader support compute shaders?

Yes, based on the ShaderStage enum in the README, it likely supports various stages including compute, but you need to set the stage appropriately in the input options. Check the provided enums for details on supported shader types.

What are the error messages like in CrossShader?

CrossShader throws exceptions with descriptive error messages when compilation fails, which are exposed in the exception object. This helps in debugging shader issues by providing insights from the underlying compilers, as mentioned in the error handling feature.

Can I use CrossShader without CMake in a C++ project?

The README specifies using CMake for building the C++ library, so it's designed around CMake. For non-CMake projects, you might need to manually integrate the source files and dependencies, which could be challenging and unsupported.

Is CrossShader suitable for real-time shader compilation in games?

While it can be used for offline conversion, the abstraction layer and WebAssembly usage might introduce overhead, making it less ideal for real-time compilation compared to native compiler integration. Performance-critical applications should test thoroughly.

Open-Awesome

CrossShader

MITC++

A cross-compiler for shader languages, converting between SPIR-V, GLSL, HLSL, and Metal Shader Language.

Visit Website GitHub

309 stars13 forks0 contributors

What is CrossShader?

CrossShader is a cross-compiler for shader languages that enables developers to convert shader code between SPIR-V, GLSL, HLSL, and Metal Shader Language. It solves the problem of maintaining multiple shader versions for different graphics APIs and platforms by providing a unified transpilation tool.

Target Audience

Graphics programmers, game developers, and engine developers who need to target multiple rendering backends (e.g., Vulkan, DirectX, OpenGL, Metal) from a single shader codebase.

Value Proposition

Developers choose CrossShader because it wraps several low-level compiler tools into a simple, consistent API, reducing the complexity of shader cross-compilation and saving time when porting graphics applications across platforms.

Overview

⚔️ A tool for cross compiling shaders. Convert between GLSL, HLSL, Metal Shader Language, or older versions of GLSL.

Use Cases

Best For

Porting OpenGL shaders to Vulkan via SPIR-V
Converting HLSL shaders for use in Metal on macOS/iOS
Downgrading GLSL shaders for older GPU compatibility
Building graphics engines that support multiple rendering APIs
Automating shader pipeline conversions in build systems
Developing cross-platform games with a single shader source

Not Ideal For

Projects requiring direct, low-level control over compiler-specific features and optimizations
Applications targeting only a single graphics API where cross-compilation is unnecessary
Real-time shader compilation in performance-critical loops where abstraction overhead matters
Environments without WebAssembly support or with strict native compilation requirements

Pros & Cons

Pros

Multi-Language Support

Converts between SPIR-V, GLSL, HLSL, and Metal Shader Language by wrapping established compilers like DirectX Shader Compiler and glslang, eliminating the need to manage multiple tools separately.

Unified API

Exposes a single `compile` function with simple configuration structs, abstracting the complexity of underlying compilers and making shader transpilation straightforward.

Cross-Platform Availability

Available as both a Node.js module (using WebAssembly) and a C++ library, catering to web and native development environments, as shown in the installation examples.

Version Targeting

Allows compiling to specific language versions, such as downgrading GLSL from 450 to 100 for older GPU compatibility, demonstrated in the usage code snippets.

Cons

Complex C++ Setup

Requires CMake and managing git submodules, which can be cumbersome and error-prone compared to simpler dependency management, as highlighted in the installation instructions.

Dependency on External Compilers

Relies on tools like DirectX Shader Compiler and glslang, so bugs or updates in these compilers might not be immediately reflected, potentially causing compatibility issues.

WebAssembly Limitations

The Node.js version depends on WebAssembly, which may not be supported in all environments and adds abstraction that could affect performance or portability.

Frequently Asked Questions

Related Projects

SHADERed

Lightweight, cross-platform & full-featured shader IDE

Stars4,801

Forks316

Last commit3 years ago

Shader Park

A JavaScript library for creating real-time 2D and 3D shaders. JS -> Shader. https://shaderpark.com/ https://twitter.com/shaderpark

GLSL procedural noise functions compatible with WebGL

Stars592

Forks38

Last commit1 year ago

Psrdnoise

Tiling simplex flow noise in 2-D and 3-D compatible with GLSL 1.20 (WebGL 1.0) and above.

Stars327

Forks17