Add Harness::new_eframe and TestRenderer trait
#5539
Conversation
lucasmerlin
force-pushed
the
lucas/kittest-eframe-app
branch
from
8746345 to
77ce48b
Compare
|
Preview available at https://egui-pr-preview.github.io/pr/5539-lucaskittest-eframe-app |
lucasmerlin
force-pushed
the
lucas/kittest-eframe-app
branch
3 times, most recently
from
8f5f0ec to
8eee137
Compare
|
Tests should pass once #5542 is merged and this is rebased |
lucasmerlin
changed the title
Harness::new_eframeHarness::new_eframe and TestRenderer trait
There was a problem hiding this comment.
It just works! ✨
| /// In order to access the [`eframe::App`] trait from the generic `State`, we store a function pointer | ||
| /// here that will return the dyn trait from the struct. In the builder we have the correct where | ||
| /// clause to be able to create this. | ||
| /// Later we can use it anywhere to get the [`eframe::App`] from the `State`. | ||
| #[cfg(feature = "eframe")] | ||
| type AppKindEframe<'a, State> = (fn(&mut State) -> &mut dyn eframe::App, eframe::Frame); | ||
|
|
||
| pub(crate) enum AppKind<'a, State> { | ||
| Context(AppKindContext<'a>), | ||
| Ui(AppKindUi<'a>), | ||
| ContextState(AppKindContextState<'a, State>), | ||
| UiState(AppKindUiState<'a, State>), | ||
| #[cfg(feature = "eframe")] | ||
| Eframe(AppKindEframe<'a, State>), | ||
| } |
There was a problem hiding this comment.
I wanted to be able to store the eframe::App in the State, so it would be accessible via the already existing Harness::state_mut fns, but I needed some way to access the State as a eframe::App when updating.
I think my solution with the function pointer is really cool, but maybe there is a cleaner way to do it?
There was a problem hiding this comment.
So essentially State is type constrained iff we're in the Eframe variant, but otherwise not 🤔
Lgtm, can't think of a better way either right now
lucasmerlin
force-pushed
the
lucas/kittest-eframe-app
branch
from
8eee137 to
1ef8ad1
Compare
lucasmerlin
force-pushed
the
lucas/kittest-eframe-app
branch
from
1ef8ad1 to
a01927e
Compare
| use egui_kittest::kittest::Queryable; | ||
|
|
||
| #[test] | ||
| fn test_demo_app() { |
There was a problem hiding this comment.
I ran this locally with cargo test -p egui_demo_app at first without --all-features and then got issues because the top bar has different number of tabs. A bit unfortunate :/
With --all-features it works for the most part, but I need to bump various threshholds.
Edit: Of course this affects lotsa tests. I'll put this in after I landed my "prefer software rasterizer for testing" change as this may (!) stablize it a bit!
| /// In order to access the [`eframe::App`] trait from the generic `State`, we store a function pointer | ||
| /// here that will return the dyn trait from the struct. In the builder we have the correct where | ||
| /// clause to be able to create this. | ||
| /// Later we can use it anywhere to get the [`eframe::App`] from the `State`. | ||
| #[cfg(feature = "eframe")] | ||
| type AppKindEframe<'a, State> = (fn(&mut State) -> &mut dyn eframe::App, eframe::Frame); | ||
|
|
||
| pub(crate) enum AppKind<'a, State> { | ||
| Context(AppKindContext<'a>), | ||
| Ui(AppKindUi<'a>), | ||
| ContextState(AppKindContextState<'a, State>), | ||
| UiState(AppKindUiState<'a, State>), | ||
| #[cfg(feature = "eframe")] | ||
| Eframe(AppKindEframe<'a, State>), | ||
| } |
There was a problem hiding this comment.
So essentially State is type constrained iff we're in the Eframe variant, but otherwise not 🤔
Lgtm, can't think of a better way either right now
| fn render(&mut self, ctx: &Context, output: &FullOutput) -> Result<RgbaImage, String>; | ||
| } | ||
|
|
||
| /// A lazy renderer that initializes the renderer on the first render call. |
There was a problem hiding this comment.
Would be even better if we wouldn't need to initialize the renderer for each TestHarness individually 🤔
(But that might get hairy quickly and a user can always bring their own renderer for that :))
This allows creating
egui_kittest::Harnesses fromeframe::Apps.I also introduce a new
TestRenderertrait and aWgpuTestRenderer. I really didn't like how tightly egui_kittest was coupled to wgpu. This should make it possible to create e.g. aGlowTestRendererin oder to support custom glow rendering with PaintCallbacks.HarnessBuildernow has an option to initialize a WgpuTestRenderer, either from a default configuration (this should be updated based on #5506) or a WgpuSetup or existing RenderState.I also introduce a
LazyTestRendererwhich basically has the old behavior. In the uninitialized state it remembers the TextureDeltas and a closure to create the actual test renderer. When rendering a snapshot, it will actually initialize the wgpu renderer and apply the texture deltas. This means tests without any snapshots will save the overhead of having to create the wgpu resources and tests with snapshots will continue to work fine without having to configure wgpu in the beginning.I also renamed
Harness::wgpu_snapshotetc... toHarness::snapshot.eframe_kittestto test a wholeeframe::App#5389