|
1 | | -# Intel® X<sup>e</sup>SS Inspector |
| 1 | +# Intel® XeSS Inspector |
2 | 2 |
|
3 | | -Intel® X<sup>e</sup>SS Inspector is a debugging and validation tool for [Intel® Xe Super Sampling (X<sup>e</sup>SS)](https://www.intel.com/content/www/us/en/products/docs/discrete-gpus/arc/technology/xess.html). Its primary goal is to simplify the integration and debugging process for X<sup>e</sup>SS. |
| 3 | +Intel® XeSS Inspector is a powerful debugging and validation tool designed for Intel® XeSS. It supports Intel® XeSS Super Resolution (XeSS-SR), Intel® XeSS Frame Generation (XeSS-FG), and Intel® Xe Low Latency (XeLL). |
4 | 4 |
|
5 | 5 | <img src="image/overview.png" alt="Overview" width="70%" /> |
6 | 6 |
|
7 | | -## Key capabilities of Intel® XeSS Inspector |
| 7 | +## Download |
8 | 8 |
|
9 | | -### Real-Time State Display and Analysis |
10 | | -The Intel® XeSS Inspector provides a real-time display of XeSS state information, including all initialization and execution parameters. With GPU and CPU times measured and displayed in real-time, it enables developers to dynamically monitor the impact of XeSS on their application's performance. |
| 9 | +Download the latest build from the [Releases page](https://github.com/GameTechDev/XeSSInspector/releases). |
11 | 10 |
|
12 | | -### Frame Dump Capability |
13 | | -With the frame dump feature, developers can facilitate the offline analysis and debugging of frames processed by XeSS, without any additional integration steps to enable dumping. |
| 11 | +## Key Features |
14 | 12 |
|
15 | | -### HUD Overlay for Visual Debugging |
16 | | -The HUD overlay feature allows for direct visualization of XeSS input buffers on the target application, supporting different views for various buffer types and enhancing the debugging process. |
| 13 | +### Context View |
17 | 14 |
|
18 | | -### State Overrides for Experimentation |
19 | | -State overrides enable quick experimentations with different parameters, without any code modifications. Currently, the tool supports these experiments: |
20 | | -- Exposure scale |
21 | | -- Exposure multiplier* (Available from XeSS SDK 1.3) |
22 | | -- Jitter scale |
23 | | -- Velocity scale |
24 | | -- Quality level preset |
25 | | -- Initialization flags |
| 15 | +Intel® XeSS Inspector supports all three technologies: XeSS-SR, XeSS-FG, and XeLL. The tool groups the contexts of these technologies on the UI, with each context presented as a tab. Under each tab, detailed information and support for the respective technology are displayed. |
26 | 16 |
|
27 | | -## Prerequisites and Compatibility |
28 | | -The Intel® XeSS Inspector is a Windows x64 program that depends on DX12. It is compatible with all platforms that support Intel® XeSS. Please ensure that your target application is running in DX12 mode without anti-cheating or anti-debugging measures when using the XeSS Inspector. |
| 17 | +### Real-Time State Display |
29 | 18 |
|
30 | | -## Releases |
31 | | -For access to the latest features and fixes, download the most recent build from the [Releases page](https://github.com/GameTechDev/XeSSInspector/releases). |
| 19 | +Monitors XeSS state information, including initialization and execution parameters, CPU/GPU times, Sleep and Low Latency marker state of XeLL and more. |
| 20 | + |
| 21 | +### Frame Dump |
| 22 | + |
| 23 | +XeSS Inspector allows you to trigger the XeSS-SR and XeSS-FG frame dump features. You can dump the input and output of XeSS-SR and XeSS-FG integrations and check them offline. |
| 24 | + |
| 25 | +### HUD Overlay |
| 26 | + |
| 27 | +The tool enables you to visualize XeSS-SR input buffers on the target application as HUD output. You can choose different views with channels, histograms, and other controls. Different visualizations are used for different buffer types. |
| 28 | + |
| 29 | +### State Overrides |
| 30 | + |
| 31 | +XeSS Inspector allows you to perform quick experiments on the XeSS-SR context for debugging purposes without any code changes or API integration. |
| 32 | + |
| 33 | +## Prerequisites |
| 34 | + |
| 35 | +- The target application must have an XeSS 2 technology integrated (XeSS-SR, XeSS-FG or XeLL). |
| 36 | +- The target application must not be protected by any anti-cheating or anti-debugging measures. |
32 | 37 |
|
33 | 38 | ## Documentation |
34 | | -The tool is designed to be intuitive. For quick start guidance and additional resources, please visit https://intel.com/xess-inspector. |
| 39 | + |
| 40 | +For quick start guidance and additional resources, visit [Intel® XeSS Inspector documentation](https://intel.com/xess-inspector). |
0 commit comments