https://github.com/flaxengine/fidelityfx-fsr
AMD FidelityFX Super Resolution plugin for Flax Engine
https://github.com/flaxengine/fidelityfx-fsr
amd fidelityfx flax flax-engine fsr gamedev graphics
Last synced: 12 months ago
JSON representation
AMD FidelityFX Super Resolution plugin for Flax Engine
- Host: GitHub
- URL: https://github.com/flaxengine/fidelityfx-fsr
- Owner: FlaxEngine
- License: mit
- Created: 2021-07-21T09:11:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T17:27:43.000Z (over 1 year ago)
- Last Synced: 2025-03-26T01:02:44.316Z (12 months ago)
- Topics: amd, fidelityfx, flax, flax-engine, fsr, gamedev, graphics
- Language: C
- Homepage:
- Size: 13 MB
- Stars: 23
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AMD FidelityFX Super Resolution for Flax Engine
[AMD Fidelity FX Super Resolution](https://gpuopen.com/fidelityfx-superresolution/) is a cutting edge super-optimize spatial upsampling technology that produces impressive image quality at fast framerates. This repository contains a plugin project for [Flax Engine](https://flaxengine.com/) games with FSR.
Minimum supported Flax version: `1.2`.
## Installation
1. Clone repo into `\Plugins\FidelityFX-FSR`
2. Add reference to FSR project in your game by modyfying your game `.flaxproj` as follows:
```
...
"References": [
{
"Name": "$(EnginePath)/Flax.flaxproj"
},
{
"Name": "$(ProjectPath)/Plugins/FidelityFX-FSR/FidelityFX-FSR.flaxproj"
}
]
```
3. Test it out!
Finally open Flax Editor - FSR will be visible in Plugins window (under Rendering category). It implements `CustomUpscale` postFx to increase visual quality when using low-res rendering. To test it simply start the game and adjust the **Rendering Percentage** property in *Graphics Quality Window*. Use scale factors provided by AMD to achieve the best quality-performance ratio.
## API
FSR is implemented as a `GamePlugin` and can be accessed as follows to configure effect:
```cs
var postFx = PluginManager.GetPlugin().PostFx;
postFx.Enabled = true; // Enable/disable effect
postFx.Sharpness = 0.25f; // Values in range 0-2 (0=max sharpness)
MainRenderTask.Instance.RenderingPercentage = 0.67f; // Follow AMD docs for scaling factors
```
## License
Both this plugin and FSR are released under **MIT License**.
## Trademarks
© 2021 Advanced Micro Devices, Inc. All rights reserved. AMD, the AMD Arrow logo, Radeon, RDNA, Ryzen, and combinations thereof are trademarks of Advanced Micro Devices, Inc.