WTSL 是一个以 TypeScript / decorator 为 authoring surface 的 WebGPU shader、pass 和 material 编译项目。当前仓库定位是 meta-framework:负责编译、IR、WGSL/naga 校验和 snapshot 测试,不预设固定渲染流水线。
.
├── src/ # wtsl authoring types + runtime stubs
├── packages/
│ ├── oxc-wtsl/ # Rust OXC compiler + NAPI-RS binding + JS wrapper
│ ├── wtsl-cli/ # wtsl CLI
│ └── vitest-plugin-wtsl/ # Vitest transform plugin
├── e2e/
│ ├── fixtures/
│ │ ├── shader/
│ │ ├── pass/
│ │ └── material/
│ └── tests/
├── PLAN.md
├── docs/
├── package.json
└── pnpm-workspace.yaml
- Node.js 18+
- pnpm 11+
- Rust stable
- Vite+ / pnpm
vp installoxc-wtsl 使用 NAPI-RS,而不是在 JS 运行时里执行 cargo run。
pnpm --filter oxc-wtsl build构建全部声明目标:
pnpm build:all本地只构建当前平台时可以用目标过滤,避免为了六个 target 都安装跨平台 Rust toolchain:
WTSL_BUILD_TARGETS=aarch64-apple-darwin pnpm build:all本地安装 zig 后可以一次生成六个 NAPI-RS artifact:
WTSL_CROSS_COMPILE=1 pnpm build:all产物命名:
oxc-wtsl.darwin-arm64.node
oxc-wtsl.darwin-x64.node
oxc-wtsl.linux-arm64-gnu.node
oxc-wtsl.linux-x64-gnu.node
oxc-wtsl.win32-arm64-msvc.node
oxc-wtsl.win32-x64-msvc.node
生成可发布 tarball:
pnpm --filter oxc-wtsl packtarball 会包含上述六个 .node、index.js、index.d.ts、binding.d.ts 和 README。
根目录 shortcut:
pnpm build产物位于:
packages/oxc-wtsl/oxc-wtsl.<platform>.node
解析并输出一个 WTSL module 的结构化 JSON IR。
node packages/wtsl-cli/bin/wtsl.js inspect ./e2e/fixtures/shader/glass.shader.wgsl.ts成功时 stdout 是 module JSON;失败时 stderr 是 compiler error JSON,进程退出码为 1。
node packages/wtsl-cli/bin/wtsl.js build ./e2e/fixtures/shader/glass.shader.wgsl.ts输出:
./e2e/fixtures/shader/glass.shader.wgsl.ts.wtsl.json
./e2e/fixtures/shader/glass.shader.wgsl.ts.wgsl
.wgsl 只在 shader module 存在时生成。
node packages/wtsl-cli/bin/wtsl.js test fixture ./e2e/fixtures/shader/glass.shader.wgsl.ts快照以“一个源文件一个目录”的形式保存在 e2e/snapshots/。目录内包含 module.json,以及对应的 shader.json / pass.json / material.json,shader 还会包含 compiled.wgsl。更新时显式传入:
node packages/wtsl-cli/bin/wtsl.js test fixture ./e2e/fixtures/shader/glass.shader.wgsl.ts --update-snapshots| Suffix | Module kind |
|---|---|
*.shader.wgsl.ts |
shader |
*.pass.render.ts |
pass |
*.material.ts |
material |
Shader stage entry 是 static class method;pass 配置使用带 decorator 的 class
property,依赖通过 Pass<[typeof P2, typeof P3], Input, Output> 表达。
@struct 只用于 class。
import { fragment, struct, vec4f, wgsl } from "wtsl";
import type { Vec2F, Vec4F } from "wtsl";
@struct
class FragmentInput {
declare uv: Vec2F;
}
@wgsl
export class GlassShader {
@fragment
static fragment(input: FragmentInput): Vec4F {
return vec4f(input.uv, 0.0, 1.0);
}
}node packages/wtsl-cli/bin/wtsl.js inspect ./e2e/fixtures/shader/glass.shader.wgsl.tsstdout 是 pretty JSON,顶层稳定字段包括 source_name、kind、id、classes、functions、hooks、dependencies、resources 和对应 module 子对象。
vp check --no-fmt类型检查使用 oxlint-tsgolint,通过 Vite+ 配置执行。
cargo test -p oxc-wtsl启用 Naga WGSL validation:
cargo test -p oxc-wtsl --features naga也可以:
pnpm test:rustE2E 会先构建 native package,再运行 fixture 测试。
pnpm test:e2e或:
pnpm --filter oxc-wtsl build
vp test --run e2ecargo fmt --all --check
cargo clippy -p oxc-wtsl --all-targets --features naga,napi -- -D warnings
cargo test -p oxc-wtsl
vp check --no-fmt
pnpm test:e2e也可以直接运行完整本地 gate:
pnpm check:all- WGSL emitter 目前只覆盖基础 subset
- binding/resource layout 已生成基础 IR,仍待接完整 WebGPU render package
- material fixture matrix 已覆盖 glass / diamond / metal / anisotropic / plastic / clearcoat / thin paint