egui should work on all sinks

[kleinesfilmroellchen]

Might need a large refactor of the framebuffer API, but it should be possible. Then we can use the overlay on all sinks (especially the network streamed ones, which then allows us to skip extra overlays on the display side)

[bits0rcerer]

What do you mean with output?

Output as a egui viewport to display (parts of) the canvas/framebuffer.

When using the egui sink the overlay is only displayed on the first viewport.

breakwater/breakwater-egui-overlay/src/lib.rs

Lines 121 to 124 in 21be613

	// only display on first viewport
	if viewport_idx > 0 {
	return;
	}

By providing a custom overlay you may remove that check.

---

Output as renderer to visualizes the canvas/framebuffer.

In this case the breakwater term is sink. All current sinks use a FrameBuffer

breakwater/breakwater-parser/src/framebuffer/mod.rs

Lines 8 to 32 in 21be613

	pub trait FrameBuffer {
	type Timestamp: Copy = ();
	/// Width in pixels
	fn get_width(&self) -> usize;
	/// Height in pixels
	fn get_height(&self) -> usize;
	/// Returns the number of pixels (not bytes)
	#[inline(always)]
	fn get_size(&self) -> usize {
	self.get_width() * self.get_height()
	}
	/// In case the coordinates are within the framebuffers area, [`Some`] with
	/// the current color is returned, [`None`] otherwise.
	#[inline(always)]
	fn get(&self, x: usize, y: usize) -> Option<u32> {
	if x < self.get_width() && y < self.get_height() {
	Some(unsafe { self.get_unchecked(x, y) })
	} else {
	None
	}
	}

This is the interface to access the canvas pixel data.

A quick way to get the egui overlay into the other sinks would be to duplicate the egui sink, but instead of rendering to the screen we render into a buffer which implements the FrameBuffer trait and gets passed to the other sinks. From the perspective of the other sinks it should look like the overlay was fluted onto the canvas.
But this feels kinda hacky.. a refactor might be more desirable here.

If we reach a consensus on this topic, I'd be happy to implement it and open a PR.

[kleinesfilmroellchen]

I meant sinks.