Skip to content
Mathis Brossier edited this page Oct 2, 2024 · 16 revisions

WESL: A Portable and Modular Superset of WGSL

Welcome to the user-friendly documentation page for WESL! 👋

This documentation is aimed at those who want to learn how to use WESL.

What is WESL?

WESL is:

  • A superset of WGSL, the WebGPU Shading Language, that allows developers to compose shader modules with features like imports, generics, and conditional compilation.
  • A compiler that converts WESL files into valid WGSL code for use with WebGPU.
  • A suite of convenience tools, including a Language Server and a Syntax Highlighter. (Coming soon)

Who is it for?

WESL is designed for anyone writing shaders in WGSL. It is language- and framework-agnostic, with implementations available for Rust and TypeScript. It supports frameworks such as Bevy and Use.GPU.

How to use it?

Check out the Getting Started page for installation instructions and an introduction to the language extensions. (Coming soon)

For a more detailed explanation of the various extensions, visit the Reference page. (Coming soon)

Questions, Remarks, Complaints

WESL is still in the early stages of specification and development, so expect frequent updates. We welcome any feedback! The best way to reach us is by opening a GitHub Issue.

You can also join our Discord Server to get involved or stay up to date with WESL's development. We are always open to new contributors.

Documentation has moved → wesl-lang.dev

This wiki is no longer maintained.

Clone this wiki locally