yaksue-engine:基于 D3D11、D3D12、OpenGL 和 Vulkan 的实时渲染引擎项目

适合图形学初学者理解实时渲染底层原理。从零用 D3D11、D3D12、OpenGL 和 Vulkan 四大图形 API 分别实现渲染引擎,通过四种实现的对比掌握各 API 渲染管线差异与核心机制。支持 Windows 平台,Vulkan SDK 自动下载,开箱即用。【此简介由AI生成】

Branch1Tags0
FilesLast commitLast update
6 hours ago
13 hours ago
6 hours ago
6 hours ago
13 days ago
4 days ago
6 hours ago
12 days ago
13 days ago

YaksueEngine

工程目的

从零开始,用 D3D11、D3D12、OpenGL、Vulkan 四个图形 API 分别实现,在实践中学习实时渲染的底层原理。

环境前提

  • Windows 平台(x64)
  • Visual Studio 2019 及之后的版本,需要安装"使用 C++ 的桌面开发"工作负载(会同时安装 Windows SDK)

工程会自动使用当前 VS 版本对应的编译工具集和本机最新的 Windows SDK,不需要手动配置。

快速开始

  1. (可选,只有使用 Vulkan 时才需要)双击仓库根目录的 VulkanSDKDownload.bat,详见下文 Vulkan。

  2. 用 VS 打开 YaksueEngine/YaksueEngine.sln,编译并运行。

  3. 第一次运行时会自动生成配置文件 YaksueEngine/UserConfig.ini(不进入版本控制):

    [Rendering]
    GraphicsAPI=D3D11
    Skybox=meadow_2_2k
    
    • GraphicsAPI:可选值 D3D11(默认)、D3D12、OpenGL、Vulkan,不区分大小写。窗口标题会显示当前使用的图形 API。
    • Skybox:YaksueEngine/Assets/Skybox 根目录下某个 .hdr 文件的名字(不含扩展名),默认 meadow_2_2k。
    • Model:YaksueEngine/Assets/Models 下某个模型文件夹的名字,默认是按字母顺序的第一个。ini 里没有这一项时不会自动写入。

    也可以双击仓库根目录的 UserConfigEditor.bat,在弹出的小窗口里用下拉框选择并保存(只用 Windows 自带的 PowerShell,不需要安装任何东西)。

    临时换一下配置、又不想改 UserConfig.ini 时,可以用命令行参数 -ConfigOverride=<文件路径>:文件格式和 UserConfig.ini 一样,只写要覆盖的那几项,只在这次运行中生效。

添加天空盒

  1. 把等距柱状投影(经纬度)格式的 .hdr 放到 YaksueEngine/Assets/Skybox 根目录,要求宽高比 2:1、宽度是 2 的幂且至少 2048(比如 Poly Haven 的 2K 版本)。

  2. 在仓库根目录运行(需要 Python 3,只用标准库,大约 2~3 分钟):

    python Tools\GenerateSkyboxMaps.py YaksueEngine\Assets\Skybox\<文件名>.hdr
    

    它会在旁边生成 <文件名>_generated 文件夹,里面是辐照度图和预过滤的镜面反射图。引擎按这个命名自动找到它们;缺少时会在控制台打印上面这条命令并退出。

  3. 在 UserConfig.ini(或 UserConfigEditor.bat)里把 Skybox 改成新的文件名。

  4. 在 YaksueEngine/Assets/CREDITS.md 里记录来源和许可证。

添加模型

YaksueEngine/Assets 下有两个放模型的目录:Meshes 只放网格(.obj),Models 放带贴图的完整模型(glTF)。

  1. 在 YaksueEngine/Assets/Models 下新建一个文件夹,放入 glTF 2.0 模型:一个 .gltf 文件,以及它引用的 .bin 和贴图(比如 Poly Haven 模型的 glTF 格式,解压后整个文件夹放进来即可)。文件夹里只能有一个 .gltf。
  2. 在 UserConfig.ini(或 UserConfigEditor.bat)里把 Model 改成这个文件夹的名字。
  3. 在 YaksueEngine/Assets/CREDITS.md 里记录来源和许可证。

目前只读材质的基础色、金属度、粗糙度(常数和贴图),法线贴图、遮蔽、自发光、透明等先忽略;贴图要是外部文件(不支持嵌入在文件里的图片)。

四个图形 API 的环境

图形 API 需要额外操作吗 头文件 / 库从哪来 运行时 DLL 从哪来
D3D11 不需要 Windows SDK Windows 系统自带
D3D12 不需要 Windows SDK Windows 系统自带
OpenGL 不需要 Windows SDK + 仓库内的 GLAD Windows 系统自带 + 显卡驱动
Vulkan 需要运行 VulkanSDKDownload.bat 脚本下载的 Vulkan SDK 显卡驱动

D3D11

  • 头文件 d3d11.h 和导入库 d3d11.lib 都在 Windows SDK 里,VS 默认已配置好包含目录和库目录。
  • 运行时 d3d11.dll 是 Windows 系统组件。
  • 不再需要旧的 Microsoft DirectX SDK (June 2010)。

D3D12

  • 头文件 d3d12.h、dxgi1_4.h 和导入库 d3d12.lib、dxgi.lib 都在 Windows SDK 里。
  • 运行时 d3d12.dll 是 Windows 10 及之后的系统组件。
  • 需要显卡支持 Feature Level 11_0 及以上。

OpenGL

  • opengl32.lib(WGL 函数)在 Windows SDK 里,运行时 opengl32.dll 是 Windows 系统组件,实际的 OpenGL 实现由显卡驱动提供。
  • Windows SDK 只提供 OpenGL 1.1 的头文件,更高版本的函数由 GLAD 在运行时加载。GLAD 生成的代码放在 YaksueEngine/ThirdParty/glad/,已经在版本控制里,不需要额外下载(生成参数见其头文件开头的注释)。
  • 使用 OpenGL 4.6 Core Profile,需要显卡驱动支持。

Vulkan

Vulkan 的头文件、导入库、验证层和 shader 编译器不在 Windows SDK 里,需要先双击仓库根目录的 VulkanSDKDownload.bat:

  • 按 Tools/vulkan_sdk.json 锁定的版本(目前是 1.4.363.0),从 LunarG 官方下载 Vulkan SDK 安装包(约 290MB),校验 SHA256 后,只释放本工程需要的文件到 YaksueEngine/ThirdParty/Vulkan/SDK/(不进入版本控制):
    • 头文件 Include/vulkan/*.h、Include/vk_video/*.h
    • 导入库 Lib/vulkan-1.lib
    • 验证层 Bin/VkLayer_khronos_validation.dll/.json(Debug 下自动启用)
    • shader 编译器 Bin/glslc.exe
  • 不修改系统的环境变量、PATH 和 Vulkan 层注册。
  • 只需要运行一次。已下载好时再运行会直接跳过;安装包缓存在 %LOCALAPPDATA%\yaksue-engine\cache\,SDK 目录被删除后重新运行也不会重复下载。
  • 升级 SDK:修改 Tools/vulkan_sdk.json 中的 version、sha256、sha256_source,再运行一次脚本。

Vulkan 是可选的:

  • 没有运行过脚本时,工程照样可以编译(会有一条警告),D3D11、D3D12、OpenGL 都能正常使用;选择 Vulkan 时控制台会提示运行 VulkanSDKDownload.bat。
  • 运行脚本后,需要在 VS 中重新生成解决方案(生成 → 重新生成解决方案),Vulkan 才会被编译进来。
  • 运行时的 vulkan-1.dll 由显卡驱动安装。它是延迟加载的,所以在没有 Vulkan 驱动的机器上,程序仍然可以启动并使用其他图形 API。

目录结构

VulkanSDKDownload.bat        下载 Vulkan SDK 文件(可选)
Tools/                       下载脚本和锁定的 SDK 版本
YaksueEngine/
  YaksueEngine.sln           解决方案
  Source/
    main.cpp                 窗口、主循环、读取配置
    D3D11RHI/                D3D11 实现
    D3D12RHI/                D3D12 实现
    OpenGLRHI/               OpenGL 实现
    VulkanRHI/               Vulkan 实现
  ThirdParty/
    glad/                    GLAD 生成的 OpenGL / WGL 加载代码
    Vulkan/SDK/              VulkanSDKDownload.bat 释放的文件(不进入版本控制)

Introduction

适合图形学初学者理解实时渲染底层原理。从零用 D3D11、D3D12、OpenGL 和 Vulkan 四大图形 API 分别实现渲染引擎,通过四种实现的对比掌握各 API 渲染管线差异与核心机制。支持 Windows 平台,Vulkan SDK 自动下载,开箱即用。【此简介由AI生成】

Customize your domain