ReShade API 技术解析：构建跨图形API的渲染增强插件-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00963/article/details/148524225

ReShade API 技术解析：构建跨图形API的渲染增强插件

reshade A generic post-processing injector for games and video software. 项目地址: https://gitcode.com/gh_mirrors/re/reshade

什么是ReShade API？

ReShade API 是一套功能强大的接口，允许开发者与加载了ReShade的应用程序进行交互，访问其渲染资源和绘制命令。这套API的最大特点在于它抽象了不同图形API的差异，支持包括Direct3D 9/10/11/12、OpenGL和Vulkan在内的多种图形接口，使开发者能够编写跨API的通用插件。

插件开发基础

插件的基本结构

一个ReShade插件本质上是一个动态链接库(DLL)，它通过包含reshade.hpp头文件来使用ReShade API。插件开发不需要导出特定函数或链接特定库（除非特别需要），只需简单地将头文件加入项目即可。

#include <reshade.hpp>

初始化与卸载

插件可以选择性地导出以下两个函数：

AddonInit：在插件加载后立即调用，用于复杂初始化
AddonUninit：在插件卸载前调用，用于清理资源

extern "C" __declspec(dllexport) bool AddonInit(HMODULE addon_module, HMODULE reshade_module)
{
    // 初始化代码
    return true; // 返回false表示初始化失败
}

extern "C" __declspec(dllexport) void AddonUninit(HMODULE addon_module, HMODULE reshade_module)
{
    // 清理代码
}

基本示例

下面是一个简单的插件示例，它在每帧渲染完成后执行特定操作：

#include <reshade.hpp>

static void on_reshade_present(reshade::api::effect_runtime* runtime)
{
    // 在这里添加每帧执行的代码
}

BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID)
{
    switch (fdwReason)
    {
    case DLL_PROCESS_ATTACH:
        if (!reshade::register_addon(hinstDLL))
            return FALSE;
        reshade::register_event<reshade::addon_event::reshade_present>(&on_reshade_present);
        break;
    case DLL_PROCESS_DETACH:
        reshade::unregister_event<reshade::addon_event::reshade_present>(&on_reshade_present);
        reshade::unregister_addon(hinstDLL);
        break;
    }
    return TRUE;
}

核心概念解析

1. 设备与命令系统

ReShade API的核心对象包括：

device：代表逻辑渲染设备（对应物理GPU）
command_list：用于记录渲染命令
command_queue：用于提交渲染命令

这些概念与Direct3D 12和Vulkan中的对应对象类似：

| ReShade对象 | D3D12对应 | Vulkan对应 | |------------|----------|-----------| | device | ID3D12Device | VkDevice | | command_list | ID3D12CommandList | VkCommandBuffer | | command_queue | ID3D12CommandQueue | VkQueue |

2. 资源管理

资源（纹理、缓冲区等）通过句柄进行引用：

reshade::api::resource：代表GPU资源
reshade::api::resource_view：资源的视图（如纹理视图）

创建资源的示例：

reshade::api::resource texture = {};
const reshade::api::resource_desc desc(
    800, 600, 1, 1,                // 宽、高、深度、数组层数
    reshade::api::format::r8g8b8a8_unorm, // 格式
    1,                              // mip级别
    reshade::api::memory_heap::gpu_only, // 内存类型
    reshade::api::resource_usage::shader_resource | 
    reshade::api::resource_usage::render_target); // 用途

if (!device->create_resource(desc, nullptr, reshade::api::resource_usage::undefined, &texture))
{
    // 错误处理
}

3. 渲染管线

ReShade采用类似现代图形API的管线状态对象(PSO)设计：

reshade::api::pipeline_subobject subobjects[3];

// 顶点着色器
reshade::api::shader_desc vertex_shader = {...};
subobjects[0] = { reshade::api::pipeline_subobject_type::vertex_shader, 1, &vertex_shader };

// 像素着色器
reshade::api::shader_desc pixel_shader = {...};
subobjects[1] = { reshade::api::pipeline_subobject_type::pixel_shader, 1, &pixel_shader };

// 光栅化状态
reshade::api::rasterizer_desc rasterizer_state = {...};
subobjects[2] = { reshade::api::pipeline_subobject_type::rasterizer_state, 1, &rasterizer_state };

// 创建管线
reshade::api::pipeline pipeline = {};
device->create_pipeline(reshade::api::pipeline_layout(), 
                       ARRAYSIZE(subobjects), subobjects, &pipeline);

高级功能：覆盖层(Overlay)开发

ReShade支持使用Dear ImGui创建交互式覆盖层，用于显示调试信息或提供用户界面。

基本覆盖层示例

#include <imgui.h>
#include <reshade.hpp>

bool show_debug_window = false;

static void draw_overlay(reshade::api::effect_runtime* runtime)
{
    ImGui::Text("FPS: %.1f", ImGui::GetIO().Framerate);
    
    if (ImGui::Button("Toggle Debug Window"))
        show_debug_window = !show_debug_window;
    
    if (show_debug_window)
    {
        ImGui::Begin("Debug Info", &show_debug_window);
        ImGui::Text("Application resolution: %dx%d", 
                   runtime->get_device()->get_back_buffer_width(),
                   runtime->get_device()->get_back_buffer_height());
        ImGui::End();
    }
}

BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID)
{
    switch (fdwReason)
    {
    case DLL_PROCESS_ATTACH:
        reshade::register_addon(hinstDLL);
        reshade::register_overlay("MyOverlay", &draw_overlay);
        break;
    case DLL_PROCESS_DETACH:
        reshade::unregister_addon(hinstDLL);
        break;
    }
    return TRUE;
}

覆盖层使用技巧

共享覆盖层名称：可以使用特殊名称（如"###settings"）将内容添加到ReShade现有界面中
设置界面：注册无标题的覆盖层会显示在插件设置区域
性能考虑：避免在每帧中创建/销毁ImGui对象

实际应用案例

案例1：修改交换链参数

static bool on_create_swapchain(reshade::api::device_api api, 
                              reshade::api::swapchain_desc &desc, 
                              void* hwnd)
{
    // 强制使用特定分辨率
    if (desc.back_buffer.texture.width == 800 && 
        desc.back_buffer.texture.height == 600)
    {
        desc.back_buffer.texture.width = 1920;
        desc.back_buffer.texture.height = 1080;
        return true; // 确认修改
    }
    return false;
}

案例2：绘制命令拦截

static bool on_draw(reshade::api::command_list* cmd_list, 
                   uint32_t vertices, uint32_t instances, 
                   uint32_t first_vertex, uint32_t first_instance)
{
    // 在绘制特定图元前清除渲染目标
    if (vertices == 3) // 三角形
    {
        const float clear_color[4] = { 1.0f, 0.0f, 0.0f, 1.0f };
        cmd_list->clear_render_target_view(rtv, clear_color);
    }
    return false; // 不阻止原始绘制命令
}