图形渲染与 Shader / 系统课时
完成构建与发布
完成构建与发布
本课把已经能运行的 OpenGL 渲染器整理成可交付版本:统一 CMake 构建入口,复制运行资源,安装可执行文件,并生成压缩包,确保程序离开开发目录后仍能启动。
学习目标
- 固化编译选项、第三方依赖和目标名称
- 让着色器、纹理等资源进入发布目录
- 使用安装规则与 CPack 生成可分发压缩包
先整理发布目录
建议把源码、第三方库和运行资源分开管理。最终发布目录只保留可执行文件、必须的动态库、资源和许可证,不携带对象文件、缓存目录或 IDE 配置。
opengl-renderer/
├─ CMakeLists.txt
├─ src/
├─ include/
├─ third_party/
├─ assets/
│ ├─ shaders/
│ └─ textures/
└─ LICENSE这个目录树是结构示例,不是可执行命令。发布后应形成 OpenGLRenderer-1.0.0/,其中包含程序本体、assets/ 与许可证文件。
固化 CMake 构建规则
下面配置假设项目已将 GLAD 源码放在 third_party/glad,并通过系统或包管理器提供 GLFW。OpenGL::GL 由 CMake 查找系统 OpenGL 实现。
cmake_minimum_required(VERSION 3.21)
project(OpenGLRenderer VERSION 1.0.0 LANGUAGES C CXX)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)
find_package(OpenGL REQUIRED)
find_package(glfw3 CONFIG REQUIRED)
add_executable(opengl-renderer
src/main.cpp
third_party/glad/src/glad.c
)
target_include_directories(opengl-renderer PRIVATE
include
third_party/glad/include
)
target_link_libraries(opengl-renderer PRIVATE
OpenGL::GL
glfw
)
if(MSVC)
target_compile_options(opengl-renderer PRIVATE /W4)
else()
target_compile_options(opengl-renderer PRIVATE -Wall -Wextra -Wpedantic)
endif()
add_custom_command(TARGET opengl-renderer POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/assets
$<TARGET_FILE_DIR:opengl-renderer>/assets
)
install(TARGETS opengl-renderer RUNTIME DESTINATION .)
install(DIRECTORY assets/ DESTINATION assets)
install(FILES LICENSE DESTINATION .)
set(CPACK_PACKAGE_NAME "OpenGLRenderer")
set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})
set(CPACK_GENERATOR "ZIP")
include(CPack)生效后,开发构建目录会在可执行文件旁得到一份 assets/;执行安装时,CMake 会按同样布局复制程序、资源和许可证。若 GLFW 使用动态链接,还需把对应动态库纳入安装规则或改为静态链接。
统一资源定位方式
程序不能依赖 IDE 自动设置的工作目录。发布包应约定资源位于可执行文件旁的 assets/,启动时先计算程序目录,再拼接着色器和纹理路径。
片段示例:executableDir() 需要由各平台实现,例如 Windows 使用 GetModuleFileNameW,Linux 读取 /proc/self/exe,macOS 使用 _NSGetExecutablePath。
#include <filesystem>
#include <stdexcept>
#include <string>
std::filesystem::path executableDir();
std::string loadShaderPath(const std::string& fileName) {
const auto path = executableDir() / "assets" / "shaders" / fileName;
if (!std::filesystem::exists(path)) {
throw std::runtime_error("找不到着色器文件: " + path.string());
}
return path.string();
}生效行为:无论用户从哪个工作目录启动程序,资源都按程序所在位置查找。验证时可在另一个目录执行发布包中的程序,确认不会出现资源文件缺失。
构建、安装并生成压缩包
以下命令以已安装 CMake、编译器和 GLFW 开发包为前提。<PATH>、生成器名称和包文件后缀会因系统而不同。
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=<PATH>
cmake --build build --config Release
cmake --install build --config Release --prefix dist/OpenGLRenderer-1.0.0
cmake --build build --config Release --target package预期结果:
[100%] Built target opengl-renderer
-- Installing: <PATH>/dist/OpenGLRenderer-1.0.0/opengl-renderer
-- Installing: <PATH>/dist/OpenGLRenderer-1.0.0/assets
CPack: - package: <PATH>/build/OpenGLRenderer-1.0.0-<PLATFORM>.zip generated.日志中的实际路径、可执行文件扩展名和平台名称可能不同。若使用 Visual Studio 等多配置生成器,必须保留 --config Release,否则可能安装 Debug 版本。
做一次脱离开发环境的验收
不要直接在源码目录中完成最终验收。先解压生成的包,再从一个不包含源码和第三方库的目录启动程序,确认窗口创建、着色器加载、纹理加载和退出清理均正常。
同时检查动态库依赖。Windows 可使用 dumpbin /DEPENDENTS,Linux 可使用 ldd,macOS 可使用 otool -L。发布包不应依赖开发机上的临时构建路径,也不应误带调试符号、缓存和绝对资源路径。
常见发布失败
程序在开发机正常、换机器后无法启动,通常来自三类问题:缺少运行时动态库、资源路径依赖当前工作目录、目标机器不支持请求的 OpenGL 版本。应先读取系统错误和 OpenGL 上下文创建结果,再分别补齐依赖、修正路径或降低上下文版本要求。
若许可证要求随包分发声明文件,必须把第三方许可证一并安装。发布前还应记录编译器、CMake、GLFW 和 GLAD 版本,使后续问题可以复现。
本课总结
- 发布配置应同时管理程序、运行时依赖、资源文件和许可证
- 资源路径必须相对可执行文件解析,不能依赖 IDE 工作目录
- 最终验收要在脱离源码与构建目录的环境中完成
下一课预告
至此,综合渲染器已经完成资源管理、构建和发布闭环,后续可以继续扩展性能分析、材质系统或多平台适配。