vpdiff

The vpdiff tool is used by Squish to compare Screenshot Verification Points with external image files. In most cases, it pops up the same GUI that you can see if you right-click on a failed Screenshot VP in the Test Results of Squish IDE, and select Show Differences.

The full list of options are displayed when you pass --help-all. This page will explain its basic usage.

Usage

vpdiff --vpFile filePath --widgetName objectName [options]

Options

The two required options are:

  • --vpFile filePath is the path to the XML Screenshot Verification Point
  • --widgetName objectName is the name of the object as it appears in the VP file. A Screenshot VP may contain more than one widget to verify.

There are additional options which can be supplied:

  • --actualImage imageFileName.png compares the VP to an external image file
  • --outputImage outputImageFile.png creates an image that shows the differences between the actual and the expected images, instead of popping up a GUI.

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.
The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.
Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Search Results