FidelityFX SPD release v2.0

README.md

@@ -1,15 +1,32 @@
 # FidelityFX SPD
 Copyright (c) 2020 Advanced Micro Devices, Inc. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+# Changelist v2.0
+
+- Added support for cube and array textures. SpdDownsample and SpdDownsampleH shader functions now take index of texture slice as an additional parameter. For regular texture use 0.
+- Added support for updating only sub-rectangle of the texture. Additional, optional parameter workGroupOffset added to shader functions SpdDownsample and SpdDownsampleH.
+- Added C function SpdSetup that helps to setup constants to be passed as a constant buffer.
+- The global atomic counter is automatically reset to 0 by the shader at the end, so you do not need to clear it before every use, just once after creation
+
 # Single Pass Downsampler - SPD
 
 FidelityFX Single Pass Downsampler (SPD) provides an RDNA-optimized solution for generating up to 12 MIP levels of a texture.
+- Generates up to 12 MIP levels (maximum source texture size is 4096x4096) per slice.
+- Supports Texture2DArrays / CubeTextures: downsamples all slices within one single disptach call.
+- Single compute dispatch.
+- User defined 2x2 reduction function.
+- User controlled border handling.
+- Supports various image formats.
+- HLSL and GLSL versions available.
+- Rapid Packed Math support.
+- Uses optionally subgroup operations / SM6+ wave operations, which can provide faster performance.
+- Supports downsampling of a sub-rectangle from the source texture: useful for atlas textures in which only a known region got updated
 
 # Sample Build Instructions
 
 1. Clone submodules by running 'git submodule update --init --recursive' (so you get the Cauldron framework too)
 2. Run sample/build/GenerateSolutions.bat
-3. open solution, build + run + have fun 😊
+3. Open solution, build + run + have fun 😊
 
 # SPD Files
 You can find them in ffx-spd
@@ -21,15 +38,26 @@ Downsampler
 - PS: computes each mip in a separate pixel shader pass
 - Multipass CS: computes each mip in a separate compute shader pass
 - SPD CS: uses the SPD library, computes all mips (up to a source texture of size 4096²) in a single pass
-- SPD CS linear sampler: uses the SPD library and for sampling the source texture a linear sampler
 
-SPD Versions
-- NO-WaveOps: uses only LDS to share the data between threads
+SPD Load Versions
+- Load: uses a load to fetch from the source texture
+- Linear Sampler: uses a sampler to fetch from the source texture. Sampler must meet the user defined reduction function.
+
+SPD WaveOps Versions
+- No-WaveOps: uses only LDS to share the data between threads
 - WaveOps: uses Intrinsics and LDS to share the data between threads
 
-SPD Non-Packed / Packed Version
+SPD Non-Packed / Packed Versions
 - Non-Packed: uses fp32
 - Packed: uses fp16, reduced register pressure
 
 # Recommendations
-We recommend to use the WapeOps path when supported. If higher precision is not needed, you can enable the packed mode - it has less register pressure and can run a bit faster as well.
+We recommend to use the WaveOps path when supported. If higher precision is not needed, you can enable the packed mode - it has less register pressure and can run a bit faster as well.
+If you compute the average for each 2x2 quad, we also recommend to use a linear sampler to fetch from the source texture instead of four separate loads.
+
+# Known issues
+Please use driver 20.8.3 or newer. There is a known issue on DX12 when using the SPD No-WaveOps Packed version.
+It may appear as "Access violation reading location ..." during CreateComputePipelineState, with top of the stack
+pointing to amdxc64.dll.
+To workaround this issue, you may advise players to update their graphics driver or don't compile and use
+a different SPD version, e.g. a Non-Packed version.