mirror of https://github.com/emilk/egui.git synced 2026-08-29 12:50:04 -04:00

Files

Nicolas 77df407f50 egui_kittest: add failed_pixel_count_threshold (#7092 )

I thought about this - so we have two options here:
1. adding it to `SnapshotOptions` 
2. adding it to every function which I do not like as this would be a
huge breaking change

## Summary

This pull request introduces a new feature to the `SnapshotOptions`
struct in the `egui_kittest` crate, allowing users to specify a
permissible percentage of pixel differences (`diff_percentage`) before a
snapshot comparison is considered a failure. This feature provides more
flexibility in handling minor visual discrepancies during snapshot
testing.

### Additions to `SnapshotOptions`:

* Added a new field `diff_percentage` of type `Option<f64>` to the
`SnapshotOptions` struct. This field allows users to define a tolerance
for pixel differences, with a default value of `None` (interpreted as 0%
tolerance).
* Updated the `Default` implementation of `SnapshotOptions` to
initialize `diff_percentage` to `None`.

### Integration into snapshot comparison logic:

* Updated the `try_image_snapshot_options` function to handle the new
`diff_percentage` field. If a `diff_percentage` is specified, the
function calculates the percentage of differing pixels and allows the
snapshot to pass if the difference is within the specified tolerance.
[[1]](diffhunk://#diff-6f481b5866b82a4fe126b7df2e6c9669040c79d1d200d76b87f376de5dec5065R204)
[[2]](diffhunk://#diff-6f481b5866b82a4fe126b7df2e6c9669040c79d1d200d76b87f376de5dec5065R294-R301)

* Closes <https://github.com/emilk/egui/issues/5683>
* [x] I have followed the instructions in the PR template

---------

Co-authored-by: lucasmerlin <hi@lucasmerlin.me>
Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>

2025-07-03 14:23:15 +02:00

benches

Use Rust edition 2024 (#7280 )

2025-06-30 14:01:57 +02:00

data

Fix incorrect color fringe colors on SVG:s (#7069 )

2025-05-21 17:18:36 +02:00

src

egui_kittest: add failed_pixel_count_threshold (#7092 )

2025-07-03 14:23:15 +02:00

tests/snapshots

Improve text rendering in light mode (#7290 )

2025-07-02 14:58:37 +02:00

Cargo.toml

Include test windows in egui_demo_lib snapshot tests (#7070 )

2025-05-21 17:44:27 +02:00

README.md

Add button benchmark (#6854 )

2025-04-28 11:58:05 +02:00

README.md

`egui` demo library

This crate contains example code for egui.

The demo library is a separate crate for three reasons:

To ensure it only uses the public egui api.
To remove the amount of code in egui proper.
To make it easy for 3rd party egui integrations to use it for tests.
- See for instance https://github.com/not-fl3/egui-miniquad/blob/master/examples/demo.rs

This crate also contains benchmarks for egui. Run them with

# Run all benchmarks
cargo bench -p egui_demo_lib 

# Run a single benchmark
cargo bench -p egui_demo_lib "benchmark name"

# Profile benchmarks with cargo-flamegraph (--root flag is necessary for MacOS)
CARGO_PROFILE_BENCH_DEBUG=true cargo flamegraph --bench benchmark --root -p egui_demo_lib  -- --bench "benchmark name"

# Profile with cargo-instruments
CARGO_PROFILE_BENCH_DEBUG=true cargo instruments --profile bench --bench benchmark -p egui_demo_lib -t time -- --bench "benchmark name"

README.md

egui demo library

`egui` demo library