sokol项目中的WebGL2着色器编译问题分析与解决

在sokol项目的Emscripten示例中，开发者在将两个示例（bufferoffsets-emsc和offscreen-emsc）从WebGL1升级到WebGL2时遇到了奇怪的着色器编译问题。本文将详细分析问题的现象、排查过程以及最终解决方案。

问题现象

当开发者尝试将示例中的着色器代码从WebGL1升级到WebGL2版本时，出现了以下异常现象：

1. 在WebGL2的release构建模式下，控制台会报告着色器编译错误，提示"invalid shader source"
2. 在debug构建模式下，系统检测到sg_shader_desc结构体中的bytecode指针包含垃圾数据
3. 即使将sg_shader_desc声明为全局变量，问题依然存在
4. 在main函数开始处添加断言检查时，发现fs.bytecode.ptr成员不为零

这些现象表明着色器描述结构体在初始化过程中可能发生了数据损坏。

排查过程

开发者进行了多方面的排查：

1. 首先怀疑是Emscripten的栈大小问题，但增大栈空间后问题依旧
2. 检查sokol_gfx.h内部的着色器编译代码，排除了内部逻辑导致数据损坏的可能性
3. 尝试回退到旧版Emscripten工具链，问题依然存在
4. 将着色器描述结构体移出到全局变量，问题依旧出现

根本原因

经过仔细检查，发现问题出在着色器代码字符串的语法上。在片段着色器的定义中，开发者错误地在第一行后面添加了一个逗号：

.fs.source =
    "#version 300 es\n",  // 这里多了一个逗号
    "precision mediump float;\n"
    "in vec4 color;\n"
    "out vec4 frag_color;\n"
    "void main() {\n"
    "  frag_color = color;\n"
    "}\n"

这个多余的逗号导致字符串连接出现了问题，使得后续的字符串被错误地解释为结构体的其他成员初始化，而非着色器代码的延续部分。这种语法错误在C语言中是合法的（虽然会产生警告），但会导致完全不符合预期的行为。

经验教训

1. 字符串连接要谨慎：在C语言中使用多行字符串连接时，要特别注意标点符号的使用，避免在行尾添加不必要的逗号或分号。

2. 编译器警告很重要：这类问题通常会产生编译器警告，开启并重视警告信息可以帮助及早发现问题。

3. 调试技巧：当遇到看似不可能的数据损坏问题时，可以从最简单的代码开始逐步排查，缩小问题范围。

4. WebGL着色器调试：WebGL着色器编译错误有时会给出模糊的错误信息，需要结合上下文和代码结构进行分析。

解决方案

修正后的着色器代码应该去掉多余的逗号：

.fs.source =
    "#version 300 es\n"
    "precision mediump float;\n"
    "in vec4 color;\n"
    "out vec4 frag_color;\n"
    "void main() {\n"
    "  frag_color = color;\n"
    "}\n"

这个案例展示了即使是经验丰富的开发者，也可能因为一个简单的语法错误而花费大量时间进行调试。它提醒我们在编程时要特别注意细节，特别是在处理多行字符串和复杂结构体初始化时。