Skip to content

About

Egui中文教程

Topics

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Egui 中文教程

这是一个关于 egui 的中文教程项目,使用 MkDocs Material 构建静态网站。

项目介绍

egui是一个用纯 Rust 编写的即时模式 GUI 库,具有以下特点:

  • 简单:写法直白,没有回调、没有信号槽
  • 快速:debug 构建下也能达到 60 FPS
  • 可移植:同一份代码能编译成桌面程序,也能编译成网页(WebAssembly)

本项目旨在为中文用户提供一个完整的 egui 学习指南,涵盖从基础概念到实战技巧的各个方面。

📖 内容来源

本指南的所有内容均由 AI 自动编写。AI 读取 egui 官方仓库的源码、文档和示例代码,然后生成这套完整的中文教程。内容力求准确反映 egui 的实际用法和设计理念,但由于是自动生成,可能存在不准确或过时的地方。

目录结构

Egui中文教程/
├── mkdocs.yml         # MkDocs 配置文件
├── docs/              # Markdown 源文件目录
│   ├── stylesheets/   # 自定义样式
│   │   └── extra.css
│   ├── chapter_1.md   # 第一章 认识 egui
│   ├── chapter_2.md   # 第二章 快速开始
│   ├── chapter_3.md   # 第三章 即时模式 GUI
│   ├── chapter_4.md   # 第四章 核心概念
│   ├── chapter_5.md   # 第五章 内置控件
│   ├── chapter_6.md   # 第六章 布局
│   ├── chapter_7.md   # 第七章 容器:面板、窗口与滚动区
│   ├── chapter_8.md   # 第八章 文本编辑
│   ├── chapter_9.md   # 第九章 图片
│   ├── chapter_10.md  # 第十章 字体与样式
│   ├── chapter_11.md  # 第十一章 自定义控件
│   ├── chapter_12.md  # 第十二章 eframe 与后端集成
│   └── chapter_13.md  # 第十三章 实战技巧与常见问题
├── examples/          # 示例代码调试环境(eframe + egui 的 cargo crate,不参与站点构建)
└── site/              # 构建输出目录(已自动生成)

调试示例代码

教程里的代码想真跑一遍,用 examples/ 这个 cargo 工程(只依赖 eframe / egui / env_logger,不影响 MkDocs 构建):

cd examples
cargo check     # 只编译检查,改完片段先跑这个
cargo run       # 开窗口看效果

入口是 examples/src/bin/playground.rs,共用样板在 examples/src/lib.rs。版本要求和 docs/chapter_2.md 2.1 保持一致。

构建方式

前置条件

  1. 安装 uv:
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

构建步骤

  1. 克隆仓库:
git clone https://github.com/Neutriny/Egui-cn-tutorial.git
cd Egui-cn-tutorial
  1. 构建静态网站:
uv sync
uv upgrade
uv run mkdocs build

构建完成后,静态文件将输出到 site/ 目录。

  1. 本地预览:
uv run mkdocs serve

启动本地服务器,默认地址为 http://localhost:8000。

部署到 GitHub Pages

本项目已配置 GitHub Actions 自动部署。当推送到 main 分支时,会自动构建并部署到 GitHub Pages。

在线访问地址:https://neutriny.github.io/Egui-cn-tutorial/

参与贡献

欢迎提交 Issue 和 Pull Request 来改进本项目。

更新说明

本指南已更新至 egui 官方仓库的以下提交:

  • 最新提交:841a328ba2dd8f6996beb7189ebb7fc00e668a2a (2026-10-15)
  • 版本:egui 0.37.0(最低 Rust 1.95,edition 2024)
  • 主要更新内容:
    • 新增 egui_system_font_provider,可按需加载系统字体,中文和 emoji 不再必须手动塞字体文件
    • 新增 Context::add_font_provider 与 Context::add_glyph_rasterizer(自定义字体来源、彩色 emoji)
    • default_fonts 不再是 egui 的默认 feature(eframe 仍默认开启,直接依赖 egui 时要自己加)
    • 新增 RangeSlider:一根滑轨上两个手柄,选一段数值范围
    • 新增 Aligned 容器:把内容对齐到父容器的角落或边缘
    • 新增 CompletionPopup:给 TextEdit 加自动补全(命令面板、文件路径等)
    • 新增 TextEdit::event_filter(0.36.2 引入):控制哪些按键事件被输入框吃掉(例如允许 Tab)
    • Id::new 弃用,改用 Id::unique;面板构造器的 id 参数改为 impl AsIdSalt
    • WidgetType 变为 egui::Role(AccessKit)的弃用别名,WidgetInfo::button / WidgetInfo::label 被删除,改用 WidgetInfo::labeled(Role::…, …)
    • Ui::id 改名为 Ui::scope_id
    • ViewportCommand::Screenshot 改为回调式 ScreenshotCallback
    • 默认配置下支持彩色 emoji

相关链接

许可证

本项目采用 Unlicense 许可证(公共领域贡献)。 具体条款请参阅 LICENSE 文件。

About

Egui中文教程

Topics

Resources

Stars

3 stars

Watchers

0 watching

Forks

Contributors