firka/flutter
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved readme for golden tests. (flutter/engine#40679)

Browse Source 
Improved readme for impeller golden tests.
This commit is contained in:
gaaclarke
2023-03-27 16:24:53 -07:00
committed by GitHub
parent 9e9590a68f
commit b9fe5d10f1
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
engine/src/flutter/impeller/golden_tests/README.md
View File

@@ -18,3 +18,18 @@ Example invocation:
Currently these tests are only supported on macOS and only test the Metal
backend to Impeller.
## Adding tests
To add a golden image test, the `impeller_golden_tests` target must be modified
to generate the correct image and modification to its generated `digest.json`.
If a test case is added to [golden_tests.cc](./golden_tests.cc), for example
"GoldenTests.FooBar", that will turn into the golden test
"impeller_GoldenTests_Foobar" automatically if the `SaveScreenshot()` function
is used.
The examples in `golden_tests.cc` use GLFW for rendering the tests, but
technically anything could be used. Using the `SaveScreenshot()` function will
automatically update the `GoldenDigest::Instance()` which will make sure that it
is included in the generated `digest.json`. If that function isn't used the
`GoldenDigest` should be updated manually.