sokol-shdc 中浮点型 uniform 变量的设置问题解析

在使用 sokol 图形库的 sokol-shdc 工具时，开发者可能会遇到一个关于浮点型 uniform 变量设置的常见问题。本文将深入分析这一问题及其解决方案。

问题现象

当开发者尝试在 GLSL 着色器中定义一个简单的浮点型 uniform 变量时，例如：

uniform fsParams {
    float time;
};

并通过 sokol-shdc 工具编译后，在应用程序中设置该 uniform 变量时，可能会遇到"block size does not match"（块大小不匹配）的错误提示。检查生成的 C 头文件会发现，原本的 float 类型变量被转换为了 vec4 类型。

问题根源

这一现象源于 sokol-shdc 工具内部使用 SPIRV-Cross 进行着色器转换时的处理机制。SPIRV-Cross 会将 uniform 块"扁平化"为 vec4 数组，这是为了优化 GL 后端中的 uniform 更新操作。

具体来说，这种转换允许：

1. 每个 uniform 块通过单个 glUniform4fv() 调用更新
2. 相比为每个 uniform 块成员单独调用 glUniform() 的方式，性能更高

解决方案

正确的方法是使用 sokol-shdc 生成的配套结构体来设置 uniform 变量。例如，对于上述着色器，sokol-shdc 会生成如下结构体：

#pragma pack(push,1)
SOKOL_SHDC_ALIGN(16) typedef struct fsParams_t {
    float time;
    uint8_t _pad_4[12];
} fsParams_t;
#pragma pack(pop)

注意这个结构体有以下特点：

1. 使用 16 字节对齐
2. 自动添加了 12 字节的填充（padding）
3. 确保总大小为 16 字节的倍数

在应用程序中，应该这样使用：

const fsParams_t fs_params = { .time = (float)glfwGetTime() };
sg_apply_uniforms(SG_SHADERSTAGE_FS, SLOT_fsParams, SG_RANGE(fs_params));

注意事项

1. 版本声明：GLSL 文件中的 #version 330 core 声明不是必须的，有时甚至可能干扰 sokol-shdc 的处理。

2. C/C++ 差异：在 C++ 中使用 SG_RANGE 宏时，不需要取地址操作符 &，可以直接使用：

   sg_apply_uniforms(..., SG_RANGE(fs_params));
   

   或者使用兼容性更好的 SG_RANGE_REF 宏：

   sg_apply_uniforms(..., SG_RANGE_REF(fs_params));
   

3. 手动结构体的风险：不建议开发者自行定义 uniform 结构体，因为 uniform 块的对齐和填充规则相当复杂，与普通 C 结构体有很大不同。

总结

理解 sokol-shdc 工具对 uniform 块的特殊处理方式对于正确使用 sokol 图形库至关重要。通过使用工具生成的结构体并遵循推荐的设置方法，可以避免常见的 uniform 设置问题，同时获得最佳的性能表现。这一机制虽然初看起来有些复杂，但它实际上是为了在底层图形 API 上实现更高效的 uniform 更新操作。