Client gametest screenshot comparison API #4381
Conversation
| * <p>Template images loaded from a path are expected to be in the {@code templates} directory inside the resources | ||
| * directory of the mod which registered the gametest. If the template image is not found, and the | ||
| * {@code fabric.client.gametest.testModResourcesPath} system property is set to the resources folder of the mod which | ||
| * registered the gametest, then the screenshot will be saved to the {@code templates} folder so that it can be used | ||
| * next time the gametest is run. |
There was a problem hiding this comment.
I'm wondering if loom could set this system property by default?
There was a problem hiding this comment.
Yes, we can assume the default path and allow the user to override it in the DSL, can you open an loom issue so its not forgotten about?
Earthcomputer
changed the title
| * <p>Template images loaded from a path are expected to be in the {@code templates} directory inside the resources | ||
| * directory of the mod which registered the gametest. If the template image is not found, and the | ||
| * {@code fabric.client.gametest.testModResourcesPath} system property is set to the resources folder of the mod which | ||
| * registered the gametest, then the screenshot will be saved to the {@code templates} folder so that it can be used | ||
| * next time the gametest is run. |
There was a problem hiding this comment.
Yes, we can assume the default path and allow the user to override it in the DSL, can you open an loom issue so its not forgotten about?
...client/java/net/fabricmc/fabric/impl/client/gametest/TestScreenshotComparisonAlgorithms.java
Show resolved
Hide resolved
modmuss50
added
last call
| * @param <DATA> The type of the image data array | ||
| */ | ||
| @ApiStatus.NonExtendable | ||
| interface RawImage<DATA> { |
There was a problem hiding this comment.
This is a non-extendable interface, but are there any public APIs that create instances of it (ie can it even be used with API code)?
There was a problem hiding this comment.
There are no public APIs to create instances of RawImage, but it can be used by custom implementations of TestScreenshotComparisonAlgorithm
* Add screenshot comparison API * Cleanup and docs * Remove no-longer-needed changes to access widener (cherry picked from commit a069796)
Adds APIs to assert that a screenshot matches or contains a template image.