[
{
"path": ".editorconfig",
"content": "# Visual Studio generated .editorconfig file with C++ settings.\nroot = true\n\n[*.{c++,cc,cpp,cppm,cu,cuh,cxx,fx,h,h++,hh,hlsl,hpp,hxx,inl,ipp,ixx,tlh,tli}]\nindent_size = 4;\nindent_style = space;\n\n# Visual C++ Code Style settings\n\ncpp_generate_documentation_comments = xml\n\n# Visual C++ Formatting settings\n\ncpp_indent_braces = false\ncpp_indent_multi_line_relative_to = innermost_parenthesis\ncpp_indent_within_parentheses = indent\ncpp_indent_preserve_within_parentheses = true\ncpp_indent_case_contents = true\ncpp_indent_case_labels = false\ncpp_indent_case_contents_when_block = false\ncpp_indent_lambda_braces_when_parameter = true\ncpp_indent_goto_labels = one_left\ncpp_indent_preprocessor = leftmost_column\ncpp_indent_access_specifiers = false\ncpp_indent_namespace_contents = true\ncpp_indent_preserve_comments = false\ncpp_new_line_before_open_brace_namespace = new_line\ncpp_new_line_before_open_brace_type = new_line\ncpp_new_line_before_open_brace_function = new_line\ncpp_new_line_before_open_brace_block = new_line\ncpp_new_line_before_open_brace_lambda = new_line\ncpp_new_line_scope_braces_on_separate_lines = true\ncpp_new_line_close_brace_same_line_empty_type = false\ncpp_new_line_close_brace_same_line_empty_function = false\ncpp_new_line_before_catch = true\ncpp_new_line_before_else = true\ncpp_new_line_before_while_in_do_while = false\ncpp_space_before_function_open_parenthesis = remove\ncpp_space_within_parameter_list_parentheses = false\ncpp_space_between_empty_parameter_list_parentheses = false\ncpp_space_after_keywords_in_control_flow_statements = true\ncpp_space_within_control_flow_statement_parentheses = false\ncpp_space_before_lambda_open_parenthesis = false\ncpp_space_within_cast_parentheses = false\ncpp_space_after_cast_close_parenthesis = false\ncpp_space_within_expression_parentheses = false\ncpp_space_before_block_open_brace = true\ncpp_space_between_empty_braces = false\ncpp_space_before_initializer_list_open_brace = false\ncpp_space_within_initializer_list_braces = true\ncpp_space_preserve_in_initializer_list = true\ncpp_space_before_open_square_bracket = false\ncpp_space_within_square_brackets = false\ncpp_space_before_empty_square_brackets = false\ncpp_space_between_empty_square_brackets = false\ncpp_space_group_square_brackets = true\ncpp_space_within_lambda_brackets = false\ncpp_space_between_empty_lambda_brackets = false\ncpp_space_before_comma = false\ncpp_space_after_comma = true\ncpp_space_remove_around_member_operators = true\ncpp_space_before_inheritance_colon = true\ncpp_space_before_constructor_colon = true\ncpp_space_remove_before_semicolon = true\ncpp_space_after_semicolon = true\ncpp_space_remove_around_unary_operator = true\ncpp_space_around_binary_operator = insert\ncpp_space_around_assignment_operator = insert\ncpp_space_pointer_reference_alignment = left\ncpp_space_around_ternary_operator = insert\ncpp_use_unreal_engine_macro_formatting = true\ncpp_wrap_preserve_blocks = one_liners\n\n# Visual C++ Inlcude Cleanup settings\n\ncpp_include_cleanup_add_missing_error_tag_type = suggestion\ncpp_include_cleanup_remove_unused_error_tag_type = dimmed\ncpp_include_cleanup_sort_after_edits = false\ncpp_sort_includes_error_tag_type = none\ncpp_sort_includes_priority_case_sensitive = false\ncpp_sort_includes_priority_style = quoted\ncpp_includes_style = default\ncpp_includes_use_forward_slash = true\n\n[*.md]\nspelling_languages = en-us\nspelling_error_severity = warning"
},
{
"path": ".gitattributes",
"content": "# Default behavior in case core.autocrlf set\n* text=auto\n\n*.dll filter=lfs diff=lfs merge=lfs -text\n*.pdb filter=lfs diff=lfs merge=lfs -text\n"
},
{
"path": ".gitignore",
"content": "*.*~\nscenes\nbin/\n_build/\n_install/\nbuild/\n.vscode/\n"
},
{
"path": ".gitlab-ci.yml",
"content": "stages:\r\n - build\r\n\r\nvariables:\r\n GIT_SUBMODULE_STRATEGY: recursive\r\n\r\nbuild-windows:\r\n stage: build\r\n tags:\r\n - os/win11\r\n rules:\r\n - if: '$ENABLE_JOBS =~ /build-windows/'\r\n parallel:\r\n matrix:\r\n - BUILD_TYPE: ['Release', 'Debug']\r\n DX12: 'ON'\r\n VULKAN: 'OFF'\r\n script:\r\n - tools/set_vs_vars.ps1\r\n - mkdir build\r\n - cd build\r\n - cmake .. -G \"Visual Studio 17 2022\" -A x64 \"-DCMAKE_BUILD_TYPE=$BUILD_TYPE\" \"-DDONUT_WITH_DX12=$DX12\" \"-DDONUT_WITH_VULKAN=$VULKAN\"\r\n - cmake --build . --config \"$BUILD_TYPE\" --target package\r\n \r\n artifacts:\r\n when: on_success\r\n access: all\r\n expire_in: 30 days\r\n paths: ['build/rtxmg.*.zip']"
},
{
"path": ".gitmodules",
"content": "[submodule \"extern/donut\"]\n\tpath = extern/donut\n\turl = https://github.com/NVIDIA-RTX/Donut.git\n[submodule \"assets\"]\n\tpath = assets\n\turl = https://github.com/NVIDIA-RTX/RTXMG-Sample-Assets.git\n[submodule \"extern/osd_lite\"]\n\tpath = extern/osd_lite\n\turl = https://github.com/NVIDIA-RTX/OSD-Lite.git\n"
},
{
"path": "CHANGELOG.md",
"content": "# RTX Mega Geometry SDK Change Log\n\n## 1.0.1\n\nImprovements\n* Add smooth vertex normal support which allows for lower tessellation rates and includes memory profiler row for vertex normals\n* Filter out degenerate normals for backface culling to improve backface test and reduce triangle count\n\nDebugging Improvements\n* Improve shader debug with stable cluster index output from path tracing shader\n* Add surface highlighting feature where path-tracer will blink highlight a selected debug surface\n* Add utilities to shader debug to force output\n\nBug Fixes\n* Fix regression in surface 1-ring culling caused by 1D thread-ordering change, which resulted in incorrect lanes doing work for unrelated waves\n* Fix crash when refreshing media list after changing json/obj filters with an asset already loaded\n\n## 1.0.0\n\nVulkan Support\n* Requires Vulkan SDK 1.4.313 or greater which uses Cluster SPIRV intrinsics\n* Convert all bindless arrays to use ResourceDescriptorHeap via Vulkan's mutable descriptor extension\n* Fix validation warnings and Vulkan shutdown crashes\n\nMinor Changes\n* Expose isolation level in the UI\n* Add smooth single crease sharpness, which prevents transition artifacts between single and multicrease edges. Only visible if the isolation level is lowered.\n* Improve Profiler \"Frame\" Tab, add average times in tool tip, expose motion vector pass time\n* Update to Streamline v2.8.0\n\nBug Fixes\n* Fix thread-ordering to be compliant with SM6.6 1D quad lane ordering.\n* Fix micro-triangle view toggle when in DLAA mode.\n* Fix cases where a surface resulted in over U16_MAX clusters\n* Fix tessellation for when there was per-material displacement scaling\n* Fix crash for some malformed OBJ files with '0' values for some indices.\n\n## 0.9.2\n\nPerformance Improvements \n\nTest Scene: amy_kitchenset.scene.json (default camera: 79M microtriangles) \nHardware: RTX 5090 @ 4K Render Resolution (r572.83)\n\n* Compute Cluster tiling: 4.0ms -> 1.0ms (300% speedup)\n * Coalesced UAV writes for structs, unaligned members were causing UAV readbacks\n * Coalesce per wave atomics into a groupshared atomic to reduce pressure on global/UAV atomics by 4x\n* Fill clusters: 4.9ms to -> 1.0ms (390% speedup)\n * Fixed cases where the compiler was unable to unroll loops due to dynamic loop counts\n * Specialized shaders by subdivision surface type, with a special path for Pure BSpline surfaces. Prefetch all control points into shared memory to be used wave wide.\n\nMinor Fixes\n\n* Fix SpecularHitT guide buffer to DLSS-RR to improve coherence of specular rays.\n\n## 0.9.1\n\nStability\n* Fix crash on scenes with multiple subdivision mesh instances when the topology quality color mode was selected\n* Fix a crash if scene with audio is loaded and no audio devices are present.\n\nTopology Quality\n* Add button in the Subdivision Evaluator tab to switch to topology quality view if issues are detected\n* Fix Subdivision Evaluator UI not resetting upon scene load.\n\nUI\n* Application Window Size/Maximized/Fullscreen and Window state is now saved to and restored from imgui.ini. Delete imgui.ini to reset layout\n\nMinor\n* Make initial VRAM check non-fatal but add warnings about performance degradation, memory budgets.\n* Made localToWorld transform use Matrix3x4 for consistency\n* Style clean-up\n* Update donut version\n\n## 0.9.0\n\nInitial beta release.\n"
},
{
"path": "CMake/FetchDXC.cmake",
"content": "#\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions\n# are met:\n# * Redistributions of source code must retain the above copyright\n# notice, this list of conditions and the following disclaimer.\n# * Redistributions in binary form must reproduce the above copyright\n# notice, this list of conditions and the following disclaimer in the\n# documentation and/or other materials provided with the distribution.\n# * Neither the name of NVIDIA CORPORATION nor the names of its\n# contributors may be used to endorse or promote products derived\n# from this software without specific prior written permission.\n#\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY\n# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\n# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\n# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n#\ninclude(FetchContent)\n\nset(DXC_URL https://github.com/microsoft/DirectXShaderCompiler/releases/download/v1.8.2407/dxc_2024_07_31.zip)\nset(DXC_SHA256_HASH e2627f004f0f9424d8c71ea1314d04f38c5a5096884ae9217f1f18bd320267b5)\nFetchContent_Declare(\n DXC\n URL ${DXC_URL}\n URL_HASH SHA256=${DXC_SHA256_HASH}\n DOWNLOAD_EXTRACT_TIMESTAMP ON\n)\nFetchContent_MakeAvailable(DXC)\nmessage(STATUS \"Updating DXC from ${DXC_URL}, SHA256 ${DXC_SHA256_HASH}, into folder ${dxc_SOURCE_DIR}\")\n\nset(SHADERMAKE_FIND_DXC OFF CACHE BOOL \"\" FORCE)\nset(DXC_PATH \"${dxc_SOURCE_DIR}/bin/x64/dxc.exe\" CACHE STRING \"\" FORCE)"
},
{
"path": "CMake/FetchImplot.cmake",
"content": "#\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions\n# are met:\n# * Redistributions of source code must retain the above copyright\n# notice, this list of conditions and the following disclaimer.\n# * Redistributions in binary form must reproduce the above copyright\n# notice, this list of conditions and the following disclaimer in the\n# documentation and/or other materials provided with the distribution.\n# * Neither the name of NVIDIA CORPORATION nor the names of its\n# contributors may be used to endorse or promote products derived\n# from this software without specific prior written permission.\n#\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY\n# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\n# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\n# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n#\n\nif( TARGET implot )\n return()\nendif()\n\n\nif (NOT TARGET imgui)\n message(FATAL_ERROR \"Implot requires imgui\")\nendif()\n\ninclude(FetchContent)\nFetchContent_Declare(\n implot\n GIT_REPOSITORY https://github.com/epezent/implot.git\n GIT_TAG v0.16\n )\nFetchContent_MakeAvailable(implot)\n\n# Override Imgui build - we want a lean static library\n\nset(implot_srcs\n ${CMAKE_BINARY_DIR}/_deps/implot-src/implot.cpp\n ${CMAKE_BINARY_DIR}/_deps/implot-src/implot.h\n ${CMAKE_BINARY_DIR}/_deps/implot-src/implot_internal.h\n ${CMAKE_BINARY_DIR}/_deps/implot-src/implot_items.cpp\n)\n\nadd_library(implot STATIC ${implot_srcs})\nset_target_properties(implot PROPERTIES POSITION_INDEPENDENT_CODE ON)\nadd_compile_definitions(implot PRIVATE IMGUI_DEFINE_MATH_OPERATORS)\ntarget_include_directories(implot PUBLIC \"${CMAKE_BINARY_DIR}/_deps/implot-src/\")\ntarget_link_libraries(implot imgui)\n"
},
{
"path": "CMake/FetchNVAPI.cmake",
"content": "#\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions\n# are met:\n# * Redistributions of source code must retain the above copyright\n# notice, this list of conditions and the following disclaimer.\n# * Redistributions in binary form must reproduce the above copyright\n# notice, this list of conditions and the following disclaimer in the\n# documentation and/or other materials provided with the distribution.\n# * Neither the name of NVIDIA CORPORATION nor the names of its\n# contributors may be used to endorse or promote products derived\n# from this software without specific prior written permission.\n#\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY\n# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\n# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\n# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n#\ninclude(FetchContent)\n\nset(NVAPI_FETCH_URL \"https://github.com/NVIDIA/nvapi.git\" CACHE STRING \"Url to nvapi git repo to fetch\")\nset(NVAPI_FETCH_TAG \"ce6d2a183f9559f717e82b80333966d19edb9c8c\" CACHE STRING \"Tag of nvapi git repo\")\nset(NVAPI_FETCH_DIR \"\" CACHE STRING \"Directory to fetch streamline to, empty uses build directory default\")\n\ninclude(FetchContent)\nFetchContent_Declare(\n nvapi\n GIT_REPOSITORY ${NVAPI_FETCH_URL}\n GIT_TAG ${NVAPI_FETCH_TAG}\n SOURCE_DIR ${NVAPI_FETCH_DIR}\n)\nFetchContent_MakeAvailable(nvapi)\n\nmessage(STATUS \"Updating nvapi from ${NVAPI_FETCH_URL}, tag ${NVAPI_FETCH_TAG}, into folder ${nvapi_SOURCE_DIR}\")\nset(NVAPI_SEARCH_PATHS \"${nvapi_SOURCE_DIR}\")"
},
{
"path": "CMakeLists.txt",
"content": "cmake_minimum_required(VERSION 3.10)\n\nproject(rtxmg LANGUAGES C CXX VERSION 1.0.1)\n\nset(CMAKE_CONFIGURATION_TYPES \"Debug;Release;RelWithDebInfo;ReleaseAsan\" CACHE STRING \"Configurations\" FORCE)\nset(CMAKE_CXX_STANDARD 23)\nset(CMAKE_CXX_STANDARD_REQUIRED ON)\nset(CMAKE_CXX_EXTENSIONS ON)\nset(CMAKE_FIND_ROOT_PATH ${CMAKE_SOURCE_DIR}/extern)\n\n####################################\n# Static analysis\n####################################\nset(RULESET_PATH \"${CMAKE_SOURCE_DIR}/rtxmg_static_analysis.ruleset\")\nadd_compile_options(\"-wd26495\")\nset_property( GLOBAL PROPERTY VS_USER_PROPS \"rtxmg_static_analysis.props\")\n\n####################################\n# ASAN\n####################################\nset(CMAKE_RUNTIME_OUTPUT_DIRECTORY \"${CMAKE_SOURCE_DIR}/bin\")\nforeach(CONFIG_TYPE DEBUG RELEASE MINSIZEREL RELWITHDEBINFO RELEASEASAN)\n set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_${CONFIG_TYPE} \"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}\")\nendforeach()\nset(CMAKE_CXX_FLAGS_RELEASEASAN \"${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -fsanitize=address\")\nset(CMAKE_EXE_LINKER_FLAGS_RELEASEASAN \"${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO}\")\nset(CMAKE_SHARED_LINKER_FLAGS_RELEASEASAN \"${CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO}\")\n\n####################################\n# AgilitySDK\n####################################\nif(WIN32)\n # this SDK requires features from the D3D12 Agility SDK on Win 10\n if(CMAKE_SYSTEM_VERSION LESS 11.0)\n set(DONUT_D3D_AGILITY_SDK_URL \"https://www.nuget.org/api/v2/package/Microsoft.Direct3D.D3D12/1.614.1\")\n # set fetch destination to cmake default build/_deps folder\n set(DONUT_D3D_AGILITY_SDK_FETCH_DIR \"\" CACHE STRING \"\")\n include(\"${PROJECT_SOURCE_DIR}/extern/donut/cmake/FetchAgilitySDK.cmake\")\n else()\n message(STATUS \"Windows 11 or newer detected: disabling Agility SDK\")\n endif()\nendif()\n\n####################################\n# DXC\n# WindowsSDK version is buggy and the compiler crashes\n####################################\nset(SHADERMAKE_FIND_DXC ON CACHE BOOL \"\" FORCE)\n\n####################################\n# Streamline\n####################################\nset(DONUT_WITH_STREAMLINE ON CACHE BOOL \"\" FORCE)\nset(DONUT_STREAMLINE_FETCH_URL \"https://github.com/NVIDIA-RTX/Streamline/releases/download/v2.8.0/streamline-sdk-v2.8.0.zip\" CACHE STRING \"\")\nset(DONUT_STREAMLINE_FETCH_SHA256 \"313669f8cf886f823ea0518a50712efa5e2e8623689ed2a6bd0d9353e475bc47\" CACHE STRING \"\")\nset(STREAMLINE_FEATURE_DLSS_SR ON CACHE BOOL \"\" FORCE)\nset(STREAMLINE_FEATURE_DLSS_RR ON CACHE BOOL \"\" FORCE)\nset(STREAMLINE_INSTALL_DIR \"bin\" CACHE STRING \"\" FORCE)\n\n####################################\n# NVAPI\n####################################\ninclude(\"${PROJECT_SOURCE_DIR}/CMake/FetchNVAPI.cmake\")\n\n####################################\n# DONUT\n####################################\noption(DONUT_WITH_DX11 OFF)\nset(DONUT_WITH_VULKAN ON CACHE BOOL \"Enable the Vulkan version of Donut\")\nset(NVRHI_WITH_NVAPI ON CACHE BOOL \"\" FORCE)\nset(DONUT_WITH_AFTERMATH ON CACHE BOOL \"\" FORCE)\nset(NVRHI_INSTALL OFF CACHE BOOL \"\" FORCE)\n\n# Shaders\nset(DONUT_SHADERS_OUTPUT_DIR \"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders/framework\")\nset(DONUT_DIR \"${PROJECT_SOURCE_DIR}/extern/donut\")\n\nlist(APPEND RTXMG_SHADERS_INCLUDE_DIR\n\"${PROJECT_SOURCE_DIR}\"\n\"${PROJECT_SOURCE_DIR}/extern\"\n\"${PROJECT_SOURCE_DIR}/extern/donut/include\"\n\"${PROJECT_SOURCE_DIR}/rtxmg/include\"\n\"${nvapi_SOURCE_DIR}\"\n\"${PROJECT_SOURCE_DIR}/extern/donut/nvrhi/include\")\n\nset(RTXMG_SHADERMAKE_OPTIONS \"--embedPDB --hlsl2021\")\n\n#-vd disable validator due to a bug in \n# https://github.com/microsoft/DirectXShaderCompiler/issues/7181\n# should be fixed in version 1.8.2505\nset(RTXMG_SHADERMAKE_OPTIONS_SPIRV \"--vulkanMemoryLayout scalar --compilerOptions -Vd\") \nset(RTXMG_SHADERS_SHADERMODEL \"6_6\")\n\nset(RTXMG_SHADERS_IGNORED_INCLUDES \"\")\nlist(APPEND RTXMG_SHADERS_IGNORED_INCLUDES\n \"donut/core/math/math.h\"\n \"nvrhi/nvrhi.h\"\n \"array\"\n \"assert.h\"\n \"cstdint\"\n \"cstdio\"\n \"stdio.h\"\n \"cmath\"\n \"ostream\"\n \"rtxmg/utils/buffer.h\"\n)\n\nadd_subdirectory(extern/donut)\nadd_subdirectory(extern/osd_lite EXCLUDE_FROM_ALL)\nadd_subdirectory(rtxmg)\nadd_subdirectory(demo)\n\nadd_subdirectory(extern)\n\nset_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT rtxmg_demo)\n"
},
{
"path": "LICENSE.txt",
"content": "NVIDIA RTX SDKs LICENSE\n\nThis license is a legal agreement between you and NVIDIA Corporation (\"NVIDIA\") and governs the use of the NVIDIA RTX \nsoftware development kits, including the DLSS SDK, NGX SDK, RTXGI SDK, RTXDI SDK, RTX Video SDK and/or NRD SDK, if and \nwhen made available to you under this license (in each case, the SDK).\nThis license can be accepted only by an adult of legal age of majority in the country in which the SDK is used. If you are \nunder the legal age of majority, you must ask your parent or legal guardian to consent to this license. If you are entering this \nlicense on behalf of a company or other legal entity, you represent that you have legal authority and you will mean the \nentity you represent. \nBy using the SDK, you affirm that you have reached the legal age of majority, you accept the terms of this license, and you \ntake legal and financial responsibility for the actions of your permitted users. \n\nYou agree to use the SDK only for purposes that are permitted by (a) this license, and (b) any applicable law, regulation or \ngenerally accepted practices or guidelines in the relevant jurisdictions.\n1. LICENSE. Subject to the terms of this license and the terms in the supplement attached, NVIDIA hereby grants you a non-\nexclusive, non-transferable license, without the right to sublicense (except as expressly provided in this license) to: \na. Install and use the SDK,\nb. Modify and create derivative works of sample source code delivered in the SDK, and\nc. Distribute any software and materials within the SDK, other than developer tools provided for your internal use, as \nincorporated in object code format into a software application subject to the distribution requirements indicated in this \nlicense.\n\n2. DISTRIBUTION REQUIREMENTS. These are the distribution requirements for you to exercise the grants above:\na.\tAn application must have material additional functionality, beyond the included portions of the SDK. \nb.\tThe following notice shall be included in modifications and derivative works of source code distributed: This software \ncontains source code provided by NVIDIA Corporation. \nc.\tYou agree to distribute the SDK subject to the terms at least as protective as the terms of this license, including (without \nlimitation) terms relating to the license grant, license restrictions and protection of NVIDIAs intellectual property rights. \nAdditionally, you agree that you will protect the privacy, security and legal rights of your application users. \nd.\tYou agree to notify NVIDIA in writing of any known or suspected distribution or use of the SDK not in compliance with \nthe requirements of this license, and to enforce the terms of your agreements with respect to the distributed portions of \nthe SDK. \n3. AUTHORIZED USERS. You may allow employees and contractors of your entity or of your subsidiary(ies) to access and use \nthe SDK from your secure network to perform work on your behalf. If you are an academic institution you may allow users \nenrolled or employed by the academic institution to access and use the SDK from your secure network. You are responsible \nfor the compliance with the terms of this license by your authorized users. \n\n4. LIMITATIONS. Your license to use the SDK is restricted as follows:\na.\tYou may not reverse engineer, decompile or disassemble, or remove copyright or other proprietary notices from any \nportion of the SDK or copies of the SDK. \nb.\tExcept as expressly provided in this license, you may not copy, sell, rent, sublicense, transfer, distribute, modify, or \ncreate derivative works of any portion of the SDK. For clarity, you may not distribute or sublicense the SDK as a stand-alone \nproduct.\nc.\t Unless you have an agreement with NVIDIA for this purpose, you may not indicate that an application created with the \nSDK is sponsored or endorsed by NVIDIA.\nd.\t You may not bypass, disable, or circumvent any technical limitation, encryption, security, digital rights management or \nauthentication mechanism in the SDK. \ne.\tYou may not use the SDK in any manner that would cause it to become subject to an open source software license. As \nexamples, licenses that require as a condition of use, modification, and/or distribution that the SDK be: (i) disclosed or \ndistributed in source code form; (ii) licensed for the purpose of making derivative works; or (iii) redistributable at no charge.\nf.\t Unless you have an agreement with NVIDIA for this purpose, you may not use the SDK with any system or application \nwhere the use or failure of the system or application can reasonably be expected to threaten or result in personal injury, \ndeath, or catastrophic loss. Examples include use in avionics, navigation, military, medical, life support or other life critical \napplications. NVIDIA does not design, test or manufacture the SDK for these critical uses and NVIDIA shall not be liable to \nyou or any third party, in whole or in part, for any claims or damages arising from such uses. \ng.\tYou agree to defend, indemnify and hold harmless NVIDIA and its affiliates, and their respective employees, contractors, \nagents, officers and directors, from and against any and all claims, damages, obligations, losses, liabilities, costs or debt, \nfines, restitutions and expenses (including but not limited to attorneys fees and costs incident to establishing the right of \nindemnification) arising out of or related to your use of the SDK outside of the scope of this license, or not in compliance \nwith its terms. \n\n5. UPDATES. NVIDIA may, at its option, make available patches, workarounds or other updates to this SDK. Unless the \nupdates are provided with their separate governing terms, they are deemed part of the SDK licensed to you as provided in \nthis license. Further, NVIDIA may, at its option, automatically update the SDK or other software in the system, except for \nthose updates that you may opt-out via the SDK API. You agree that the form and content of the SDK that NVIDIA provides \nmay change without prior notice to you. While NVIDIA generally maintains compatibility between versions, NVIDIA may in \nsome cases make changes that introduce incompatibilities in future versions of the SDK.\n\n6. PRE-RELEASE VERSIONS. SDK versions identified as alpha, beta, preview, early access or otherwise as pre-release may not \nbe fully functional, may contain errors or design flaws, and may have reduced or different security, privacy, availability, and \nreliability standards relative to commercial versions of NVIDIA software and materials. You may use a pre-release SDK \nversion at your own risk, understanding that these versions are not intended for use in production or business-critical \nsystems. NVIDIA may choose not to make available a commercial version of any pre-release SDK. NVIDIA may also choose to \nabandon development and terminate the availability of a pre-release SDK at any time without liability.\n\n7. THIRD-PARTY COMPONENTS. The SDK may include third-party components with separate legal notices or terms as may \nbe described in proprietary notices accompanying the SDK. If and to the extent there is a conflict between the terms in this \nlicense and the third-party license terms, the third-party terms control only to the extent necessary to resolve the conflict. \n\n8. OWNERSHIP. \n\n8.1 NVIDIA reserves all rights, title and interest in and to the SDK not expressly granted to you under this license. NVIDIA \nand its suppliers hold all rights, title and interest in and to the SDK, including their respective intellectual property rights. \nThe SDK is copyrighted and protected by the laws of the United States and other countries, and international treaty \nprovisions.\n\n8.2 Subject to the rights of NVIDIA and its suppliers in the SDK, you hold all rights, title and interest in and to your \napplications and your derivative works of the sample source code delivered in the SDK including their respective intellectual \nproperty rights. \n \n9. FEEDBACK. You may, but are not obligated to, provide Feedback to NVIDIA. Feedback means all suggestions, fixes, \nmodifications, feature requests or other feedback regarding the SDK. Feedback, even if designated as confidential by you, \nshall not create any confidentiality obligation for NVIDIA. If you provide Feedback, you hereby grant NVIDIA, its affiliates \nand its designees a non-exclusive, perpetual, irrevocable, sublicensable, worldwide, royalty-free, fully paid-up and \ntransferable license, under your intellectual property rights, to publicly perform, publicly display, reproduce, use, make, \nhave made, sell, offer for sale, distribute (through multiple tiers of distribution), import, create derivative works of and \notherwise commercialize and exploit the Feedback at NVIDIAs discretion. You will not give Feedback (i) that you have \nreason to believe is subject to any restriction that impairs the exercise of the grant stated in this section, such as third-party \nintellectual property rights or (ii) subject to license terms which seek to require any product incorporating or developed \nusing such Feedback, or other intellectual property of NVIDIA or its affiliates, to be licensed to or otherwise shared with any \nthird party. \n\n10. NO WARRANTIES. THE SDK IS PROVIDED AS-IS. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW NVIDIA AND \nITS AFFILIATES EXPRESSLY DISCLAIM ALL WARRANTIES OF ANY KIND OR NATURE, WHETHER EXPRESS, IMPLIED OR \nSTATUTORY, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, FITNESS FOR A \nPARTICULAR PURPOSE, USAGE OF TRADE AND COURSE OF DEALING. NVIDIA DOES NOT WARRANT THAT THE SDK WILL \nMEET YOUR REQUIREMENTS OR THAT THE OPERATION THEREOF WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ALL \nERRORS WILL BE CORRECTED. \n\n11. LIMITATIONS OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW NVIDIA AND ITS AFFILIATES SHALL \nNOT BE LIABLE FOR ANY (I) SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, OR FOR DAMAGES FOR (A) \nANY LOST PROFITS, PROJECT DELAYS, LOSS OF USE, LOSS OF DATA OR LOSS OF GOODWILL, OR (B) THE COSTS OF \nPROCURING SUBSTITUTE PRODUCTS, ARISING OUT OF OR IN CONNECTION WITH THIS LICENSE OR THE USE OR \nPERFORMANCE OF THE SDK, WHETHER SUCH LIABILITY ARISES FROM ANY CLAIM BASED UPON BREACH OF CONTRACT, \nBREACH OF WARRANTY, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY OR ANY OTHER CAUSE OF ACTION OR \nTHEORY OF LIABILITY, EVEN IF NVIDIA HAS PREVIOUSLY BEEN ADVISED OF, OR COULD REASONABLY HAVE FORESEEN, THE \nPOSSIBILITY OF SUCH DAMAGES. IN NO EVENT WILL NVIDIAS AND ITS AFFILIATES TOTAL CUMULATIVE LIABILITY UNDER OR \nARISING OUT OF THIS LICENSE EXCEED US$10.00. THE NATURE OF THE LIABILITY OR THE NUMBER OF CLAIMS OR SUITS \nSHALL NOT ENLARGE OR EXTEND THIS LIMIT. \n\n12. TERMINATION. Your rights under this license will terminate automatically without notice from NVIDIA if you fail to \ncomply with any term and condition of this license or if you commence or participate in any legal proceeding against \nNVIDIA with respect to the SDK. NVIDIA may terminate this license with advance written notice to you, if NVIDIA decides to \nno longer provide the SDK in a country or, in NVIDIAs sole discretion, the continued use of it is no longer commercially \nviable. Upon any termination of this license, you agree to promptly discontinue use of the SDK and destroy all copies in your \npossession or control. Your prior distributions in accordance with this license are not affected by the termination of this \nlicense. All provisions of this license will survive termination, except for the license granted to you. \n\n13. APPLICABLE LAW. This license will be governed in all respects by the laws of the United States and of the State of \nDelaware, without regard to the conflicts of laws principles. The United Nations Convention on Contracts for the \nInternational Sale of Goods is specifically disclaimed. You agree to all terms of this license in the English language. The state \nor federal courts residing in Santa Clara County, California shall have exclusive jurisdiction over any dispute or claim arising \nout of this license. Notwithstanding this, you agree that NVIDIA shall still be allowed to apply for injunctive remedies or \nurgent legal relief in any jurisdiction. \n\n14. NO ASSIGNMENT. This license and your rights and obligations thereunder may not be assigned by you by any means or \noperation of law without NVIDIAs permission. Any attempted assignment not approved by NVIDIA in writing shall be void \nand of no effect. NVIDIA may assign, delegate or transfer this license and its rights and obligations, and if to a non-affiliate \nyou will be notified.\n \n15. EXPORT. The SDK is subject to United States export laws and regulations. You agree to comply with all applicable U.S. \nand international export laws, including the Export Administration Regulations (EAR) administered by the U.S. Department \nof Commerce and economic sanctions administered by the U.S. Department of Treasurys Office of Foreign Assets Control \n(OFAC). These laws include restrictions on destinations, end-users and end-use. By accepting this license, you confirm that \nyou are not currently residing in a country or region currently embargoed by the U.S. and that you are not otherwise \nprohibited from receiving the SDK.\n\n16. GOVERNMENT USE. The SDK, documentation and technology (Protected Items) are Commercial products as this \nterm is defined at 48 C.F.R. 2.101, consisting of commercial computer software and commercial computer software \ndocumentation as such terms are used in, respectively, 48 C.F.R. 12.212 and 48 C.F.R. 227.7202 & 252.227-7014(a)(1). \nBefore any Protected Items are supplied to the U.S. Government, you will (i) inform the U.S. Government in writing that the \nProtected Items are and must be treated as commercial computer software and commercial computer software \ndocumentation developed at private expense; (ii) inform the U.S. Government that the Protected Items are provided \nsubject to the terms of the Agreement; and (iii) mark the Protected Items as commercial computer software and \ncommercial computer software documentation developed at private expense. In no event will you permit the U.S. \nGovernment to acquire rights in Protected Items beyond those specified in 48 C.F.R. 52.227-19(b)(1)-(2) or 252.227-7013(c) \nexcept as expressly approved by NVIDIA in writing.\n\n17. NOTICES. You agree that any notices that NVIDIA sends you electronically, such as via email, will satisfy any legal \ncommunication requirements. Please direct your legal notices or other correspondence to NVIDIA Corporation, 2788 San \nTomas Expressway, Santa Clara, California 95051, United States of America, Attention: Legal Department.\n\n18. ENTIRE AGREEMENT. This license is the final, complete and exclusive agreement between the parties relating to the \nsubject matter of this license and supersedes all prior or contemporaneous understandings and agreements relating to this \nsubject matter, whether oral or written. If any court of competent jurisdiction determines that any provision of this license \nis illegal, invalid or unenforceable, the remaining provisions will remain in full force and effect. Any amendment or waiver \nunder this license shall be in writing and signed by representatives of both parties.\n\n19. LICENSING. If the distribution terms in this license are not suitable for your organization, or for any questions regarding \nthis license, please contact NVIDIA at nvidia-rtx-license-questions@nvidia.com.\n(v. February 23, 2024)\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\nNVIDIA RTX SUPPLEMENT TO SOFTWARE LICENSE AGREEMENT FOR NVIDIA SOFTWARE DEVELOPMENT KITS\nThe terms in this supplement govern your use of the NVIDIA RTX SDKs, including the DLSS SDK, NGX SDK, RTXGI SDK, RTXDI \nSDK, Video SDK and/or NRD SDK, if and when made available to you (in each case, the SDK) under the terms of your \nlicense agreement (Agreement) as modified by this supplement. Capitalized terms used but not defined below have the \nmeaning assigned to them in the Agreement.\nThis supplement is an exhibit to the Agreement and is incorporated as an integral part of the Agreement. In the event of \nconflict between the terms in this supplement and the terms in the Agreement, the terms in this supplement govern. \n\n1. Interoperability. Your applications that incorporate, or are based on, the SDK must be fully interoperable with \ncompatible GPU hardware products designed by NVIDIA or its affiliates. Further, the DLSS SDK and NGX SDK are licensed for \nyou to develop applications only for their use in systems with NVIDIA GPUs.\n\n2. Game License. You may, but are not obligated to, provide your game or related content (Game Content) to NVIDIA. If \nyou provide Game Content, you hereby grant NVIDIA, its affiliates and its designees a non-exclusive, perpetual, irrevocable, \nworldwide, royalty-free, fully paid-up license, to use the Game Content to improve NVIDIA DLSS SDK and DLSS Model \nTraining. The terms in this section do not apply to the Video SDK.\n\n3. Limitations for the DLSS SDK and NGX SDK. Your applications that incorporate, or are based on, the DLSS SDK or NGX SDK \nmay be deployed in a cloud service that runs on systems that consume NVIDIA vGPU software, and any other cloud service \nuse of such SDKs or their functionality is outside of the scope of the Agreement. For the purpose of this section, cloud \nservices include application service providers or service bureaus, operators of hosted/virtual system environments, or \nhosting, time sharing or providing any other type of service to others. \n4. Notification for the DLSS SDK and NGX SDK. You are required to notify NVIDIA prior to commercial release of an \napplication (including a plug-in to a commercial application) that incorporates, or is based on, the DLSS SDK or NGX SDK. \nPlease send notifications to: https://developer.nvidia.com/sw-notification and provide the following information in the \nemail: company name, publisher and developer name, NVIDIA SDK used, application name, platform (i.e. PC, Linux), \nscheduled ship date, and weblink to product/video. \n\n5. Audio and Video Encoders and Decoders. You acknowledge and agree that it is your sole responsibility to obtain any \nadditional third-party licenses required to make, have made, use, have used, sell, import, and offer for sale your products or \nservices that include or incorporate any third-party software and content relating to audio and/or video encoders and \ndecoders from, including but not limited to, Microsoft, Thomson, Fraunhofer IIS, Sisvel S.p.A., MPEG-LA, and Coding \nTechnologies. NVIDIA does not grant to you under this Agreement any necessary patent or other rights with respect to any \naudio and/or video encoders and decoders. The terms in this section do not apply to the Video SDK.\n\n6. DLSS SDK Terms. By installing or using the DLSS SDK you agree that NVIDIA can make over-the-air updates of DLSS in \nsystems that have DLSS installed, including (without limitation) for quality, stability or performance improvements or to \nsupport new hardware. If you publicly release a DLSS integration in an end user game or application that presents material \nstability, performance, image quality, or other technical issues impacting the user experience, you will work to quickly \naddress the integration issues. In the case issues are not addressed, NVIDIA reserves the right, as a last resort, to \ntemporarily disable the DLSS integration until the issues can be fixed.\n7. Marketing.\n7.1 Marketing Activities. Your license to the SDK(s) under the Agreement is subject to your compliance with the following \nmarketing terms:\n(a) Identification by You in the DLSS SDK, Video SDK or NGX SDK. During the term of the Agreement, NVIDIA agrees that \nyou may identify NVIDIA on your websites, printed collateral, trade-show displays and other retail packaging materials, as \nthe supplier of the DLSS SDK, Video SDK or NGX SDK for the applications that were developed with use of such SDKs, \nprovided that all such references to NVIDIA will be subject to NVIDIA's prior review and written approval, which will not be \nunreasonably withheld or delayed. \n(b) NVIDIA Trademark Placement in Applications with the DLSS SDK or NGX SDK. For applications that incorporate the DLSS \nSDK or NGX SDK or portions thereof, you must attribute the use of the applicable SDK and include the NVIDIA Marks on \nsplash screens, in the about box of the application (if present), and in credits for game applications.\n(c) NVIDIA Trademark Placement in Applications with a licensed SDK, other than the DLSS SDK, Video SDK or NGX SDK. For \napplications that incorporates and/or makes use of a licensed SDK, other than the DLSS SDK, Video SDK or NGX SDK, you \nmust attribute the use of the applicable SDK and include the NVIDIA Marks on the credit screen for applications that have \nsuch credit screen, or where a credit screen is not present prominently in end user documentation for the application. \n(d) Identification by NVIDIA in the DLSS SDK, Video SDK or NGX SDK. You agree that NVIDIA may identify you on NVIDIA's \nwebsites, printed collateral, trade-show displays, and other retail packaging materials as an individual or entity that \nproduces products and services which incorporate the DLSS SDK, Video SDK or NGX SDK as applicable. To the extent that \nyou provide NVIDIA with input or usage requests with regard to the use of your logo or materials, NVIDIA will use \ncommercially reasonable efforts to comply with such requests. For the avoidance of doubt, NVIDIAs rights pursuant to this \nsection shall survive any expiration or termination of the Agreement with respect to existing applications which incorporate \nthe DLSS SDK, Video SDK or NGX SDK.\n(e) Applications Marketing Material in the DLSS SDK Video SDK or NGX SDK. You may provide NVIDIA with screenshots, \nimagery, and video footage of applications representative of your use of the NVIDIA DLSS SDK or NGX SDKs in your \napplication (collectively, Assets). You hereby grant to NVIDIA the right to create and display self-promotional demo \nmaterials using the Assets, and after release of the application to the public to distribute, sub-license, and use the Assets to \npromote and market the NVIDIA RTX SDKs. To the extent you provide NVIDIA with input or usage requests with regard to \nthe use of your logo or materials, NVIDIA will use commercially reasonable efforts to comply with such requests. For the \navoidance of doubt, NVIDIAs rights pursuant to this section shall survive any termination of the Agreement with respect to \napplications which incorporate the NVIDIA RTX SDK.\n7.2 Trademark Ownership and Licenses. Trademarks are owned and licenses as follows:\n(a)\tOwnership of Trademarks. Each party owns the trademarks, logos, and trade names (collectively \"Marks\") for their \nrespective products or services, including without limitation in applications, and the NVIDIA RTX SDKs. Each party agrees to \nuse the Marks of the other only as permitted in this exhibit.\n\n(b)\tTrademark License to NVIDIA. You grant to NVIDIA a non-exclusive, non-sub licensable, non-transferable (except as set \nforth in the assignment provision of the Agreement), worldwide license to refer to you and your applications, and to use \nyour Marks on NVIDIA's marketing materials and on NVIDIA's website (subject to any reasonable conditions of you) solely \nfor NVIDIAs marketing activities set forth in this exhibit Sections (d)-(e) above. NVIDIA will follow your specifications for \nyour Marks as to style, color, and typeface as reasonably provided to NVIDIA.\n\n(c)\tTrademark License to You. NVIDIA grants to you a non-exclusive, non-sub licensable, non-transferable (except as set \nforth in the assignment provision of the Agreement), worldwide license, subject to the terms of this exhibit and the \nAgreement, to use NVIDIA RTX, NVIDIA GeForce RTX in combination with GeForce products, and/or NVIDIA Quadro \nRTX in combination with Quadro products (collectively, the NVIDIA Marks) on your marketing materials and on your \nwebsite (subject to any reasonable conditions of NVIDIA) solely for your marketing activities set forth in this exhibit Sections \n6.1 (a)-(c) above. For the avoidance of doubt, you will not and will not permit others to use any NVIDIA Mark for any other \ngoods or services, or in a way that tarnishes, degrades, disparages or reflects adversely any of the NVIDIA Marks or NVIDIAs \nbusiness or reputation, or that dilutes or otherwise harms the value, reputation or distinctiveness of or NVIDIAs goodwill in \nany NVIDIA Mark. In addition to the termination rights set forth in the Agreement, NVIDIA may terminate this trademark \nlicense at any time upon written notice to you. You will follow NVIDIA's use guidelines and specifications for NVIDIA's Marks \nas to style, color and typeface as provided in NVIDIA Marks and submit a sample of each proposed use of NVIDIA's Marks at \nleast two (2) weeks prior to the desired implementation of such use to obtain NVIDIA's prior written approval (which \napproval will not be unreasonably withheld or delayed). If NVIDIA does not respond within ten (10) business days of your \nsubmission of such sample, the sample will be deemed unapproved. All goodwill associated with use of NVIDIA Marks will \ninure to the sole benefit of NVIDIA. For the video SDK, contact NVIDIA at nvidia-rtx-video-sdk-license-\nquestions@nvidia.com.\n\n7.3 Use Guidelines. Use of the NVIDIA Marks is subject to the following guidelines:\n(a)\tBusiness Practices. You covenant that you will: (a) conduct business with respect to NVIDIAs products in a manner that \nreflects favorably at all times on the good name, goodwill and reputation of such products; (b) avoid deceptive, misleading \nor unethical practices that are detrimental to NVIDIA, its customers, or end users; (c) make no false or misleading \nrepresentations with regard to NVIDIA or its products; and (d) not publish or employ or cooperate in the publication or \nemployment of any misleading or deceptive advertising or promotional materials.\n\n(b)\tNo Combination Marks or Similar Marks. You agree not to (a) combine NVIDIA Marks with any other content without \nNVIDIAs prior written approval, or (b) use any other trademark, trade name, or other designation of source which creates a \nlikelihood of confusion with NVIDIA Marks.\n\n(v. February 23, 2024)\n\n"
},
{
"path": "README.md",
"content": "# RTX Mega Geometry\n\n\n\n \n
\n \n\n## Overview\n\nRTX Mega Geometry (RTX MG) is a DX12 and Vulkan code sample that shows how to quickly\nbuild ray-tracing acceleration structures for subdivision surfaces with structured\nclusters. It contains a reference HLSL path tracing demo app that can be used as a\nlearning tool to begin integration with your own graphics engine.\n\n## Features\n\n* Real-time adaptive sampling of Catmull-Clark limit surfaces\n* Structured cluster tessellation and displacement mapping\n* BVH build with cluster templates using NVAPI for DXR, and the VK_NV_cluster_acceleration_structure extension for Vulkan.\n* Hierarchical Z-buffer for reducing tessellation rate of non-primary ray geometry\n* DLSS Ray Reconstruction denoising\n\n## Requirements\n\nTo Run:\n- Windows 10\n- NVIDIA RTX GPU (10 GB VRAM or greater)\n- GeForce Game Ready Driver 570 or later\n- DirectX Raytracing 1.1 API or later\n\nTo Build:\n- CMake v3.31+\n- Windows 10 SDK 10.0.20348.0 or later\n- MSVC Compiler 19.43.34810 (Visual Studio 2022 17.13) or later\n- For Windows: DirectX 12 AgilitySDK will be fetched automatically\n- For Vulkan: Vulkan SDK 1.4.313 or later\n\n## Folder Structure\n\n| | |\n| -\t | - |\n| /bin | default CMake folder for binaries and compiled shaders |\n| /build | default CMake folder for build files |\n| /external\t| external submoduled libraries and SDKs, including osd_lite and donut |\n| /assets | models, textures, scene files (git submodule) |\n| /rtxmg | **RTX Mega Geometry core** |\n\n## Build\n\nAt the moment, only Windows builds are supported.\n\n1. Clone the repository **with all submodules recursively**:\n \n `git clone --recurse-submodules https://github.com/NVIDIA-RTX/rtxmg.git`\n\n2. Use CMake to configure the build and generate the project files.\n \n ```\n cd rtxmg\n cmake CMakeLists.txt -B ./build\n ```\n\n Use `-G \"some tested VS version\"` if specific Visual Studio or other environment \n version required. Make sure the x64 platform is used. \n\n3. Build the solution generated by CMake in the `./build/` folder.\n\n For example, if using Visual Studio, open the generated solution `build/rtxmg.sln` \n and build it.\n\n4. Select and run the `rtxmg_demo` project. Binaries get built to the `bin` folder. \n Media assets are loaded from the `assets` folder.\n\n\n ## User Interface\n\nOnce the application is running, most of the SDK features can be accessed via the\nUI window on the left hand side. The UI is self-documenting : hover the mouse over\nwidgets to read tool-tips. See the Quick Start guide\nfor more details.\n\nCamera can be moved using W/S/A/D keys and rotated by dragging with the left mouse\ncursor. Holding the Alt key and left-click dragging will orbit the camera around\nthe scene's center.\n\n## Command Line\n\n- `-mf` loads a specific .scene.json or OBJ file; \n example: `-mf programmer-art.scene.json`\n- `-d` to enable the graphics API debug layer or runtime, \n and the [NVRHI](https://github.com/NVIDIA-RTX/NVRHI) validation layer.\n \nAdditional command line flags can be found by running with the `-h` flag.\n\n## Contact\n\nRTX Mega Geometry is under active development. Please report any issues directly\nthrough GitHub issue tracker, and for any information, suggestions or general \nrequests please feel free to contact us at rtxmg-sdk-support@nvidia.com\n\n## Related RTX Mega Geometry Repositories\n\nVulkan\n * [vk_animated_clusters](https://github.com/nvpro-samples/vk_animated_clusters) :\n `VK_NV_cluster_acceleration_structure` for animated content.\n * [vk_tessellated_clusters](https://github.com/nvpro-samples/vk_tessellated_clusters) :\n adaptive triangle tessellation and displacement using `VK_NV_cluster_acceleration_structure`\n * [vk_lod_clusters](https://github.com/nvpro-samples/vk_lod_clusters) :\n cluster-lod system and streaming using `VK_NV_cluster_acceleration_structure`\n * [vk_partitioned_tlas](https://github.com/nvpro-samples/vk_partitioned_tlas)\n update the TLAS of large dynamic scenes with `VK_NV_partitioned_acceleration_structure`\n\nTools\n * [meshoptimizer.org](https://meshoptimizer.org) - meshoptimizer provides ray tracing friendly clusterization through `meshopt_buildMeshletsSpatial`. If you are interested in building a continuous level of detail system, have a look at its clusterlod.h demo, it shows the necessary steps.\n\n## Citation\nIf you use RTX Mega Geometry in a research project leading to a publication, \nplease cite the project.\n\nBibTex:\n```bibtex\n@online{RTX MG,\n title = {{{NVIDIA}}\\textregistered{} {RTX Mega Geometry}},\n author = {{NVIDIA}},\n year = 2025,\n url = {https://github.com/NVIDIA-RTX/rtxmg.git},\n urldate = {2025-02-06},\n}\n```\n\n## Known Issues\n\n1. The RTX MG SDK does not currently support unstructured clusters or rasterization.\n\n## License\n\nSee [LICENSE.txt](LICENSE.txt)\n\nThis project includes NVAPI software. All uses of NVAPI software are governed by the license terms specified here: https://github.com/NVIDIA/nvapi/blob/main/License.txt.\n"
},
{
"path": "demo/CMakeLists.txt",
"content": "# include (\"private.cmake\" OPTIONAL)\n\ninclude (\"${DONUT_DIR}/compileshaders.cmake\")\n\nadd_subdirectory(audio)\n\n\nfile(GLOB shaders \"shaders/*\")\nfile(GLOB sources \"*.cpp\" \"*.h\" \"osd_port_sources/tmr/*.h\" *.cfg)\n\nif(NOT EXISTS \"${PROJECT_SOURCE_DIR}/CMake/FetchImplot.cmake\")\n message(FATAL_ERROR \"Missing FetchImplot.cmake file\")\nendif()\ninclude(\"${PROJECT_SOURCE_DIR}/CMake/FetchImplot.cmake\")\nset_target_properties(implot PROPERTIES FOLDER \"Third-Party Libraries\")\n\nset(app rtxmg_demo)\nset(folder \"Demo\")\n\nlist(APPEND RTXMG_SHADERS_INCLUDE_DIR \"${CMAKE_CURRENT_SOURCE_DIR}\")\n\ndonut_compile_shaders_all_platforms(\n TARGET ${app}_shaders\n CONFIG ${CMAKE_CURRENT_SOURCE_DIR}/shaders.cfg\n FOLDER ${folder}\n SOURCES ${shaders}\n OUTPUT_BASE ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders/${app}\n SHADERMAKE_OPTIONS ${RTXMG_SHADERMAKE_OPTIONS}\n SHADERMAKE_OPTIONS_SPIRV ${RTXMG_SHADERMAKE_OPTIONS_SPIRV}\n SHADER_MODEL ${RTXMG_SHADERS_SHADERMODEL}\n IGNORE_INCLUDES ${RTXMG_SHADERS_IGNORED_INCLUDES}\n INCLUDES ${RTXMG_SHADERS_INCLUDE_DIR}\n)\n\nadd_executable(${app} \n ${sources} \n)\ntarget_link_libraries(${app} PUBLIC envmap rtxmg donut_render donut_app donut_engine implot)\n\noption(RTXMG_DEV_FEATURES \"Enable development features (debugging, etc)\" OFF)\nif(RTXMG_DEV_FEATURES)\n target_compile_definitions(${app} PUBLIC RTXMG_DEV_FEATURES=1)\nendif()\ntarget_compile_definitions(${app} PUBLIC RTXMG_VERSION=\"${PROJECT_VERSION}\")\n\nif(ENABLE_AUDIO_ENGINE)\n if(TARGET audio_engine)\n target_link_libraries(${app} PRIVATE audio_engine)\n else()\n message(WARNING \"Audio engine option is enabled, but configuration failed\")\n endif()\nendif()\n\nadd_dependencies(${app} ${app}_shaders)\nset_target_properties(${app} PROPERTIES FOLDER ${folder})\nadd_compile_definitions( \"_SILENCE_CXX17_CODECVT_HEADER_DEPRECATION_WARNING=1\")\n\ntarget_include_directories(${app} PUBLIC \n ${PROJECT_SOURCE_DIR} \n ${PROJECT_SOURCE_DIR}/extern\n)\n\nadd_subdirectory(envmap)\n\nif(DONUT_D3D_AGILITY_SDK_ENABLED)\n target_compile_definitions(${app} PUBLIC DONUT_D3D_AGILITY_SDK_ENABLED=1)\n target_compile_definitions(${app} PUBLIC DONUT_D3D_AGILITY_SDK_VERSION=${DONUT_D3D_AGILITY_SDK_VERSION})\n add_custom_command(TARGET ${app} POST_BUILD\n COMMAND \n ${CMAKE_COMMAND} -E make_directory \"$/D3D12/\"\n COMMAND \n ${CMAKE_COMMAND} -E copy_if_different ${DONUT_D3D_AGILITY_SDK_CORE_DLL} \"$/D3D12/\"\n )\nendif()\n\nif(WIN32)\n add_custom_command( TARGET ${app} POST_BUILD\n COMMAND ${CMAKE_COMMAND} -E copy $ $\n COMMAND_EXPAND_LISTS)\nendif()\n\n#\n# Installation & packaging\n#\nif(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)\n set(CMAKE_INSTALL_PREFIX \"${CMAKE_SOURCE_DIR}/_install\" CACHE PATH \"Installation directory\" FORCE)\nendif()\n\ninstall(TARGETS ${app} DESTINATION \"bin\")\n\ninstall(DIRECTORY \"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/shaders\" DESTINATION \"bin\" )\n\nif(WIN32)\n install(FILES $ DESTINATION \"bin\")\n\n # generate some shortcuts to run various scenes\n file(WRITE \"${CMAKE_CURRENT_BINARY_DIR}/run_rtxmg.bat\" \"start \\\"\\\" bin/rtxmg_demo.exe\")\n install(FILES \"${CMAKE_CURRENT_BINARY_DIR}/run_rtxmg.bat\" DESTINATION \".\")\n\n file(WRITE \"${CMAKE_CURRENT_BINARY_DIR}/run_amy_kitchenset.bat\" \"start \\\"\\\" bin/rtxmg_demo.exe -mf amy_kitchenset.scene.json\")\n install(FILES \"${CMAKE_CURRENT_BINARY_DIR}/run_amy_kitchenset.bat\" DESTINATION \".\")\n\n file(WRITE \"${CMAKE_CURRENT_BINARY_DIR}/run_barbarian.bat\" \"start \\\"\\\" bin/rtxmg_demo.exe -mf barbarian_pt.scene.json\")\n install(FILES \"${CMAKE_CURRENT_BINARY_DIR}/run_barbarian.bat\" DESTINATION \".\")\n\n set(_os \"win64\")\nelseif (UNIX AND NOT APPLE)\n set(_os \"linux64\")\nendif()\n\nif(DONUT_D3D_AGILITY_SDK_ENABLED)\n install(DIRECTORY \"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/D3D12\" DESTINATION \"bin\" )\nendif()\n\nif(IS_DIRECTORY \"${PROJECT_SOURCE_DIR}/assets\")\n install(\n DIRECTORY \"${PROJECT_SOURCE_DIR}/assets\" \n DESTINATION \".\" \n PATTERN \"*.bin\" EXCLUDE)\nendif()\n\nset(CPACK_GENERATOR \"ZIP\")\nset(CPACK_PACKAGE_FILE_NAME \"${CMAKE_PROJECT_NAME}.${PROJECT_VERSION}.${_os}\")\n\ninclude(CPack)\n"
},
{
"path": "demo/args.cpp",
"content": "//\n// Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n//\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// * Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// * Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// * Neither the name of NVIDIA CORPORATION nor the names of its\n// contributors may be used to endorse or promote products derived\n// from this software without specific prior written permission.\n//\n// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY\n// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\n// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\n// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\n// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\n// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\n// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n//\n\n// clang-format off\n\n#include \"args.h\"\n#include \"rtxmg_demo.h\"\n\n#include \n#include \n#include \n#include