ggez-egui 0.2.0

A simple implementation of egui for ggez
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

mod input;
mod painter;
pub use input::Input;
use painter::Painter;
use std::{cell::RefCell, ops::Deref, rc::Rc};
use ggez::graphics::{self, Drawable};

pub use egui;

/// Contains a copy of [`egui::Context`] and a mutable reference for the paint_jobs vector from [`Painter`].
///
/// When is droped automatically will call [`egui::Context::end_frame`] function and update the paint_jobs
pub struct EguiContext {
	context  : egui::Context,
	painter  : Rc<RefCell<Painter>>,
	clipboard: Rc<RefCell<String >>,
}

impl Deref for EguiContext {
	type Target = egui::Context;
	fn deref(&self) -> &Self::Target {
		&self.context
	}
}

impl Drop for EguiContext {
	fn drop(&mut self) {
		let egui::FullOutput {
			platform_output,
			needs_repaint: _,
			textures_delta,
			shapes,
		} = self.context.end_frame();

		if !platform_output.copied_text.is_empty() {
			*self.clipboard.borrow_mut() = platform_output.copied_text;
		}
		self.painter.borrow_mut().paint_jobs = self.context.tessellate(shapes);
		self.painter.borrow_mut().textures_delta.push_front(textures_delta);
	}
}

/// Contains and handles everything related to [`egui`]
#[derive(Default)]
pub struct EguiBackend {
	context: egui::Context,
	pub input: Input,
	painter: Rc<RefCell<Painter>>,
}

impl EguiBackend {
	/// Create a [`EguiBackend`] with extra information for use the [`Input::set_scale_factor`]
	pub fn new(ctx: &ggez::Context) -> Self {
		let mut input = Input::default();
		let (w, h) = graphics::size(ctx);
		input.set_scale_factor(1.0, (w, h));
		Self {
			input,
			..Default::default()
		}
	}

	/// Return an [`EguiContext`] for update the gui
	pub fn ctx(&mut self) -> EguiContext {
		self.context.begin_frame(self.input.take());
		EguiContext {
			context: self.context.clone(),
			painter: self.painter.clone(),
			clipboard: self.input.clipboard.clone(),
		}
	}
}

impl Drawable for EguiBackend {
	/// this funtion comes from [`Drawable`] trait that allow the struct use the function [`ggez::graphics::draw`]
	/// * Example
	/// ```
	/// struct State {
	/// 	egui_backend: EguiBackend
	/// }
	/// 
	/// impl EventHandler<ggez::GameError> for State {
	/// 	fn draw(&mut self, ctx: &mut ggez::Context) -> {
	/// 		ggez::graphics::draw(ctx, &self.egui_backend, ([0.0, 0.0],))?;
	/// 		...
	/// 	} 
	/// 	...
	/// }
	/// ```
	fn draw(&self, ctx: &mut ggez::Context, _param: ggez::graphics::DrawParam) -> ggez::GameResult {
		self.painter.borrow_mut().draw(ctx, self.input.scale_factor)
	}

	fn dimensions(&self, _ctx: &mut ggez::Context) -> Option<ggez::graphics::Rect> {
		None
	}

	fn blend_mode(&self) -> Option<ggez::graphics::BlendMode> {
		None
	}

	fn set_blend_mode(&mut self, _mode: Option<ggez::graphics::BlendMode>) {}
}