shaderc

前言

本章我们将介绍如何使用 shaderc 工具在运行时编译着色器代码。

shaderc 是 Google 提供的一个工具集。它既包含命令行工具 glslc，也提供库接口，可用于在运行时将 GLSL 着色器代码编译为 SPIR-V 二进制格式。

基础代码

请下载并阅读下面的基础代码，这是“C++模块化”章节的第二部分代码，但使用了同步 2 语法：

点击下载

我们还修改了一点，在 GraphicsPipeline.cppm 中添加了着色器的硬编码代码，但没有使用。

构建运行，将显示我们熟悉的房屋模型：

right_room

安装 shaderc

如果你打开 Vulkan SDK 的安装目录，查询头文件路径，会发现 shaderc 已经位于其中，这就是为什么我们之前可以直接在 CMake 使用 glslc 命令。

Vulkan SDK 的头文件甚至包含了 glm 线性代数库。

此外，也可以通过 vcpkg 安装 shaderc：

vcpkg install shaderc

如果你使用 Vulkan SDK 自带的 shaderc ，则可以查阅此文档，它告诉了你如何使用 Vulkan 自带的 shaderc 目标。

如果你使用 vcpkg 安装，请修改 CMakeLists.txt 文件，添加以下内容：

find_package(unofficial-shaderc CONFIG REQUIRED)
# ......
target_link_libraries(main PRIVATE unofficial::shaderc::shaderc)

shaderc 的对外接口并不多，下面出一个模块接口文件的示例，你可以将它加到 src/third/ 目录下：

module;

#include <shaderc/shaderc.hpp>

export module shaderc;

export namespace shaderc {
    using target_env = ::shaderc_target_env;
    using env_version = ::shaderc_env_version;
    using spirv_version = ::shaderc_spirv_version;
    using compilation_status = ::shaderc_compilation_status;
    using source_language = ::shaderc_source_language;
    using shader_kind = ::shaderc_shader_kind;
    using profile = ::shaderc_profile;
    using optimization_level = ::shaderc_optimization_level;
    using limit = ::shaderc_limit;
    using uniform_kind = ::shaderc_uniform_kind;
    using include_result = ::shaderc_include_result;
    using include_type = ::shaderc_include_type;
    using compilation_result_t = ::shaderc_compilation_result_t;
    using shaderc::CompilationResult;
    using shaderc::Compiler;
    using shaderc::CompileOptions;
    using shaderc::SpvCompilationResult;
    using shaderc::AssemblyCompilationResult;
    using shaderc::PreprocessedSourceCompilationResult;
}

编译着色器

转到 GraphicsPipeline.cppm 模块，我们已经将需要的着色器代码硬编码在了两个 std::string 中，现在要在运行时编译这些着色器代码，并生成 Vulkan 着色器模块。

1. 辅助函数

首先导入 shaderc 模块，然后创建一个函数用于编译着色器：

import shaderc;

...

std::vector<std::uint32_t> compile_shader(
    const std::string& source,              // 着色器源代码
    const shaderc::shader_kind kind,        // 着色器类型
    const std::string& name = "shader"     // 着色器名称（可选，默认为 "shader"）
) {


}

我们需要着色器源码和着色器类型作为参数。着色器名称是可选的，它用于输出调试日志。

shaderc 中有一个 Compiler 类，它是编译器的核心。具体的配置参数则通过 CompileOptions 类来设置。整体代码如下：

std::vector<std::uint32_t> compile_shader(
    const std::string& source,              // 着色器源代码
    const shaderc::shader_kind kind,        // 着色器类型
    const std::string& name = "shader"     // 着色器名称（可选，默认为 "shader"）
) {
    // 创建编译器和编译选项
    shaderc::Compiler compiler;
    shaderc::CompileOptions options;

    // 设置编译选项
    options.SetOptimizationLevel(shaderc::optimization_level::shaderc_optimization_level_performance);
    // 设置目标环境
    options.SetTargetEnvironment(shaderc::target_env::shaderc_target_env_vulkan, shaderc::env_version::shaderc_env_version_vulkan_1_4);
    // 设置源语言
    options.SetSourceLanguage(shaderc::source_language::shaderc_source_language_glsl);

    // 编译着色器
    const shaderc::SpvCompilationResult result = compiler.CompileGlslToSpv(
        source, // 着色器源代码
        kind,   // 着色器类型
        name.c_str(), // 着色器名称
        options // 编译选项
    );

    // 检查编译结果
    if (result.GetCompilationStatus() != shaderc::compilation_status::shaderc_compilation_status_success) {
        throw std::runtime_error(result.GetErrorMessage());
    }

    return {result.cbegin(), result.cend()};
}

2. 创建着色器模块

现在可以修改 create_graphics_pipeline 函数，使用 compile_shader 函数来编译着色器代码，并创建着色器模块：

const auto vertex_shader_code = compile_shader(VERT_CODE, shaderc::shader_kind::shaderc_glsl_vertex_shader);
const auto fragment_shader_code = compile_shader(FRAG_CODE, shaderc::shader_kind::shaderc_glsl_fragment_shader);
const auto vertex_shader_module = m_device->device().createShaderModule(
    vk::ShaderModuleCreateInfo().setCode( vertex_shader_code )
);
const auto fragment_shader_module = m_device->device().createShaderModule(
    vk::ShaderModuleCreateInfo().setCode(fragment_shader_code)
);