AMD RPS SDK Open Beta 1.1 Maintenance Release

Author: kurbeco

.gitlab-ci.yml

@@ -15,7 +15,7 @@ build:
   stage: build
   script:
   - 'del /q ".\external\catch2\scripts\updateDocumentToC.py"'
-  - 'cmake -S ./ -B ./build -G "Visual Studio 16 2019" -A x64 -DRpsEnableVulkanTests=OFF'
+  - 'cmake -S ./ -B ./build -G "Visual Studio 16 2019" -A x64 -DBUILD_INSTALLER=TRUE -DRpsEnableVulkanTests=OFF'
   - 'cmake --build ./build --config Debug --parallel'
   - 'cmake --build ./build --config Release --parallel'
   artifacts:

CMakeLists.txt

@@ -7,12 +7,18 @@
 
 cmake_minimum_required(VERSION 3.12.1)
 
+# setting cache variables and options should never overwrite normal variables;
+# otherwise, user settings set before including rps as a subdirectory can be overwritten.
+cmake_policy(SET CMP0126 NEW)
+cmake_policy(SET CMP0077 NEW)
+
 option( RpsBuildTests "Enable unit test targets" ON )
 option( RpsBuildTools "Enable tool targets" ON )
 option( RpsBuildExamples "Enable example targets" ON )
 option( RpsEnableVulkan "Enable Vulkan backend" ON )
 option( RpsEnableImGui "Enable ImGui" ON)
 option( RpsEnableDXAgilitySDK "Enable DX12 Agility SDK" OFF )
+option( RpsPackagingIncludeStaticLibs "Include prebuilt static libs during packaging" OFF )
 option( RpsEnableDefaultDeviceImpl "Enable default allocator & printer support" ON )
 
 if ( "${CMAKE_GENERATOR_PLATFORM}" STREQUAL "" )
@@ -228,16 +234,18 @@ function( CopyShaders TargetName ShaderFiles SrcFolder )
     endforeach()
 endfunction()
 
-FindSpirvTools( SPIRV_DXCOMPILER_DLL )
-CheckFindFile( SPIRV_DXCOMPILER_DLL ${SPIRV_DXCOMPILER_DLL} )
+if ( RpsEnableVulkan )
+    FindSpirvTools( SPIRV_DXCOMPILER_DLL )
+    CheckFindFile( SPIRV_DXCOMPILER_DLL ${SPIRV_DXCOMPILER_DLL} )
 
-function( CopySpirvDXC TargetName )
-    add_custom_command(
-        TARGET ${TargetName} POST_BUILD
-        COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        ${SPIRV_DXCOMPILER_DLL}
-        $<TARGET_FILE_DIR:${TargetName}>/spirv_dxc/dxcompiler.dll)
-endfunction()
+    function( CopySpirvDXC TargetName )
+        add_custom_command(
+            TARGET ${TargetName} POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy_if_different
+            ${SPIRV_DXCOMPILER_DLL}
+            $<TARGET_FILE_DIR:${TargetName}>/spirv_dxc/dxcompiler.dll)
+    endfunction()
+endif()
 
 if ( WIN32 )
 
@@ -466,3 +474,7 @@ endif ( )
 if ( RpsBuildTools )
     add_subdirectory( tools )
 endif ( )
+
+if ( RpsBuildExamples )
+    add_subdirectory( examples )
+endif ( )

README.md

@@ -87,6 +87,12 @@ After a successful build:
 
 - By default, the RPSL Explorer binaries can be located at `./build/tools/rpsl_explorer/<config_name>/`. Run `rpsl_explorer.exe` and open an RPSL file to start hacking!
 
+## Getting Started
+
+If you are new to RPS, we recommend reading through our tutorial which you can find at [./docs/tutorial](./docs/tutorial) in this repository and at [https://gpuopen.com/learn/rps-tutorial](https://gpuopen.com/learn/rps-tutorial) on GPUOpen.
+
+After this, you should be well equipped to browse the [test samples](./tests) and let RPS drive the frame graph logic of your own 3D application.
+
 ## Documentation
 
 The main sources of documentation for the RPS public APIs are inlined Doxygen-style comments, which can be built into
@@ -96,6 +102,10 @@ HTML documents if Doxygen is installed (tested with Doxygen version 1.9.2):
 doxygen
 ```
 
+## Getting Help
+
+If you are facing any problems that you cannot solve by checking out the documentation or the samples, do not worry. You can contact us by [raising GitHub issues](https://github.com/GPUOpen-LibrariesAndSDKs/RenderPipelineShaders/issues), [@GPUOpen](https://twitter.com/GPUOpen) on Twitter, [@GPUOpen@mastodon.gamedev.place](@[email protected]) on Mastodon and by using [this invitation link](https://discord.gg/sZhDJ2rDa9), you can join our Discord server and chat with the RPS team directly. 
+
 ## Integration
 
 If the parent project uses CMake, RPS can be added as a subdirectory, e.g.:

ReleaseNotes.md

@@ -0,0 +1,55 @@
+# Release Notes
+
+## Version 1.1 (maintenance)
+
+### Bug Fixes
+
+* Add missing execute permissions for rpsl compiler binaries.
+* Fixes for symbol exports for dynamically linked rpsl modules.
+* Fixes for RPSL explorer file path issues.
+* Fixes for RPSL explorer file change notifications.
+* Fixes for a number of CMake issues.
+
+## Version 1.1
+
+### Features
+
+* Linux support for the base library and the RPSL compiler.
+* Support for dynamically loading Vulkan functions.
+* Support for latest stable Agility SDK 1.608.3.
+* Automatic marking of the discard flags to accesses.
+
+### Bug Fixes
+
+* Fix prioritization of queues for node scheduling.
+* Fixes for MinGW support.
+* Fixes for D3D12 heap creation.
+* Fixes for ImGui Settings parsing.
+* Fixes for latest ImGui version.
+* Fixes for dynamic render graphs.
+* Fixes for dynamic node declarations.
+* Fixes for multithreading with dynamically declared nodes.
+
+### Other
+
+* A comprehensive tutorial to get started with RPS.
+* Improved documentation.
+
+
+## Version 1.0 (maintenance)
+
+### Bug Fixes
+
+* Fixes for D3D11 UAV arg unwrapper.
+
+### Other
+
+* Update Vulkan version requirements.
+* Include setup hints for first time usage.
+* Improve documentation.
+
+### Other
+
+## Version 1.0
+
+* Initial release. Please check out [GPUOpen](https://gpuopen.com/learn/rps_1_0/) for more info.

examples/hello_triangle.cpp

@@ -217,10 +217,12 @@ class HelloTriangle : public RpsAfxD3D12Renderer
 
             uint32_t argDataCount = 1;
 
+            float time = 0.f;
+
             if (c_bBreathing)
             {
                 argDataCount = 2;
-                float time   = float(RpsAfxCpuTimer::SecondsSinceEpoch().count());
+                time         = float(RpsAfxCpuTimer::SecondsSinceEpoch().count());
                 argData[1]   = &time;
             }