Displacement-MicroMap-Toolkit squash

commit c67035766aa14bba8c5a645b052fbc3c03b7922d

Co-authored-by: Brian Barran <[email protected]>
Co-authored-by: Christoph Kubisch <[email protected]>
Co-authored-by: David Akeley <[email protected]>
Co-authored-by: Martin-Karl Lefrancois <[email protected]>
Co-authored-by: Mathias Heyer <[email protected]>
Co-authored-by: Neil Bickford <[email protected]>
Co-authored-by: Pascal Gautron <[email protected]>
Co-authored-by: Pyarelal Knowles <[email protected]>
Co-authored-by: Tristan Lorach <[email protected]>

Author: 9 people

CMakeLists.txt

@@ -3,14 +3,19 @@ cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
 cmake_policy(SET CMP0079 NEW) # Allow linking with targets in other directories
 project(
     micromesh_toolkit
-    VERSION 1.0
+    VERSION 1.1
     DESCRIPTION "Micromesh Tools"
     LANGUAGES C CXX)
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
 set(CMAKE_INSTALL_PREFIX "${CMAKE_CURRENT_SOURCE_DIR}/_install" CACHE PATH "folder in which INSTALL will put everything needed to run the binaries" FORCE)
 
+# Set the default for enabling beta extensions before nvpro_core. Beta
+# extensions can conflict if the Vulkan SDK and nvpro_core generated
+# nvvk/extensions_vk.hpp versions are different.
+option(VK_ENABLE_BETA_EXTENSIONS "Enable beta extensions provided by the Vulkan SDK" OFF)
+
 # Enable bounds and other error checking for gcc debug builds in std::vector
 set_directory_properties(PROPERTIES COMPILE_DEFINITIONS $<$<CONFIG:Debug>:_GLIBCXX_DEBUG>)
 
@@ -37,6 +42,17 @@ set(NVPRO_CORE_DIR ${BASE_DIRECTORY}/nvpro_core)
 if(MSVC)
     add_definitions(/wd26812)  # 'enum class' over 'enum'
     add_definitions(/wd26451)  # Arithmetic overflow, casting 4 byte value to 8 byte value
+else()
+  # Ignore warnings from some third party libraries by including them with -isystem
+  include_directories(SYSTEM
+    external/nvpro_core/
+    external/nvpro_core/imgui/
+    external/nvpro_core/third_party/stb/
+    external/nvpro_core/third_party/imgui/
+    external/nvpro_core/third_party/vma/include/
+    external/nvpro_core/third_party/tinygltf/
+    micromesh_toolbox/thirdparty/aftermath_sdk/include/
+    )
 endif()
 
 #--------------------------------------------------------------------------------------------------
@@ -48,6 +64,9 @@ _add_package_ZLIB()
 _add_package_VulkanSDK()
 _add_package_ShaderC()
 _add_package_ImGUI()
+if(WIN32)
+	_add_package_DirectX12()
+endif()
 _add_nvpro_core_lib()
 
 _add_package_Glm()
@@ -77,31 +96,27 @@ endfunction()
 
 find_first(PATH_BARY_CORE Displacement-MicroMap-BaryFile
   ${CMAKE_CURRENT_SOURCE_DIR}/external/Displacement-MicroMap-BaryFile
-  ${CMAKE_CURRENT_SOURCE_DIR}/external/bary_core
   ${CMAKE_CURRENT_SOURCE_DIR}/../bary_core
   ${CMAKE_CURRENT_SOURCE_DIR}/../sdk/bary_core
   )
 add_subdirectory(${PATH_BARY_CORE} ${CMAKE_BINARY_DIR}/bary_core)
 
 find_first(PATH_MICROMESH_CORE Displacement-MicroMap-SDK/micromesh_core
   ${CMAKE_CURRENT_SOURCE_DIR}/external/Displacement-MicroMap-SDK/micromesh_core
-  ${CMAKE_CURRENT_SOURCE_DIR}/external/micromesh_core
   ${CMAKE_CURRENT_SOURCE_DIR}/../micromesh_core
   ${CMAKE_CURRENT_SOURCE_DIR}/../sdk/micromesh_core
   )
 add_subdirectory(${PATH_MICROMESH_CORE} ${CMAKE_BINARY_DIR}/micromesh_core)
 
 find_first(PATH_SDK_COMPRESSION Displacement-MicroMap-SDK/micromesh_displacement_compression
   ${CMAKE_CURRENT_SOURCE_DIR}/external/Displacement-MicroMap-SDK/micromesh_displacement_compression
-  ${CMAKE_CURRENT_SOURCE_DIR}/external/micromesh_displacement_compression
   ${CMAKE_CURRENT_SOURCE_DIR}/../micromesh_displacement_compression
   ${CMAKE_CURRENT_SOURCE_DIR}/../sdk/micromesh_displacement_compression
   )
 add_subdirectory(${PATH_SDK_COMPRESSION} ${CMAKE_BINARY_DIR}/micromesh_displacement_compression)
 
 find_first(PATH_SDK_REMESHING Displacement-MicroMap-SDK/micromesh_displacement_remeshing
   ${CMAKE_CURRENT_SOURCE_DIR}/external/Displacement-MicroMap-SDK/micromesh_displacement_remeshing
-  ${CMAKE_CURRENT_SOURCE_DIR}/external/micromesh_displacement_remeshing
   ${CMAKE_CURRENT_SOURCE_DIR}/../micromesh_displacement_remeshing
   ${CMAKE_CURRENT_SOURCE_DIR}/../sdk/micromesh_displacement_remeshing
   )
@@ -141,8 +156,11 @@ if(WIN32) # Windows
     )
 else() # Linux
   set(MICROMESH_COMPILE_WARNINGS
-    -Wsign-compare
-    -Wconversion
+    -Werror
+    -Werror=sign-compare
+    -Werror=conversion
+    -Werror=format
+    -Werror=unused
     )
 endif()
 

README.md

@@ -3,6 +3,10 @@
 This toolkit provides libraries, samples and tools to create and view displaced micromeshes.
 It is a work in progress and feedback is welcome!
 
+The latest driver exposing `VK_NV_displacement_micromap` is required to
+raytrace micromeshes, such as the *Vulkan Beta Driver* available at
+https://developer.nvidia.com/vulkan-driver.
+
 We recommend to check the [Micro-Mesh Basics
 slides](https://developer.download.nvidia.com/ProGraphics/nvpro-samples/slides/Micro-Mesh_Basics.pdf)
 first as well as the [`dmm_displacement`
@@ -153,8 +157,8 @@ This `meshops` layer is still a bit work in progress as we are migrating additio
 ### **tools & libraries**
 
 All tools operate on glTF 2.0 files and do support additional micromap specific
-glTF extensions from NVIDIA. The spcifications are available at
-<https://github.com/NeilBickford-NV/glTF/tree/micro-mesh/extensions/2.0/Vendor>.
+glTF extensions from NVIDIA. The specifications are available at
+<https://github.com/KhronosGroup/glTF/pull/2273>.
 
 All micromap data is stored as `.bary` files which is a new container / file
 format that was specifically designed to allow direct storage of data consumed
@@ -262,6 +266,17 @@ from an original input mesh in the [Micro-Mesh Asset Pipeline
 slide-deck](https://developer.download.nvidia.com/ProGraphics/nvpro-samples/slides/Micro-Mesh_Asset_Pipeline.pdf)
 as well as in [docs/asset_pipeline.md](docs/asset_pipeline.md)
 
+## About the Latest Release (1.1)
+
+- Heightmap rendering in micromesh_toolkit with dynamic LOD
+- Memory estimate for baking high resolution heightmaps in batches
+- Micromesh USD schema definitions and libusd API
+- meshopsOpApplyBounds() to apply (and discard) direction bounds to positions and directions
+- Better glTF instancing/node hierarchy support for baking whole scenes
+- Fixes for image filename generation when resampling
+- Avoid leaving unused and empty glTF extension references
+- Fix matching regular texture names in automation/link_heightmaps.py
+
 ## Third-Party Licenses
 
 This project embeds or includes (as submodules) several third-party open-source
@@ -273,4 +288,4 @@ dependency](https://github.com/nvpro-samples/nvpro_core/tree/master/PACKAGE-LICE
 ## Support Contact
 
 Feel free to file issues directly on the GitHub page or reach out to NVIDIA at
-<[email protected]>
+<[email protected]>

automation/link_heightmaps.py

@@ -29,22 +29,37 @@
 parser.add_argument('--filter', nargs='+', help='Regex for material names to change')
 parser.add_argument('--filter-out', nargs='+', help='Regex for material names to ignore')
 parser.add_argument('--copy-from', type=pathlib.Path, help='Source gltf file to use as a template. Takes precedence over the image filename search.')
+parser.add_argument('--match-one-image', action='store_true', help='A heightmap will be matched to an image and only added to materials sharing that image. Reduces false positives.')
 #parser.add_argument('--heightmaps', nargs='+', type=pathlib.Path, help='Provide heightmap names explicitly in the order of materials')
 args = parser.parse_args()
 
 # Return true if the filename could be a heightmap
 def heightmapishName(name):
     return re.search(r'height|disp', name, re.IGNORECASE)
 
+def find_in_object(obj, target_name, depth):
+    if target_name in obj:
+        return obj[target_name]
+    if depth > 0:
+        for child in obj.values():
+            if isinstance(child, dict):
+                value = find_in_object(child, target_name, depth - 1)
+                if value is not None:
+                    return value
+    return None
+
 # Seach objects in the gltf json and return the ID for something referencing the given ID
 def find_ids(data, object_name, target_names, target_id):
     for id, obj in enumerate(data.get(object_name, [])):
         for target_name in target_names:
+            # Find target_name with depth 1 so baseColorTexture can be found in
+            # material.pbrMetallicRoughness instead of the material directly.
             #if args.verbose: print('Looking for {}=={} in {} {}'.format(target_name, target_id, object_name, id))
-            if target_name in obj:
-                if obj[target_name] == target_id:
+            value = find_in_object(obj, target_name, 1)
+            if value is not None:
+                if value == target_id:
                     yield id
-                elif isinstance(obj[target_name], dict) and obj[target_name].get('index') == target_id:
+                elif isinstance(value, dict) and value.get('index') == target_id:
                     yield id
 
 def heightmapMatchMetric(candidate, image, material_names):
@@ -149,8 +164,16 @@ def filterMaterialName(material_name):
     # Assume the most similar heightmap names belong to the same materials as existing images in a greedy fashion
     unlinked_heightmaps = []
     unlinked_material_ids = set()
+    best_image = {}
+    warn_multiple_matches = False
     for metric, candidate, image, material_ids in reversed(sorted(matches)):
         heightmap = candidate
+        if heightmap.name in best_image and best_image[heightmap.name] != image:
+            if args.match_one_image:
+                continue
+            elif not warn_multiple_matches:
+                warn_multiple_matches = True
+                print("Warning: adding the same heightmap multiple times consider enabling '--match-one-image'", file=sys.stderr)
         for material_id in set(material_ids) - unlinked_material_ids:
             unlinked_material_ids.add(material_id)
 
@@ -176,6 +199,7 @@ def filterMaterialName(material_name):
             # Add the material to the job list
             material_name = data['materials'][material_id]['name']
             unlinked_heightmaps += [(material_id, material_name, heightmap, image, sampler_id)]
+            best_image[heightmap.name] = image
 
     had_changes = False
 

common/vulkan_nv/vk_nv_micromesh.h

@@ -30,6 +30,10 @@
 
 #include <vulkan/vulkan_core.h>
 
+#ifdef VK_ENABLE_BETA_EXTENSIONS
+#include <vulkan/vulkan_beta.h>
+#endif
+
 // for name, value in test:gmatch("(VK_[%w_]+) = ([%w_]+),") do print("#define "..name.."  ((VkStructureType)"..value..")") end
 
 
@@ -330,7 +334,6 @@ extern "C" {
 #define VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_TRIANGLES_DISPLACEMENT_MICROMAP_NV ((VkStructureType)1000397002)
 #define VK_PIPELINE_CREATE_RAY_TRACING_DISPLACEMENT_MICROMAP_BIT_NV  ((VkPipelineCreateFlagBits)0x10000000)
 #define VK_BUILD_ACCELERATION_STRUCTURE_ALLOW_DISPLACEMENT_MICROMAP_UPDATE_NV ((VkBuildAccelerationStructureFlagBitsKHR)0x00000200)
-#define VK_BUILD_ACCELERATION_STRUCTURE_ALLOW_DISPLACEMENT_MICROMAP_INSTANCE_NV ((VkBuildAccelerationStructureFlagBitsKHR)0x00000400)
 #define VK_MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV                    ((VkMicromapTypeEXT)1000397000)
 
   typedef struct VkPhysicalDeviceDisplacementMicromapFeaturesNV {

external/Displacement-MicroMap-SDK

@@ -5,6 +5,8 @@ set(PROJECT_NAME "meshops_bake")
 
 # Sources and headers for the library
 set(SOURCE_FILES
+    meshops_bake_batch.hpp
+    meshops_bake_batch.cpp
     meshops_bake_vk.hpp
     meshops_bake_vk.cpp
     meshops_bake.cpp