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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
use std::collections::HashMap;
use egui::{
epaint::{PathShape, RectShape},
pos2, remap, vec2, Color32, Rect, Rgba, RichText, Rounding, Sense, Shape, Stroke, TextStyle, Vec2, WidgetText,
};
use renet::{ClientId, NetworkInfo, RenetServer};
use circular_buffer::CircularBuffer;
mod circular_buffer;
/// Egui visualizer for the renet client. Draws graphs with metrics:
/// RTT, Packet Loss, Kbitps Sent/Received.
///
/// N: determines how many values are shown in the graph.
/// 200 is a good value, if updated at 60 fps the graphs would hold 3 seconds of data.
#[cfg_attr(feature = "bevy", derive(bevy_ecs::system::Resource))]
pub struct RenetClientVisualizer<const N: usize> {
rtt: CircularBuffer<N, f32>,
sent_bandwidth_kbps: CircularBuffer<N, f32>,
received_bandwidth_kbps: CircularBuffer<N, f32>,
packet_loss: CircularBuffer<N, f32>,
style: RenetVisualizerStyle,
}
/// Egui visualizer for the renet server. Draws graphs for each connected client with metrics:
/// RTT, Packet Loss, Kbitps Sent/Received.
///
/// N: determines how many values are shown in the graph.
/// 200 is a good value, if updated at 60 fps the graphs would hold 3 seconds of data.
#[cfg_attr(feature = "bevy", derive(bevy_ecs::system::Resource))]
pub struct RenetServerVisualizer<const N: usize> {
show_all_clients: bool,
selected_client: Option<ClientId>,
clients: HashMap<ClientId, RenetClientVisualizer<N>>,
style: RenetVisualizerStyle,
}
/// Style configuration for the visualizer. Customize size, color and line width.
#[derive(Debug, Clone)]
pub struct RenetVisualizerStyle {
pub width: f32,
pub height: f32,
pub text_color: Color32,
pub rectangle_stroke: Stroke,
pub line_stroke: Stroke,
}
enum TopValue {
SuggestedValues([f32; 5]),
MaxValue { multiplicated: f32 },
}
enum TextFormat {
Percentage,
Normal,
}
impl Default for RenetVisualizerStyle {
fn default() -> Self {
Self {
width: 200.,
height: 100.,
text_color: Color32::WHITE,
rectangle_stroke: Stroke::new(1., Color32::WHITE),
line_stroke: Stroke::new(1., Color32::WHITE),
}
}
}
impl<const N: usize> Default for RenetClientVisualizer<N> {
fn default() -> Self {
RenetClientVisualizer::new(RenetVisualizerStyle::default())
}
}
impl<const N: usize> Default for RenetServerVisualizer<N> {
fn default() -> Self {
RenetServerVisualizer::new(RenetVisualizerStyle::default())
}
}
impl<const N: usize> RenetClientVisualizer<N> {
pub fn new(style: RenetVisualizerStyle) -> Self {
Self {
rtt: CircularBuffer::default(),
sent_bandwidth_kbps: CircularBuffer::default(),
received_bandwidth_kbps: CircularBuffer::default(),
packet_loss: CircularBuffer::default(),
style,
}
}
/// Add the network information from the client. Should be called every time the client
/// updates.
///
/// # Usage
/// ```
/// # use renet::{RenetClient, ConnectionConfig};
/// # use renet_visualizer::RenetClientVisualizer;
/// # let mut client = RenetClient::new(ConnectionConfig::default());
/// # let delta = std::time::Duration::ZERO;
/// # let mut visualizer = RenetClientVisualizer::<5>::new(Default::default());
/// client.update(delta);
/// visualizer.add_network_info(client.network_info());
/// ```
pub fn add_network_info(&mut self, network_info: NetworkInfo) {
self.rtt.push((network_info.rtt * 1000.) as f32);
self.sent_bandwidth_kbps
.push((network_info.bytes_sent_per_second * 8. / 1000.) as f32);
self.received_bandwidth_kbps
.push((network_info.bytes_received_per_second * 8. / 1000.) as f32);
self.packet_loss.push(network_info.packet_loss as f32);
}
/// Renders a new window with all the graphs metrics drawn.
pub fn show_window(&self, ctx: &egui::Context) {
egui::Window::new("Client Network Info")
.resizable(false)
.collapsible(true)
.show(ctx, |ui| {
ui.horizontal(|ui| {
self.draw_all(ui);
});
});
}
/// Draws only the Received Kilobits Per Second metric.
pub fn draw_received_kbps(&self, ui: &mut egui::Ui) {
show_graph(
ui,
&self.style,
"Received Kbitps",
TextFormat::Normal,
TopValue::MaxValue { multiplicated: 1.5 },
self.received_bandwidth_kbps.as_vec(),
);
}
/// Draws only the Sent Kilobits Per Second metric.
pub fn draw_sent_kbps(&self, ui: &mut egui::Ui) {
show_graph(
ui,
&self.style,
"Sent Kbitps",
TextFormat::Normal,
TopValue::MaxValue { multiplicated: 1.5 },
self.sent_bandwidth_kbps.as_vec(),
);
}
/// Draws only the Packet Loss metric.
pub fn draw_packet_loss(&self, ui: &mut egui::Ui) {
show_graph(
ui,
&self.style,
"Packet Loss",
TextFormat::Percentage,
TopValue::SuggestedValues([0.05, 0.1, 0.25, 0.5, 1.]),
self.packet_loss.as_vec(),
);
}
/// Draws only the Round Time Trip metric.
pub fn draw_rtt(&self, ui: &mut egui::Ui) {
show_graph(
ui,
&self.style,
"Round Time Trip (ms)",
TextFormat::Normal,
TopValue::SuggestedValues([32., 64., 128., 256., 512.]),
self.rtt.as_vec(),
);
}
/// Draw all metrics without a window or layout.
pub fn draw_all(&self, ui: &mut egui::Ui) {
self.draw_received_kbps(ui);
self.draw_sent_kbps(ui);
self.draw_rtt(ui);
self.draw_packet_loss(ui);
}
}
impl<const N: usize> RenetServerVisualizer<N> {
pub fn new(style: RenetVisualizerStyle) -> Self {
Self {
show_all_clients: false,
selected_client: None,
clients: HashMap::new(),
style,
}
}
/// Add a new client to keep track off. Should be called whenever a new client
/// connected event is received.
///
/// # Usage
/// ```
/// # use renet::{RenetServer, ServerEvent, ConnectionConfig};
/// # use renet_visualizer::RenetServerVisualizer;
/// # let mut renet_server = RenetServer::new(ConnectionConfig::default());
/// # let mut visualizer = RenetServerVisualizer::<5>::new(Default::default());
/// while let Some(event) = renet_server.get_event() {
/// match event {
/// ServerEvent::ClientConnected { client_id } => {
/// visualizer.add_client(client_id);
/// // ...
/// }
/// _ => {}
/// }
/// }
/// ```
pub fn add_client(&mut self, client_id: ClientId) {
self.clients.insert(client_id, RenetClientVisualizer::new(self.style.clone()));
}
/// Remove a client from the visualizer. Should be called whenever a client
/// disconnected event is received.
///
/// # Usage
/// ```
/// # use renet::{RenetServer, ServerEvent, ConnectionConfig};
/// # use renet_visualizer::RenetServerVisualizer;
/// # let mut renet_server = RenetServer::new(ConnectionConfig::default());
/// # let mut visualizer = RenetServerVisualizer::<5>::new(Default::default());
/// while let Some(event) = renet_server.get_event() {
/// match event {
/// ServerEvent::ClientDisconnected { client_id , reason } => {
/// visualizer.remove_client(client_id);
/// // ...
/// }
/// _ => {}
/// }
/// }
/// ```
pub fn remove_client(&mut self, client_id: ClientId) {
self.clients.remove(&client_id);
}
fn add_network_info(&mut self, client_id: ClientId, network_info: NetworkInfo) {
if let Some(client) = self.clients.get_mut(&client_id) {
client.add_network_info(network_info);
}
}
/// Update the metrics for all connected clients. Should be called every time the server
/// updates.
///
/// # Usage
/// ```
/// # use renet::{RenetServer, ConnectionConfig};
/// # use renet_visualizer::RenetServerVisualizer;
/// # let mut renet_server = RenetServer::new(ConnectionConfig::default());
/// # let mut visualizer = RenetServerVisualizer::<5>::new(Default::default());
/// # let delta = std::time::Duration::ZERO;
/// renet_server.update(delta);
/// visualizer.update(&renet_server);
/// ```
pub fn update(&mut self, server: &RenetServer) {
for client_id in server.clients_id_iter() {
if let Ok(network_info) = server.network_info(client_id) {
self.add_network_info(client_id, network_info);
}
}
}
/// Draw all metrics without a window or layout for the specified client.
pub fn draw_client_metrics(&self, client_id: ClientId, ui: &mut egui::Ui) {
if let Some(client) = self.clients.get(&client_id) {
client.draw_all(ui);
}
}
/// Renders a new window with all the graphs metrics drawn. You can choose to show metrics for
/// all connected clients or for only one chosen by a dropdown.
pub fn show_window(&mut self, ctx: &egui::Context) {
egui::Window::new("Server Network Info")
.resizable(false)
.collapsible(true)
.show(ctx, |ui| {
ui.horizontal(|ui| {
ui.checkbox(&mut self.show_all_clients, "Show all clients");
ui.add_enabled_ui(!self.show_all_clients, |ui| {
let selected_text = match self.selected_client {
Some(client_id) => format!("{}", client_id),
None => "------".to_string(),
};
egui::ComboBox::from_label("Select client")
.selected_text(selected_text)
.show_ui(ui, |ui| {
for client_id in self.clients.keys() {
ui.selectable_value(&mut self.selected_client, Some(*client_id), format!("{}", client_id));
}
})
});
});
ui.vertical(|ui| {
if self.show_all_clients {
for (client_id, client) in self.clients.iter() {
ui.vertical(|ui| {
ui.heading(format!("Client {}", client_id));
ui.horizontal(|ui| {
client.draw_all(ui);
});
});
}
} else if let Some(selected_client) = self.selected_client {
if let Some(client) = self.clients.get(&selected_client) {
ui.horizontal(|ui| {
client.draw_all(ui);
});
}
}
});
});
}
}
fn show_graph(
ui: &mut egui::Ui,
style: &RenetVisualizerStyle,
label: &str,
text_format: TextFormat,
top_value: TopValue,
values: Vec<f32>,
) {
if values.is_empty() {
return;
}
ui.vertical(|ui| {
ui.label(RichText::new(label).heading().color(style.text_color));
let last_value = values.last().unwrap();
let min = 0.0;
let mut max = values.iter().copied().fold(f32::NEG_INFINITY, f32::max);
match top_value {
TopValue::MaxValue { multiplicated } => {
max *= multiplicated;
}
TopValue::SuggestedValues(suggested_values) => {
for value in suggested_values.into_iter() {
if max < value {
max = value;
break;
}
}
}
}
let spacing_x = ui.spacing().item_spacing.x;
let last_text: WidgetText = match text_format {
TextFormat::Normal => format!("{:.2}", last_value).into(),
TextFormat::Percentage => format!("{:.1}%", last_value * 100.).into(),
};
let galley = last_text.into_galley(ui, Some(false), f32::INFINITY, TextStyle::Button);
let (outer_rect, _) = ui.allocate_exact_size(Vec2::new(style.width + galley.size().x + spacing_x, style.height), Sense::hover());
let rect = Rect::from_min_size(outer_rect.left_top(), vec2(style.width, style.height));
let text_pos = rect.right_center() + vec2(spacing_x / 2.0, -galley.size().y / 2.);
galley.paint_with_fallback_color(&ui.painter().with_clip_rect(outer_rect), text_pos, style.text_color);
let body = Shape::Rect(RectShape {
rect,
rounding: Rounding::ZERO,
fill: Rgba::TRANSPARENT.into(),
stroke: style.rectangle_stroke,
uv: Rect::ZERO,
fill_texture_id: egui::TextureId::Managed(0),
});
ui.painter().add(body);
let init_point = rect.left_bottom();
let size = values.len();
let points = values
.iter()
.enumerate()
.map(|(i, value)| {
let x = remap(i as f32, 0.0..=size as f32, 0.0..=style.width);
let y = remap(*value, min..=max, 0.0..=style.height);
pos2(x + init_point.x, init_point.y - y)
})
.collect();
let path = PathShape::line(points, style.line_stroke);
ui.painter().add(path);
{
let text: WidgetText = match text_format {
TextFormat::Normal => format!("{:.0}", max).into(),
TextFormat::Percentage => format!("{:.0}%", max * 100.).into(),
};
let galley = text.into_galley(ui, Some(false), f32::INFINITY, TextStyle::Button);
let text_pos = rect.left_top() + Vec2::new(0.0, galley.size().y / 2.) + vec2(spacing_x, 0.0);
galley.paint_with_fallback_color(&ui.painter().with_clip_rect(rect), text_pos, style.text_color);
}
{
let text: WidgetText = match text_format {
TextFormat::Normal => format!("{:.0}", min).into(),
TextFormat::Percentage => format!("{:.0}%", min * 100.).into(),
};
let galley = text.into_galley(ui, Some(false), f32::INFINITY, TextStyle::Button);
let text_pos = rect.left_bottom() - Vec2::new(0.0, galley.size().y * 1.5) + vec2(spacing_x, 0.0);
galley.paint_with_fallback_color(&ui.painter().with_clip_rect(rect), text_pos, style.text_color);
}
});
}