Support remote rendering #3323
Support remote rendering #3323
Conversation
There was a problem hiding this comment.
Very interesting! Using serde-diff is a nice idea that i missed in eterm.
I only took a brief look: are you serializing Shapes directly then? Does that work when adding new glyphs, e.g. by pasting in some emojis in a TextEdit? I had problems with that in eterm.
Is it running synchronously, waiting for the next frame before returning?
| let full_output_diff = received_message.into_text(); | ||
|
|
||
| if let Ok(diff) = full_output_diff { | ||
| let deserialized: egui::FullOutput = serde_json::from_str(&diff).unwrap(); |
There was a problem hiding this comment.
Using json for this will be very slow and wasteful - I suggest using bincode or MsgPack instead
There was a problem hiding this comment.
In my earlier tests I experimented with those formats, and found no visible difference in performance. I ended up sticking with json because it was (surprisingly) the quickest at serializing, and server-side speed was my priority. This may have been specific to my use case though. Given that json also causes the INF and NAN issues it may be best to change it regardless.
| .default_pos(egui::pos2(100.0, 0.0)) | ||
| .show(&ctx, |ui| { | ||
| ui.label(format!("Count: {:?}", count)); | ||
| }); |
There was a problem hiding this comment.
You can use egui_demo_lib instead - that would give a more convincing example, and a better benchmark for performance!
| where | ||
| S: serde::Serializer, | ||
| { | ||
| // Workaround for the fact that INFINITY and NEG_INFINITY serialize as null and then fail to deserialize |
There was a problem hiding this comment.
Only in JSON. Most other formats support INF and NAN.
Co-authored-by: Emil Ernerfeldt <[email protected]>
|
It serializes FullOutput directly by implementing Serialize and Deserialize for FullOutput and all of its fields. Shapes are done in this way, with the exception that Callback does not work (serde(skip) is used to ignore it).
The examples are running synchronously yes, as this was sufficient for my purposes. I don't think switching to asynchronous would be too much of a problem if that is preferable. |
Support the ability to render egui remotely using eframe, inspired by these imgui projects:
Addresses the feature request discussed here: #3292
An example is included in examples/remote_rendering of how to set this up. This example uses the tungstenite crate to create websockets for the client and server, but other client/server set ups should work too.
As a basic overview, the server sends the serialised FullOutput to the client to render it, and the client sends RawInput back to the server.
serde-diff is being included as a feature flag (though this won't currently run, I need to fix some errors). Performance is greatly improved when using it, but it requires a couple of pull requests to be merged in order for it to work (amethyst/serde-diff#36 and amethyst/serde-diff#45), and currently the crate is unmaintained. While a way forward is being looked into for that, the remote_rendering works without but is a bit slow.