Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified Kits/FidelityFX/readme.md
Binary file not shown.
30 changes: 15 additions & 15 deletions docs/samples/denoiser.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This [sample](../../Samples/Denoisers/FidelityFX_Denoiser/dx12/FidelityFX_Denoiser_Sample_2022.sln) demonstrates how to integrate and experiment with FSR™ Ray Regeneration 1.0.0, a real-time ray-tracing denoising solution designed to improve the stability and visual quality of ray-traced lighting signals.

For details on the underlying algorithm, refer to the [FSR™ Ray Regeneration](../../kits/FidelityFX/docs/techniques/denoising.md) technique documentation.
For details on the underlying algorithm, refer to the [FSR™ Ray Regeneration](../../Kits/FidelityFX/docs/techniques/denoising.md) technique documentation.

## Table of contents

Expand Down Expand Up @@ -39,27 +39,27 @@ The tables below summarize the UI elements and what they control within the samp

| **Element name** | **Values** | **Description** |
| -----------------|------------|-----------------|
| **Version** | `1.0.0` | Dropdown for specifying the denoiser context version number. The newest context appears first in the list.<br><br>Sets the [`version`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L55) member of the [`ffxCreateContextDescDenoiser`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |
| **Mode** | 4 Signals,<br>2 Signals,<br>1 Signal<br> | Dropdown for specifying the number of signals to denoise.<br><br>Sets the [`mode`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L58) member of the [`ffxCreateContextDescDenoiser`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |
| **Denoise dominant light visibility** | Checked,<br>Unchecked<br> | Checkbox for specifying whether the dominant light visibility should be denoised (as an additional separate signal).<br><br>Sets the [`FFX_DENOISER_ENABLE_DOMINANT_LIGHT`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L41) flag to the [`flags`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L59) member of the [`ffxCreateContextDescDenoiser`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |
| **Enable debugging** | Checked,<br>Unchecked<br> | Checkbox for specifying whether debugging should be enabled.<br><br>Sets the [`FFX_DENOISER_ENABLE_DEBUGGING`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L40) flag to the [`flags`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L59) member of the [`ffxCreateContextDescDenoiser`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |
| **Version** | `1.0.0` | Dropdown for specifying the denoiser context version number. The newest context appears first in the list.<br><br>Sets the [`version`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L55) member of the [`ffxCreateContextDescDenoiser`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |
| **Mode** | 4 Signals,<br>2 Signals,<br>1 Signal<br> | Dropdown for specifying the number of signals to denoise.<br><br>Sets the [`mode`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L58) member of the [`ffxCreateContextDescDenoiser`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |
| **Denoise dominant light visibility** | Checked,<br>Unchecked<br> | Checkbox for specifying whether the dominant light visibility should be denoised (as an additional separate signal).<br><br>Sets the [`FFX_DENOISER_ENABLE_DOMINANT_LIGHT`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L41) flag to the [`flags`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L59) member of the [`ffxCreateContextDescDenoiser`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |
| **Enable debugging** | Checked,<br>Unchecked<br> | Checkbox for specifying whether debugging should be enabled.<br><br>Sets the [`FFX_DENOISER_ENABLE_DEBUGGING`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L40) flag to the [`flags`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L59) member of the [`ffxCreateContextDescDenoiser`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L52) context creation description. |

### Configure

| **Element name** | **Values** | **Description** |
| -----------------|------------|-----------------|
| **History rejection strength** | [0.0, 1.0] | Sets the [`historyRejectionStrength`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L78) member of the [`FfxApiDenoiserSettings`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Cross bilateral normal strength** | [0.0, 1.0] | Sets the [`crossBilateralNormalStrength`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L79) member of the [`FfxApiDenoiserSettings`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Stability bias** | [0.0, 1.0] | Sets the [`stabilityBias`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L80) member of the [`FfxApiDenoiserSettings`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Max radiance** | [0.0, 100000.0] | Sets the [`maxRadiance`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L81) member of the [`FfxApiDenoiserSettings`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Radiance std clip** | [0.0, 100000.0] | Sets the [`radianceClipStdK`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L82) member of the [`FfxApiDenoiserSettings`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Gaussian kernel relaxation** | [0.0, 1.0] | Sets the [`gaussianKernelRelaxation`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L83) member of the [`FfxApiDenoiserSettings`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **History rejection strength** | [0.0, 1.0] | Sets the [`historyRejectionStrength`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L78) member of the [`FfxApiDenoiserSettings`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Cross bilateral normal strength** | [0.0, 1.0] | Sets the [`crossBilateralNormalStrength`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L79) member of the [`FfxApiDenoiserSettings`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Stability bias** | [0.0, 1.0] | Sets the [`stabilityBias`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L80) member of the [`FfxApiDenoiserSettings`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Max radiance** | [0.0, 100000.0] | Sets the [`maxRadiance`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L81) member of the [`FfxApiDenoiserSettings`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Radiance std clip** | [0.0, 100000.0] | Sets the [`radianceClipStdK`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L82) member of the [`FfxApiDenoiserSettings`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |
| **Gaussian kernel relaxation** | [0.0, 1.0] | Sets the [`gaussianKernelRelaxation`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L83) member of the [`FfxApiDenoiserSettings`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L76) configuration description. |

### Dispatch

| **Element name** | **Values** | **Description** |
| -----------------|------------|-----------------|
| **Reset** | NA | Button for resetting the history accumulation.<br><br>Sets the [`FFX_DENOISER_DISPATCH_RESET`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L64) flag on the [`flags`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L116) member of the [`ffxDispatchDescDenoiser`](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h#L89) dispatch description. |
| **Reset** | NA | Button for resetting the history accumulation.<br><br>Sets the [`FFX_DENOISER_DISPATCH_RESET`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L64) flag on the [`flags`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L116) member of the [`ffxDispatchDescDenoiser`](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h#L89) dispatch description. |

### Display

Expand All @@ -70,13 +70,13 @@ The tables below summarize the UI elements and what they control within the samp

## Setting up FSR™ Ray Regeneration

The sample includes a [dedicated Render Module for FSR™ Ray Regeneration](../../Samples/Denoisers/FidelityFX_Denoiser/dx12/denoiserrendermodule.h) which creates the context and manages its lifetime. See the [FSR™ Ray Regeneration](../../kits/FidelityFX/docs/techniques/denoising.md) technique documentation for more details.
The sample includes a [dedicated Render Module for FSR™ Ray Regeneration](../../Samples/Denoisers/FidelityFX_Denoiser/dx12/denoiserrendermodule.h) which creates the context and manages its lifetime. See the [FSR™ Ray Regeneration](../../Kits/FidelityFX/docs/techniques/denoising.md) technique documentation for more details.

## Sample controls and configurations

For information on sample controls, configuration options, and Cauldron Framework UI elements, see [Running the samples](../getting-started/running-samples.md).

## See also

- [FSR™ Ray Regeneration API](../../kits/FidelityFX/denoisers/include/ffx_denoiser.h)
- [FSR™ Ray Regeneration technique documentation](../../kits/FidelityFX/docs/techniques/denoising.md)
- [FSR™ Ray Regeneration API](../../Kits/FidelityFX/denoisers/include/ffx_denoiser.h)
- [FSR™ Ray Regeneration technique documentation](../../Kits/FidelityFX/docs/techniques/denoising.md)
18 changes: 9 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ The FSR™ SDK includes:

| [FSR™ SDK Technique](https://gpuopen.com/amd-fidelityfx-sdk/) | [Samples](docs/samples/index.md) | [GPUOpen page](https://gpuopen.com/) | Description |
| --- | --- | --- | --- |
| [FidelityFX™ Super Resolution (Temporal)](docs/techniques/super-resolution-temporal.md) 2.3.4 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution 2](https://gpuopen.com/fidelityfx-superresolution-2/) | Offers a temporal (multi-frame accumulation) solution for producing high resolution frames from lower resolution inputs. |
| [FidelityFX™ Super Resolution (Upscaler)](docs/techniques/super-resolution-upscaler.md) 3.1.5 | [FidelityFX™ FSR sample](/docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution 3](https://gpuopen.com/fidelityfx-superresolution-3/) | Offers a temporal (multi-frame accumulation) solution for producing high resolution frames from lower resolution inputs. |
| [FSR™ Upscaling (ML-Upscaler)](docs/techniques/super-resolution-ml.md) 4.0.3 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FSR™ Upscaling 4](https://gpuopen.com/fidelityfx-superresolution-4/) | Offers a machine learning-based solution for producing high resolution frames from lower resolution inputs. |
| [FidelityFX™ Super Resolution Frame Generation](docs/techniques/frame-interpolation.md) 3.1.6 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution Frame Generation 3](https://gpuopen.com/fidelityfx-superresolution-3/) | Offers generation of interpolated frames from multiple real input frames, and multiple sources of motion vector data. |
| [FidelityFX™ Super Resolution Frame Generation SwapChain](docs/techniques/frame-interpolation-swap-chain.md) 3.1.6 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution Frame Generation Swapchain 3](https://gpuopen.com/fidelityfx-superresolution-3/) | A replacement DXGI Swapchain implementation for DX12 which allows for additional frames to be presented along with real game frames, with relevant frame pacing. |
| [FSR™ Frame Generation (ML)](docs/techniques/frame-interpolation.md) 4.0.0 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FSR™ Frame Generation 4](https://gpuopen.com/fidelityfx-superresolution-3/) | Offers generation of interpolated frames from multiple real input frames, and multiple sources of motion vector data. |
| [FSR™ Frame Generation SwapChain (ML)](docs/techniques/frame-interpolation-swap-chain.md) 4.0.0 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FSR™ Frame Generation Swapchain 4](https://gpuopen.com/fidelityfx-superresolution-3/) | A replacement DXGI Swapchain implementation for DX12 which allows for additional frames to be presented along with real game frames, with relevant frame pacing. |
| [FSR™ Ray Regeneration (ML-Denoiser)](docs/techniques/denoising.md) 1.0.0 | [FidelityFX Denoiser sample](docs/samples/neural-radiance-cache.md) | [FSR™ Ray Regeneration 1](https://gpuopen.com/fidelityfx-rayregeneration/) | Offers a machine learning-based solution for denoising. |
| [FSR™ Radiance Caching (Preview)](docs/techniques/radiance-cache-ml.md) | [FidelityFX NRC (Preview) sample](docs/samples/neural-radiance-cache.md) | [FSR™ Radiance Caching (Preview)](https://gpuopen.com/fidelityfx-neuralradiancechaching-preview/) | Offers a machine learning-based solution for path tracing result caching. |
| [FidelityFX™ Super Resolution (Temporal)](Kits/FidelityFX/docs/techniques/super-resolution-temporal.md) 2.3.4 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution 2](https://gpuopen.com/fidelityfx-superresolution-2/) | Offers a temporal (multi-frame accumulation) solution for producing high resolution frames from lower resolution inputs. |
| [FidelityFX™ Super Resolution (Upscaler)](Kits/FidelityFX/docs/techniques/super-resolution-upscaler.md) 3.1.5 | [FidelityFX™ FSR sample](/docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution 3](https://gpuopen.com/fidelityfx-superresolution-3/) | Offers a temporal (multi-frame accumulation) solution for producing high resolution frames from lower resolution inputs. |
| [FSR™ Upscaling (ML-Upscaler)](Kits/FidelityFX/docs/techniques/super-resolution-ml.md) 4.0.3 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FSR™ Upscaling 4](https://gpuopen.com/fidelityfx-superresolution-4/) | Offers a machine learning-based solution for producing high resolution frames from lower resolution inputs. |
| [FidelityFX™ Super Resolution Frame Generation](Kits/FidelityFX/docs/techniques/frame-interpolation.md) 3.1.6 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution Frame Generation 3](https://gpuopen.com/fidelityfx-superresolution-3/) | Offers generation of interpolated frames from multiple real input frames, and multiple sources of motion vector data. |
| [FidelityFX™ Super Resolution Frame Generation SwapChain](Kits/FidelityFX/docs/techniques/frame-interpolation-swap-chain.md) 3.1.6 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FidelityFX™ Super Resolution Frame Generation Swapchain 3](https://gpuopen.com/fidelityfx-superresolution-3/) | A replacement DXGI Swapchain implementation for DX12 which allows for additional frames to be presented along with real game frames, with relevant frame pacing. |
| [FSR™ Frame Generation (ML)](Kits/FidelityFX/docs/techniques/frame-interpolation.md) 4.0.0 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FSR™ Frame Generation 4](https://gpuopen.com/fidelityfx-superresolution-3/) | Offers generation of interpolated frames from multiple real input frames, and multiple sources of motion vector data. |
| [FSR™ Frame Generation SwapChain (ML)](Kits/FidelityFX/docs/techniques/frame-interpolation-swap-chain.md) 4.0.0 | [FidelityFX™ FSR sample](docs/samples/super-resolution.md) | [FSR™ Frame Generation Swapchain 4](https://gpuopen.com/fidelityfx-superresolution-3/) | A replacement DXGI Swapchain implementation for DX12 which allows for additional frames to be presented along with real game frames, with relevant frame pacing. |
| [FSR™ Ray Regeneration (ML-Denoiser)](Kits/FidelityFX/docs/techniques/denoising.md) 1.0.0 | [FidelityFX Denoiser sample](docs/samples/denoiser.md) | [FSR™ Ray Regeneration 1](https://gpuopen.com/amd-fsr-rayregeneration/) | Offers a machine learning-based solution for denoising. |
| [FSR™ Radiance Caching (Preview)](Kits/FidelityFX/docs/techniques/radiance-cache.md) | [FidelityFX NRC (Preview) sample](docs/samples/radiance-cache.md) | [FSR™ Radiance Caching (Preview)](https://gpuopen.com/amd-fsr-radiancecaching/) | Offers a machine learning-based solution for path tracing result caching. |

<h2>Further information</h2>

Expand Down