eGUI 教程:搭建与使用入门
本教程将引导你了解 eGUI,一个 Rust 编写的跨平台即时模式图形用户界面库。我们将涵盖其目录结构、启动文件以及配置文件的基础知识。
1. 项目目录结构及介绍
在克隆 https://github.com/emilk/egui.git
仓库后,你会看到以下基本的目录结构:
├── Cargo.toml # 项目的核心依赖信息
├── examples/ # 各种示例代码
│ ├── basic # 基础示例
│ ├── web # 在Web上运行的示例
│ └── ... # 其他示例
├── src/ # 主要源代码
│ ├── lib.rs # 库的主要实现
│ └── ... # 更多源代码
├── tests/ # 单元测试和集成测试
└── benchmarks/ # 性能基准测试
Cargo.toml
: 项目的配置文件,列出所有依赖和版本。examples/
: 包含各种示例应用,演示了如何使用 eGUI 创建不同类型的界面。src/
: 项目的主要代码存储库,包含核心库的实现。tests/
: 测试代码,确保 eGUI 的功能正确无误。benchmarks/
: 性能测试,用于衡量 eGUI 的性能表现。
2. 项目的启动文件介绍
eGUI 是一个库而非独立的应用程序,因此没有单一的启动文件。然而,你可以从 examples/
目录下的任何示例来了解如何创建一个简单的 eGUI 应用。例如,在 basic/main.rs
中,你会发现如下启动代码模板:
use eframe::{Eframe, egui};
fn main() {
let mut app = Eframe::new("My egui App", "eframe").expect("Could not create eframe");
app.run(|ctx| my_ui(ctx));
}
fn my_ui(ui: &egui::Ui) {
// 在这里编写你的 eGUI 用户界面代码
}
这段代码创建了一个名为“My egui App”的新应用,并调用了 my_ui
函数来构建实际的界面。
3. 项目的配置文件介绍
eGUI 本身不使用特定的配置文件,因为它是一个即时模式 GUI 库,大部分设置是通过代码动态控制的。但是,当你使用 eGUI 集成到自己的项目中时,你可能需要创建自定义的配置文件来存储应用程序或特定集成的相关设定。
例如,如果你正在使用 eframe(一个 eGUI 的方便框架),你可以在你的主程序中引入配置,像这样:
use std::fs;
use serde::{Deserialize, Serialize};
#[derive(Debug, Deserialize, Serialize)]
struct AppConfig {
window_title: String,
initial_size: (u32, u32),
}
// 加载配置文件
fn load_config() -> AppConfig {
let config_path = std::path::PathBuf::from("app_config.json");
let json_str = match fs::read_to_string(config_path) {
Ok(s) => s,
Err(_) => {
println!("No config file found, using default settings.");
return AppConfig {
window_title: "Default App".to_string(),
initial_size: (800, 600),
};
}
};
let config: AppConfig = serde_json::from_str(json_str.as_ref()).unwrap_or_default();
config
}
fn main() {
let app_config = load_config();
let mut app = Eframe::new(&app_config.window_title, "eframe")
.with_initial_size(app_config.initial_size)
.expect("Could not create eframe");
app.run(|ctx| my_ui(ctx));
}
在这个例子中,我们创建了一个 AppConfig
结构体来存储窗口的标题和初始大小,然后从 JSON 文件加载这些设置。
通过遵循这个结构,你就能开始使用 eGUI 来创建你自己的跨平台图形用户界面了。更多详细信息和使用示例,请参考官方文档:https://docs.rs/egui。