diff options
| author | Ellie Hermaszewska <ellieh@nvidia.com> | 2024-10-12 04:45:41 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-11 13:45:41 -0700 |
| commit | bba14dc4b443b3be8ccbc3aac3ec44960a87ee51 (patch) | |
| tree | 9e7ef8746753ab0305536ed8d8d7e17f056c86df /README.md | |
| parent | e91e1d4d54a14d985626318e5cf46635bfa4006d (diff) | |
beautify the readme support table (#5265)
Closes https://github.com/shader-slang/slang/issues/3904
Co-authored-by: Yong He <yonghe@outlook.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 30 insertions, 21 deletions
@@ -78,33 +78,42 @@ Limitations and Support The Slang compiler and libraries can be built on the following platforms: -| Windows | Linux | MacOS | WebAssembly | -|:---------------:|:--------------:|:------------:|:--------------------:| -| supported | supported | supported | experimental | +| Windows | Linux | MacOS | WebAssembly | +|:---------:|:---------:|:---------:|:------------:| +| supported | supported | supported | experimental | -Both `x86_64` and `arm64` architectures are supported on Windows, Linux and MacOS platforms. +Both `x86_64` and `aarch64` architectures are supported on Windows, Linux and MacOS platforms. ### Target support Slang can compile shader code to the following targets: -| Target | Status | Output Formats | -|:----------------:|:--------------:|:----------------------:| -| Direct3D 11 | supported | HLSL | -| Direct3D 12 | supported | HLSL | -| Vulkan | supported | SPIRV, GLSL | -| Metal | experimental* | Metal Shading Language | -| WebGPU | experimental* | WGSL | -| CUDA | supported | C++ (compute only) | -| Optix | experimental | C++ (WIP) | -| CPU | experimental | C++ (kernel), C++ (host), standalone executable, dynamic library | - -*Slang currently supports generating vertex, fragment, compute, task and mesh shaders for Metal. WGSL support is still work in-progress. -For greater detail, see the [Supported Compilation Targets](https://shader-slang.com/slang/user-guide/targets.html) section of the [User Guide](https://shader-slang.github.io/slang/user-guide/) - -The Slang project has been used for production applications and large shader codebases, but it is still under active development. -Support is currently focused on the platforms (Windows, Linux) and target APIs (Direct3D 12, Vulkan) where Slang is used most heavily. -Users who are looking for support on other platforms or APIs should coordinate with the development team via the issue tracker to make sure that their use case(s) can be supported. +| Target | Status | Output Formats | +|:-----------:|:-------------------------------------------------------------------------------------:|:----------------------------------------------------------------:| +| Direct3D 11 | [supported](https://shader-slang.com/slang/user-guide/targets.html#direct3d-11) | HLSL | +| Direct3D 12 | [supported](https://shader-slang.com/slang/user-guide/targets.html#direct3d-12) | HLSL | +| Vulkan | [supported](https://shader-slang.com/slang/user-guide/targets.html#vulkan) | SPIRV, GLSL | +| Metal | [experimental*](https://shader-slang.com/slang/user-guide/targets.html#metal) | Metal Shading Language | +| WebGPU | experimental** | WGSL | +| CUDA | [supported](https://shader-slang.com/slang/user-guide/targets.html#cuda-and-optix) | C++ (compute only) | +| Optix | [experimental](https://shader-slang.com/slang/user-guide/targets.html#cuda-and-optix) | C++ (WIP) | +| CPU | [experimental](https://shader-slang.com/slang/user-guide/targets.html#cpu-compute) | C++ (kernel), C++ (host), standalone executable, dynamic library | + +> *Slang currently supports generating vertex, fragment, compute, task and mesh +> shaders for Metal. + +> **WGSL support is still work in-progress. + +For greater detail, see the [Supported Compilation +Targets](https://shader-slang.com/slang/user-guide/targets.html) section of the +[User Guide](https://shader-slang.github.io/slang/user-guide/) + +The Slang project has been used for production applications and large shader +codebases, but it is still under active development. Support is currently +focused on the platforms (Windows, Linux) and target APIs (Direct3D 12, Vulkan) +where Slang is used most heavily. Users who are looking for support on other +platforms or APIs should coordinate with the development team via the issue +tracker to make sure that their use cases can be supported. License ------- |