ShaderCompiler:未使用的 Pass 级宏会把 discard 函数输出到顶点程序

オープン
#3,155 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript

調査の方向性

Start with the Pass-level macro pre-scan in packages/shader-compiler/src/codeGen/GLESVisitor.ts (lines 181–187) and the macro body scan (lines 290–315). Trace how that scan registers global functions, then use the provided shader reproduction with WebGL1 or WebGL2 to check generated vertex GLSL. Done means an unused Pass-level macro no longer adds cutout() to the vertex shader, and compileVariant succeeds.

索引モデルが issue の本文から書いたものです。

説明

问题

Pass 级 #define 的替换文本只要引用了一个辅助函数,编译器就会把该函数输出到顶点程序。即使顶点和片元入口都没有调用该宏,也会触发。 如果该函数包含仅允许在片元程序中使用的 discard,WebGL 会拒绝编译顶点程序。

最小复现

Shader "ReproUnusedPassMacro" {
  SubShader "Default" {
    Pass "Forward" {
      VertexShader = vert;
      FragmentShader = frag;

      void cutout() {
        discard;
      }

      #define CUTOUT cutout

      void vert() {
        gl_Position = vec4(0.0);
      }

      void frag() {
        gl_FragColor = vec4(1.0);
      }
    }
  }
}

使用配置了 ShaderCompiler 的 WebGLEngine。用 Shader.create(source, language) 创建 shader,再调用 shader.compileVariant(engine, [])。开启 Logger 可以看到 WebGL 的编译日志。

预期 两个入口都用不到 cutout,顶点 GLSL 不包含该函数,shader 可以编译。

实际 compileVariant 返回 false。生成的顶点 GLSL 包含 void cutout() { discard; }。WebGL 报错:

Shader type: vertex
ERROR: 0:2: 'discard' : discard supported in fragment shaders only

对照用例中,删除 Pass 级宏,并在 frag 内直接调用 cutout(),编译通过。把宏定义和调用都放到 frag 函数体里,编译也通过。

验证环境

Chromium WebGL1(GLSL ES 1.00)和 WebGL2(GLSL ES 3.00)均可复现。#3132 的 Base 4d1451caf 和 Head 18bc711d 结果一致。

当前顶点生成流程在遍历顶点入口之前预扫描 Pass 级宏。预扫描为宏体生成代码时,也会登记宏体中出现的全局函数。该登记没有检查宏是否会在顶点阶段使用。

顶点入口前的宏预扫描 · 宏体扫描逻辑

主要言語
TypeScript
スター
5.9k
フォーク
413
平均マージ
16時間 17分
マージ済み PR(30日)
41

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

galacean/engine のほかの issue

galacean/engine の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。