BGFX CMake 构建脚本使用教程

BGFX CMake 构建脚本使用教程

1. 项目的目录结构及介绍

bgfx.cmake/
├── CMakeLists.txt
├── README.md
├── cmake/
│   ├── bgfx.cmake
│   ├── bx.cmake
│   ├── bimg.cmake
│   └── ...
├── examples/
│   ├── common/
│   ├── 00-helloworld/
│   ├── 01-cubes/
│   └── ...
└── scripts/
    └── ...

• CMakeLists.txt: 主CMake配置文件，用于定义项目的构建规则。
• README.md: 项目说明文档，包含项目的基本信息和使用指南。
• cmake/: 包含用于构建bgfx、bx和bimg的CMake脚本。
• examples/: 包含多个示例项目，展示如何使用bgfx进行图形渲染。
• scripts/: 包含一些辅助脚本，用于项目的构建和配置。

2. 项目的启动文件介绍

在examples/目录下，每个示例项目都有一个main.cpp文件作为启动文件。例如，examples/00-helloworld/main.cpp是“Hello World”示例的启动文件。

// examples/00-helloworld/main.cpp
#include <bgfx/bgfx.h>
#include <bgfx/platform.h>
#include <bx/bx.h>
#include <bx/timer.h>

int main(int argc, char** argv) {
    // 初始化bgfx
    bgfx::renderFrame();
    bgfx::init();
    bgfx::reset(1280, 720, BGFX_RESET_VSYNC);
    bgfx::setViewClear(0, BGFX_CLEAR_COLOR | BGFX_CLEAR_DEPTH, 0x303030ff, 1.0f, 0);
    bgfx::setViewRect(0, 0, 0, 1280, 720);

    // 主循环
    while (!bgfx::renderFrame()) {
        bgfx::touch(0);
        bgfx::dbgTextClear();
        bgfx::dbgTextImage(0, 0, 16, 16, s_logo, 16);
        bgfx::dbgTextPrintf(0, 1, 0x0f, "Hello World!");
        bgfx::frame();
    }

    bgfx::shutdown();
    return 0;
}

3. 项目的配置文件介绍

CMakeLists.txt是项目的主配置文件，定义了项目的构建规则和依赖关系。以下是部分关键配置：

cmake_minimum_required(VERSION 3.10)
project(bgfx-examples)

# 设置编译器选项
set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 包含bgfx、bx和bimg的CMake脚本
include(cmake/bgfx.cmake)
include(cmake/bx.cmake)
include(cmake/bimg.cmake)

# 添加示例项目
add_subdirectory(examples/00-helloworld)
add_subdirectory(examples/01-cubes)
# ...

# 设置输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)

通过以上配置，可以构建和运行bgfx的示例项目。每个示例项目都有自己的CMakeLists.txt文件，定义了该项目的具体构建规则。