Skip to content

Commit 3118762

Browse files
committed
Update readme
1 parent c620288 commit 3118762

File tree

10 files changed

+70
-11
lines changed

10 files changed

+70
-11
lines changed

Docs/create_sample.png

157 KB
Loading

Docs/dlss_xess.png

31.6 KB
Loading

Docs/enable_dynamic.png

9.72 KB
Loading

Docs/loadonstartup.png

5.02 KB
Loading

Docs/package_folder.png

8.25 KB
Loading

Docs/unity_issue.png

331 KB
Loading

Docs/xess_only.png

21.3 KB
Loading

LICENSE

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
MIT License
2-
3-
Copyright (c) 2025 GameTechDev
1+
Copyright 2021-2025 Intel Corporation
42

53
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
4+
of this software and associated documentation files(the "Software"), to deal
75
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
6+
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
97
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
8+
furnished to do so, subject to the following conditions :
119

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
10+
The above copyright notice and this permission notice shall be included in
11+
all copies or substantial portions of the Software.
1412

1513
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1614
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
1816
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1917
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Intel® X<sup>e</sup>SS Plugin for Unity* Engine
2+
3+
## Introduction
4+
This plugin integrates Intel® Xe Super Sampling (X<sup>e</sup>SS) into the Unity Engine.
5+
* The plugin now supports the HDRP/SRP render pipeline.
6+
* Supported graphics API: DX12.
7+
8+
Intel® X<sup>e</sup>SS enables innovative framerate boosting technology supported by Intel® Arc™ graphics cards and other GPU vendors. Using AI deep-learning for upscaling, X<sup>e</sup>SS offers higher framerates without degrading image quality.
9+
For more information, visit: [Intel® X<sup>e</sup>SS GitHub](https://github.com/intel/xess)
10+
11+
## Components
12+
* `com.intel.xess` - XeSS main C# package for Unity for XeSS SDK
13+
* `UnityXeSSPlugin` - XeSS native plugin source code for Unity
14+
* `[email protected]` - Modified Unity HDRP rendering pipeline (14.0.11) code for Unity 2022 LTS
15+
* `HDRP Samples` - Please check the "Release" section for the samples (with `vk.bat` to start with Vulkan, `dx12.bat` to start with DX12, and `dx11.bat` to start with DX11)
16+
17+
## How to Enable XeSS in HDRP Samples
18+
### Integrating `com.intel.xess` into HDRP Unity Sample
19+
* Use this HDRP template to create the HDRP project in Unity 2022 LTS version.
20+
21+
![Create Sample](Docs/create_sample.png?raw=true "Create Sample")
22+
23+
* When the project is loaded, close the project and move the `\Library\PackageCache\[email protected]` folder to the `\Packages` folder with the XeSS package as shown below. This will allow you to modify the HDRP pipeline with your code.
24+
25+
![Package Folder](Docs/package_folder.png?raw=true "Package Folder")
26+
27+
* Replace the `[email protected]` with the modified one in the repository to enable XeSS for HDRP.
28+
29+
* Ensure the core plugin `Packages\com.intel.xess\RunTime\Bin\XeSSRenderingPlugin.dll` is loaded on startup.
30+
31+
![Plugin Load on Startup](Docs/loadonstartup.png?raw=true "Plugin Load on Startup")
32+
33+
* Enable dynamic resolution support in the pipeline settings.
34+
35+
![Enable Dynamic Resolution](Docs/enable_dynamic.png?raw=true "Enable Dynamic Resolution")
36+
37+
### Check XeSS in the HDCamera Settings
38+
* XeSS supported only
39+
40+
![XeSS Only](Docs/xess_only.png?raw=true "XeSS Only")
41+
42+
* DLSS & XeSS supported, with DLSS having higher priority
43+
44+
![DLSS and XeSS](Docs/dlss_xess.png?raw=true "DLSS and XeSS")
45+
46+
**_Attention: Both DLSS & XeSS require dynamic resolution to be enabled!_**
47+
48+
## Integrating `com.intel.xess` into Your Own HDRP/SRP Details
49+
* An XeSS context corresponds to an HDCamera in Unity HDRP.
50+
* The main XeSS pass integration is located in `[email protected]\Runtime\RenderPipeline\RenderPass\XeSSPass.cs`.
51+
* Use `com.intel.xess` to integrate your own XeSS in SRP and use `XeSSPass.cs` as a reference.
52+
53+
## Known Unity Plugin Issue
54+
* Unity has a DX12 plugin fix in version 2022.3.39f1. Ensure your Unity engine version is greater than or equal to 2022.3.39f1.
55+
56+
![Unity Issue](Docs/unity_issue.png?raw=true "Unity Issue")

SECURITY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security Policy
2+
Intel is committed to rapidly addressing security vulnerabilities affecting our customers and providing clear guidance on the solution, impact, severity and mitigation.
3+
4+
## Reporting a Vulnerability
5+
Please report any security vulnerabilities in this project [utilizing the guidelines here](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html).

0 commit comments

Comments
 (0)