Go to file
ChestnutYueyue c8a6ea19e3 refactor(renderer): 优化文本渲染的批处理逻辑并调整代码格式
重构文本渲染的批处理逻辑,添加纹理变化检查并优化换行处理
同时调整部分代码格式以提高可读性
2026-02-17 20:44:33 +08:00
Extra2D refactor(renderer): 优化文本渲染的批处理逻辑并调整代码格式 2026-02-17 20:44:33 +08:00
docs refactor(模块系统): 重构模块配置方式为lambda函数 2026-02-17 00:34:14 +08:00
examples refactor(renderer): 优化文本渲染的批处理逻辑并调整代码格式 2026-02-17 20:44:33 +08:00
xmake feat(渲染后端): 重构渲染系统支持多后端 2026-02-17 14:48:04 +08:00
.gitignore chore: 在.gitignore中添加GreedyMonster目录 2026-02-14 12:58:22 +08:00
1.jpg feat(渲染): 优化字体图集和精灵批处理系统 2026-02-17 19:55:47 +08:00
LICENSE Initial commit 2026-02-11 19:40:26 +08:00
README.md feat(示例): 添加文字渲染示例并修复场景过渡方法声明 2026-02-17 19:24:50 +08:00
xmake.lua feat(渲染): 添加自动批处理功能并实现图片显示示例 2026-02-17 20:16:07 +08:00

README.md

Extra2D

Build Status C++17 OpenGL ES 3.2 SDL2 GLFW Nintendo Switch

轻量级跨平台 2D 游戏引擎
高性能、模块化、支持 Nintendo Switch

构建指南 | 快速开始 | 示例程序 | 模块系统


简介

Extra2D 是一个轻量级跨平台 2D 游戏引擎,采用现代 C++17 架构,支持 Windows、Linux、macOS 和 Nintendo Switch 平台。

核心特性

  • 跨平台支持Windows、Linux、macOS、Nintendo Switch
  • 模块化架构:模块系统 + 服务系统,灵活可扩展
  • 多后端渲染OpenGL / Vulkan 支持,易于扩展新后端
  • 高性能批处理:独立 Batch 层TrigLookup 优化,支持 10000 精灵/批次
  • 场景图系统:树形节点结构,支持变换继承
  • 输入系统:键盘、鼠标、手柄、触摸,事件驱动
  • 渲染系统OpenGL ES 3.2,支持自定义着色器
  • 视口适配:多种适配模式,自动响应窗口大小变化
  • 音频系统:高质量音频播放(规划中)
  • UI 系统:完整的 UI 控件支持(规划中)

架构概览

flowchart TB
    subgraph Application["Application (应用层)"]
        direction TB
        APP[Application]
    end

    subgraph Core["Core Layer (核心层)"]
        direction LR
        MR[ModuleRegistry<br/>模块注册表]
        SL[ServiceLocator<br/>服务定位器]
    end

    subgraph Modules["Modules (模块系统)"]
        direction TB
        subgraph CoreModules["Core Modules"]
            CONFIG[Config Module<br/>配置管理]
            PLATFORM[Platform Module<br/>平台检测]
            WINDOW[Window Module<br/>窗口管理]
        end
        subgraph OtherModules["Feature Modules"]
            INPUT[Input Module<br/>输入处理]
            RENDER[Render Module<br/>渲染系统]
        end
    end

    subgraph Services["Services (服务系统)"]
        direction TB
        EVENT[EventService<br/>事件分发]
        TIMER[TimerService<br/>计时器]
        SCENE_SVC[SceneService<br/>场景管理]
        CAMERA[CameraService<br/>相机系统]
    end

    subgraph Scene["Scene System (场景系统)"]
        direction TB
        SCENE[Scene<br/>场景]
        NODE[Node<br/>节点]
        SHAPE[ShapeNode<br/>形状节点]
        SPRITE[Sprite<br/>精灵]
    end

    subgraph Graphics["Graphics (图形系统)"]
        direction TB
        BACKEND[RenderBackend<br/>渲染后端]
        BATCH[Batch Layer<br/>批处理层]
        GL[OpenGL Renderer<br/>OpenGL 渲染器]
        VK[Vulkan Renderer<br/>Vulkan 渲染器]
        SHADER[ShaderManager<br/>着色器管理]
        TEXTURE[TexturePool<br/>纹理池]
    end

    subgraph Platform["Platform (平台层)"]
        direction TB
        SDL2[SDL2 Backend<br/>SDL2 后端]
        INPUT_SYS[Input System<br/>输入系统]
    end

    APP --> MR
    APP --> SL
    MR --> Modules
    SL --> Services
    SCENE_SVC --> SCENE
    SCENE --> NODE
    NODE --> SHAPE
    NODE --> SPRITE
    RENDER --> BACKEND
    BACKEND --> BATCH
    BATCH --> GL
    BATCH --> VK
    GL --> SHADER
    GL --> TEXTURE
    WINDOW --> SDL2
    INPUT --> INPUT_SYS
    INPUT_SYS --> SDL2

模块系统

模块 职责 优先级
Config 配置管理 Core (0)
Platform 平台检测 Core (0)
Window 窗口管理 Core (0)
Input 输入处理 Input (50)
Render 渲染系统 Graphics (100)

服务系统

服务 职责 优先级
EventService 事件分发 100
TimerService 计时器 200
SceneService 场景管理 300
CameraService 相机系统 400

渲染系统架构

多后端支持

Extra2D 采用分层架构支持多渲染后端:

┌─────────────────────────────────────┐
│  Application (游戏逻辑)              │
├─────────────────────────────────────┤
│  Renderer (渲染命令)                 │
├─────────────────────────────────────┤
│  Batch Layer (batch/)               │  ← 后端无关的批处理
│  - 顶点缓存管理                       │
│  - 批次策略 (10000 精灵/批次)          │
│  - TrigLookup 三角函数查表            │
│  - 批量绘制接口                       │
├─────────────────────────────────────┤
│  Backend Layer (backends/)          │  ← 具体 GPU 实现
│  - OpenGL / Vulkan / Metal / D3D     │
│  - VAO/VBO 创建                      │
│  - GPU 提交                          │
└─────────────────────────────────────┘

着色器系统

支持多后端的 JSON 元数据着色器系统:

{
    "name": "sprite",
    "backends": {
        "opengl": {
            "vertex": "backends/opengl/builtin/sprite.vert",
            "fragment": "backends/opengl/builtin/sprite.frag"
        },
        "vulkan": {
            "vertex": "backends/vulkan/builtin/sprite.vert.spv",
            "fragment": "backends/vulkan/builtin/sprite.frag.spv"
        }
    }
}

性能优化

优化技术 说明 性能提升
TrigLookup 三角函数查表,避免每帧 sin/cos 计算 旋转计算 5-10x
大批次容量 10000 精灵/批次,减少 draw call Draw call 减少 10x
批量绘制 drawBatch() 一次性处理多个精灵 CPU 开销减少 20-30%
静态索引 预生成索引缓冲区,避免运行时分配 内存分配开销消除
着色器缓存 二进制着色器缓存,加速启动 启动时间减少

构建指南

环境要求

组件 要求
编译器 GCC 9+ / Clang 10+ / MSVC 2019+
C++ 标准 C++17
构建工具 xmake 2.5+
目标平台 Windows / Linux / macOS / Nintendo Switch

安装 xmake

# Windows (PowerShell)
Invoke-Expression (Invoke-WebRequest 'https://xmake.io/psget.text' -UseBasicParsing).Content
# macOS
brew install xmake

# Linux
sudo add-apt-repository ppa:xmake-io/xmake
sudo apt update
sudo apt install xmake

构建项目

基础构建(使用 SDL2 后端,默认)

# 配置项目
xmake f -p mingw -a x86_64 -m release -y

# 构建
xmake build

# 运行示例
xmake run demo_basic

使用 GLFW 后端

# 配置项目(指定 GLFW 后端)
xmake f -p mingw -a x86_64 -m release --window_backend=glfw -y

# 构建
xmake build

# 运行示例
xmake run demo_basic

切换窗口后端

# 切换到 GLFW 后端
xmake f --window_backend=glfw -y

# 切换回 SDL2 后端
xmake f --window_backend=sdl2 -y

# 清理重新配置
xmake f -c -y

切换渲染后端

# 切换到 Vulkan 后端
xmake f --render_backend=vulkan -y

# 切换回 OpenGL 后端(默认)
xmake f --render_backend=opengl -y

# 清理重新配置
xmake f -c -y

Nintendo Switch 构建

# 设置 devkitPro 环境
export DEVKITPRO=/opt/devkitpro

# 配置并构建
xmake f -p switch -m release -y
xmake build

快速开始

创建应用

#include <extra2d/extra2d.h>

using namespace extra2d;

int main() {
    // 配置应用
    AppConfig config = AppConfig::createDefault();
    config.appName = "My Game";
    config.appVersion = "1.0.0";
    
    // 初始化
    Application& app = Application::get();
    if (!app.init(config)) {
        return -1;
    }
    
    // 创建场景
    auto scene = Scene::create();
    scene->setBackgroundColor(Color(0.1f, 0.1f, 0.15f, 1.0f));
    scene->setViewportSize(app.window().width(), app.window().height());
    
    // 配置视口适配
    auto cameraService = app.camera();
    if (cameraService) {
        ViewportConfig vpConfig;
        vpConfig.logicWidth = app.window().width();
        vpConfig.logicHeight = app.window().height();
        vpConfig.mode = ViewportMode::AspectRatio;
        cameraService->setViewportConfig(vpConfig);
    }
    
    // 运行场景
    app.enterScene(scene);
    app.run();
    
    // 清理
    app.shutdown();
    return 0;
}

场景图示例

// 创建节点层级
auto root = makeShared<Node>();
root->setPos(width / 2, height / 2);
scene->addChild(root);

// 添加形状节点
auto rect = ShapeNode::createFilledRect(
    Rect(-50, -50, 100, 100), 
    Color(1.0f, 0.4f, 0.4f, 1.0f)
);
root->addChild(rect);

// 变换继承
auto child = makeShared<Node>();
child->setPos(100, 0);
child->setRotation(45);    // 旋转 45 度
child->setScale(0.5f);     // 缩放 0.5
root->addChild(child);

输入事件

auto eventService = app.events();

// 键盘事件
eventService->addListener(EventType::KeyPressed, [](Event& e) {
    auto& key = std::get<KeyEvent>(e.data);
    if (key.keyCode == static_cast<int>(Key::Escape)) {
        Application::get().quit();
    }
});

// 鼠标事件
eventService->addListener(EventType::MouseButtonPressed, [](Event& e) {
    auto& mouse = std::get<MouseButtonEvent>(e.data);
    // 处理鼠标点击
});

// 手柄事件
eventService->addListener(EventType::GamepadButtonPressed, [](Event& e) {
    auto& gamepad = std::get<GamepadButtonEvent>(e.data);
    // 处理手柄输入
});

示例程序

示例 说明
demo_basic 基础示例:场景图、输入事件、视口适配
demo_text_rendering 文字渲染示例:使用 GLFontAtlas 渲染文字

运行示例:

xmake run demo_basic

技术栈

技术 用途 版本
OpenGL ES 2D 图形渲染 3.2
SDL2 窗口和输入管理(可选) 2.0+
GLFW 窗口和输入管理(可选) 3.4+
GLM 数学库 0.9.9+
nlohmann_json JSON 解析 3.x
glad OpenGL 加载器 最新版
stb_image 图像加载 最新版
stb_truetype 字体渲染 最新版
xmake 构建系统 2.5+

文档


目录结构

Extra2D/
├── Extra2D/
│   ├── include/
│   │   ├── KHR/                    # KHR 平台头文件
│   │   ├── extra2d/                # 引擎公共头文件
│   │   │   ├── app/                # 应用程序
│   │   │   ├── audio/              # 音频配置
│   │   │   ├── config/             # 配置系统
│   │   │   ├── core/               # 核心类型
│   │   │   ├── event/              # 事件系统
│   │   │   ├── graphics/           # 图形渲染
│   │   │   │   ├── backends/       # 渲染后端
│   │   │   │   │   ├── opengl/     # OpenGL 实现
│   │   │   │   │   └── vulkan/     # Vulkan 实现
│   │   │   │   ├── batch/          # 批处理层(后端无关)
│   │   │   │   ├── core/           # 渲染核心
│   │   │   │   ├── camera/         # 相机和视口
│   │   │   │   ├── shader/         # Shader 系统
│   │   │   │   ├── texture/        # 纹理系统
│   │   │   │   └── memory/         # GPU 内存管理
│   │   │   ├── platform/           # 平台抽象
│   │   │   ├── scene/              # 场景系统
│   │   │   ├── services/           # 服务接口
│   │   │   └── utils/              # 工具库
│   │   ├── glad/                   # OpenGL 加载器
│   │   └── stb/                    # STB 单文件库
│   ├── shaders/                     # 着色器文件
│   │   ├── backends/               # 后端特定着色器
│   │   │   └── opengl/             # OpenGL 着色器
│   │   └── shared/                 # 共享着色器元数据
│   └── src/                        # 源文件
│       ├── app/                    # 应用实现
│       ├── config/                 # 配置实现
│       ├── core/                   # 核心实现
│       ├── event/                  # 事件实现
│       ├── glad/                   # GLAD 实现
│       ├── graphics/               # 图形实现
│       │   ├── backends/           # 渲染后端实现
│       │   │   ├── opengl/         # OpenGL 实现
│       │   │   └── vulkan/         # Vulkan 实现
│       │   ├── batch/              # 批处理层实现
│       │   ├── core/               # 渲染核心
│       │   ├── camera/             # 相机和视口
│       │   ├── shader/             # Shader 系统
│       │   ├── texture/            # 纹理系统
│       │   └── memory/             # GPU 内存管理
│       ├── platform/               # 平台实现
│       │   └── backends/           # 后端实现
│       │       ├── sdl2/           # SDL2 后端
│       │       └── glfw/           # GLFW 后端
│       ├── scene/                  # 场景实现
│       ├── services/               # 服务实现
│       └── utils/                  # 工具实现
├── docs/                           # 文档
├── examples/                       # 示例程序
│   └── basic/                      # 基础示例
└── xmake/                          # 构建配置
    └── toolchains/                 # 工具链配置

平台支持

平台 窗口后端 图形 API 状态
Windows SDL2 / GLFW OpenGL ES 3.2 / Vulkan 支持
Linux SDL2 / GLFW OpenGL ES 3.2 / Vulkan 支持
macOS SDL2 / GLFW OpenGL ES 3.2 / Vulkan 支持
Nintendo Switch SDL2 / GLFW OpenGL ES 3.2 支持

贡献

欢迎提交 Issue 和 Pull Request


许可证

Extra2D 使用 MIT 许可证。


联系方式