Files
UnrealEngineUWP/Engine/Documentation/Source/Programming/Automation/ScreenShotComparison/ScreenShotComparisonGuide.INT.udn
Ben Marsh 49831a5631 Include documentation source in repository.
[CL 2489162 by Ben Marsh in Main branch]
2015-03-24 08:35:52 -04:00

56 lines
2.3 KiB
Plaintext

Availability:Public
Title:Screen Shot Comparison User Guide
Crumbs: %ROOT%, Programming, Programming/Automation
Description:Developers's guide to creating and comparing screen shots
Version: 4.5
The screenshot browser tool allows QA to quickly and easily compare screenshots. The screenshots are generated via an automation test, and can be viewed in the Unreal Frontend tool.
A history of screenshots is maintained, so QA can compare the latest screenshots to a history, and identify any obvious rendering errors with the latest build.
## Creating Screen Shots
$ Start a standalone game instance :
For example, start **EmptyGameEditor** with the commandline parameters: **EmptyGame -Game**. However, any standalone game should work.
$ Load the Unreal Frontend app :
This is an external app, and can be found under UE4/Engine/Binaries/Win64:
$ Select the session from the session Frontend tab:
As shown below, this will be named Unnamed Session for the local game you have just started.
$ Run the test :
Deselect all other tests, and select the **Performance Capture** test.
Run the test by clicking the run button. This will start an automation test that takes screenshots from various positions in the AutomationTest map.
[REGION:fullwidth]
![Automation](CaptureScreenShots.png)
[/REGION]
## Viewing Screen Shots
As the screenshots are being captured, they will be sent to the Unreal Frontend app that requested the test. Then the UI will update automatically when it receives a new screenshot.
$ Select **Screen Comparison** from the Session Frontend's *Window* menu :
This will display an UI that update as it receives images.
$ UI Navigation :
Screenshots are shown in capture order based off the change list number that was used when the images were generated. The latest screen is shown on the left, and is locked in place. You can scroll through
the history of each view using the scroll bars.
$ UI Filtering :
You can use the filter bars at the top to filter by screenshot name and / or platform type.
[REGION:fullwidth]
![Automation](ScreenShotComparison.png)
[/REGION]
[REGION:note]
* Screenshots are stored in the Engine\Programs\UnrealFrontend\Saved\Automation\AutomationTest directory, and need to be manually deleted if you wish to remove them from the viewer.
[/REGION]