RT wrapper, VisRTX backend

Author: tbiedert

.gitignore

@@ -15,3 +15,7 @@ project.xcworkspace
 
 # Exclude VSCode settings and configuration folder
 *.vscode*
+
+# Exclude Visual Studio stuff
+.vs*
+CMakeSettings.json

CMake/FindOptiX.cmake

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
+# Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions
@@ -26,21 +26,19 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-# Locate the OptiX distribution.  Search relative to the SDK first, then look in the system.
 
-# Our initial guess will be within the SDK.
-set(OptiX_INSTALL_DIR "${CMAKE_SOURCE_DIR}/../" CACHE PATH "Path to OptiX installed location.")
-
-# The distribution contains both 32 and 64 bit libraries.  Adjust the library
-# search path based on the bit-ness of the build.  (i.e. 64: bin64, lib64; 32:
-# bin, lib).  Note that on Mac, the OptiX library is a universal binary, so we
+# Adjust the library search path based on the bit-ness of the build.
+# (i.e. 64: bin64, lib64; 32: bin, lib).
+# Note that on Mac, the OptiX library is a universal binary, so we
 # only need to look in lib and not lib64 for 64 bit builds.
 if(CMAKE_SIZEOF_VOID_P EQUAL 8 AND NOT APPLE)
   set(bit_dest "64")
 else()
   set(bit_dest "")
 endif()
 
+set(OptiX_INSTALL_DIR "" CACHE PATH "Path to OptiX installed location.")
+
 macro(OPTIX_find_api_library name version)
   find_library(${name}_LIBRARY
     NAMES ${name}.${version} ${name}
@@ -62,9 +60,42 @@ macro(OPTIX_find_api_library name version)
   endif()
 endmacro()
 
-OPTIX_find_api_library(optix 1)
-OPTIX_find_api_library(optixu 1)
-OPTIX_find_api_library(optix_prime 1)
+# OptiX SDKs before 5.1.0 named the library optix.1.lib
+# Linux handles this via symlinks and doesn't need changes to the library name.
+set(OptiX_version "1")
+
+# The OptiX library is named with the major and minor digits since OptiX 5.1.0.
+# Dynamically find the matching library name by parsing the OptiX_INSTALL_DIR.
+# This only works if the installation retained the original folder format "OptiX SDK major.minor.micro".
+# We want the concatenated major and minor numbers if the version is greater or equal to 5.1.0.
+if(WIN32)
+  if(OptiX_INSTALL_DIR)
+    string(REGEX REPLACE " |-" ";" OptiX_install_dir_list ${OptiX_INSTALL_DIR})
+    list(LENGTH OptiX_install_dir_list OptiX_install_dir_list_length)
+    if(${OptiX_install_dir_list_length} GREATER 0)
+      # Get the last list element, something like "5.1.0".
+      list(GET OptiX_install_dir_list -1 OptiX_version_string)
+      # Component-wise integer version number comparison (version format is major[.minor[.patch[.tweak]]]).
+      # Starting with OptiX 6.0.0, the full version number is used to avoid the Windows DLL hell.
+      if(${OptiX_version_string} VERSION_GREATER_EQUAL "6.0.0")
+        set(OptiX_version ${OptiX_version_string})
+      elseif(${OptiX_version_string} VERSION_GREATER_EQUAL "5.1.0")
+        set(OptiX_version "")
+        string(REPLACE "." ";" OptiX_major_minor_micro_list ${OptiX_version_string})
+        foreach(index RANGE 0 1)
+          list(GET OptiX_major_minor_micro_list ${index} number)
+          string(APPEND OptiX_version ${number})
+        endforeach()
+      endif()
+    endif()
+  endif()
+endif(WIN32)
+
+
+
+OPTIX_find_api_library(optix ${OptiX_version})
+OPTIX_find_api_library(optixu ${OptiX_version})
+OPTIX_find_api_library(optix_prime ${OptiX_version})
 
 # Include
 find_path(OptiX_INCLUDE
@@ -88,13 +119,13 @@ function(OptiX_report_error error_message required)
 endfunction()
 
 if(NOT optix_LIBRARY)
-  OptiX_report_error("optix library not found.  Please locate before proceeding." TRUE)
+  OptiX_report_error("OptiX library not found. Please set OptiX_INSTALL_DIR to locate it automatically." TRUE)
 endif()
 if(NOT OptiX_INCLUDE)
-  OptiX_report_error("OptiX headers (optix.h and friends) not found.  Please locate before proceeding." TRUE)
+  OptiX_report_error("OptiX headers (optix.h and friends) not found. Please set OptiX_INSTALL_DIR to locate them automatically." TRUE)
 endif()
 if(NOT optix_prime_LIBRARY)
-  OptiX_report_error("optix Prime library not found.  Please locate before proceeding." FALSE)
+  OptiX_report_error("OptiX Prime library not found. Please set OptiX_INSTALL_DIR to locate it automatically." FALSE)
 endif()
 
 # Macro for setting up dummy targets
@@ -135,8 +166,8 @@ endfunction()
 
 # Sets up a dummy target
 OptiX_add_imported_library(optix "${optix_LIBRARY}" "${optix_DLL}" "${OPENGL_LIBRARIES}")
-OptiX_add_imported_library(optixu   "${optixu_LIBRARY}"   "${optixu_DLL}"   "")
-OptiX_add_imported_library(optix_prime "${optix_prime_LIBRARY}"  "${optix_prime_DLL}"  "")
+OptiX_add_imported_library(optixu "${optixu_LIBRARY}" "${optixu_DLL}" "")
+OptiX_add_imported_library(optix_prime "${optix_prime_LIBRARY}" "${optix_prime_DLL}" "")
 
 macro(OptiX_check_same_path libA libB)
   if(_optix_path_to_${libA})

Rendering/OSPRay/CMakeLists.txt

@@ -16,6 +16,12 @@ set(classes
   vtkOSPRayVolumeNode
   vtkOSPRayWindowNode)
 
+set(RTWrapper_sources
+    RTWrapper/RTWrapper.cxx)
+
+set(RTWrapper_headers
+    RTWrapper/RTWrapper.h)
+
 vtk_object_factory_declare(
   BASE vtkOSPRayVolumeInterface
   OVERRIDE vtkOSPRayVolumeMapper)
@@ -25,36 +31,66 @@ vtk_object_factory_configure(
   HEADER_FILE vtk_object_factory_header
   EXPORT_MACRO "VTKRENDERINGOSPRAY_EXPORT")
 
+# OSPRay
+option(VTK_ENABLE_OSPRAY "Enable OSPRay rendering backend" ON)
+set(OSPRAY_INSTALL_DIR "" CACHE PATH "Install location of OSPRay")
+mark_as_advanced(OSPRAY_INSTALL_DIR)
+if (VTK_ENABLE_OSPRAY)
+  # TODO: Send patches upstream to export targets from ospray.
+  find_package(ospray 1.8 REQUIRED HINTS ${OSPRAY_INSTALL_DIR})
+
+  option(VTKOSPRAY_ENABLE_DENOISER "Build OSPRay Renderer using OpenImageDenoise")
+  if (VTKOSPRAY_ENABLE_DENOISER)
+    find_package(OpenImageDenoise 0.8 REQUIRED)
+    add_definitions(-DVTKOSPRAY_ENABLE_DENOISER)
+    set(OPENIMAGEDENIOSE OpenImageDenoise)
+  endif()
+endif()
+
+
+# VisRTX
+option(VTK_ENABLE_VISRTX "Enable VisRTX rendering backend" ON)
+set(VISRTX_INSTALL_DIR "" CACHE PATH "Install location of VisRTX")
+mark_as_advanced(VISRTX_INSTALL_DIR)
+if (VTK_ENABLE_VISRTX)
+  find_package(VisRTX CONFIG REQUIRED HINTS ${VISRTX_INSTALL_DIR})
+endif()
+if (VisRTX_FOUND)
+  list(APPEND RTWrapper_sources RTWrapper/VisRTX/VisRTXBackend.cxx)
+endif()
+
+if (NOT ospray_FOUND AND NOT VisRTX_FOUND)
+  message("Warning: Ray tracing requires OSPRay and/or VisRTX, turn VTK_ENABLE_OSPRAY and/or VTK_ENABLE_VISRTX ON.")
+endif()
+
+
 vtk_module_add_module(VTK::RenderingOSPRay
   CLASSES ${classes}
-  SOURCES ${vtk_object_factory_source}
-  PRIVATE_HEADERS ${vtk_object_factory_header})
-
-option(VTKOSPRAY_ENABLE_DENOISER "build OSPRay Renderer using OpenImageDenoise")
-if (VTKOSPRAY_ENABLE_DENOISER)
-  find_package(OpenImageDenoise 0.8 REQUIRED)
-  add_definitions(-DVTKOSPRAY_ENABLE_DENOISER)
-  set(OPENIMAGEDENIOSE OpenImageDenoise)
-endif()
+  SOURCES ${vtk_object_factory_source} ${RTWrapper_sources}
+  PRIVATE_HEADERS ${vtk_object_factory_header} ${RTWrapper_headers})
+
 
-# TODO: Send patches upstream to export targets from ospray.
-find_package(ospray 1.8 REQUIRED)
-vtk_module_link(VTK::RenderingOSPRay
-  PUBLIC
-    ${OSPRAY_LIBRARIES}
-  PRIVATE
-    ${OPENIMAGEDENIOSE}
-)
-
-vtk_module_include(VTK::RenderingOSPRay
-  PUBLIC
-    ${OSPRAY_INCLUDE_DIRS}
-)
-
-# TODO: FindOSPRay should do this.
-# OSPRay_Core uses MMTime which is in it's own special library.
-if (WIN32)
+if (ospray_FOUND)
   vtk_module_link(VTK::RenderingOSPRay
+    PUBLIC
+      ${OSPRAY_LIBRARIES}
     PRIVATE
-      Winmm)
-endif ()
+      ${OPENIMAGEDENIOSE})
+  vtk_module_include(VTK::RenderingOSPRay
+    PUBLIC
+    ${OSPRAY_INCLUDE_DIRS})
+
+  # TODO: FindOSPRay should do this.
+  # OSPRay_Core uses MMTime which is in it's own special library.
+  if (WIN32)
+    vtk_module_link(VTK::RenderingOSPRay
+      PRIVATE
+        Winmm)
+  endif ()
+  vtk_module_definitions(VTK::RenderingOSPRay PRIVATE VTK_ENABLE_OSPRAY)
+endif()
+
+if (VisRTX_FOUND)
+  vtk_module_link(VTK::RenderingOSPRay PUBLIC VisRTX_DynLoad)
+  vtk_module_definitions(VTK::RenderingOSPRay PRIVATE VTK_ENABLE_VISRTX)
+endif()

Rendering/OSPRay/RTWrapper/Backend.h

@@ -0,0 +1,82 @@
+#pragma once
+
+#include "Types.h"
+
+namespace RTW
+{
+    class Backend
+    {
+    public:
+        virtual ~Backend() = default;
+
+    public:
+        virtual RTWError Init(int *argc, const char **argv) = 0;
+        virtual void Shutdown() = 0;
+
+        virtual bool IsSupported(RTWFeature feature) const = 0;
+
+        virtual RTWData NewData(size_t numItems, RTWDataType, const void *source, const uint32_t dataCreationFlags = 0) = 0;
+        virtual RTWGeometry NewGeometry(const char *type) = 0;
+        virtual RTWTexture NewTexture(const char* type) = 0;
+        virtual RTWLight NewLight(RTWRenderer, const char *type) = 0;
+        virtual RTWLight NewLight2(const char *renderer_type, const char *light_type) = 0;
+        virtual RTWLight NewLight3(const char *light_type) = 0;
+        virtual RTWMaterial NewMaterial(RTWRenderer, const char *material_type) = 0;
+        virtual RTWMaterial NewMaterial2(const char *renderer_type, const char *material_type) = 0;
+        virtual RTWVolume NewVolume(const char *type) = 0;
+        virtual RTWTransferFunction NewTransferFunction(const char *type) = 0;
+        virtual RTWRenderer NewRenderer(const char *type) = 0;
+        virtual RTWCamera NewCamera(const char *type) = 0;
+        virtual RTWModel NewModel() = 0;
+        virtual RTWGeometry NewInstance(RTWModel modelToInstantiate, const rtw::affine3f &transform) = 0;
+        virtual RTWFrameBuffer NewFrameBuffer(const rtw::vec2i &size, const RTWFrameBufferFormat format, const uint32_t frameBufferChannels) = 0;
+
+        virtual void Release(RTWObject) = 0;
+
+        virtual void AddGeometry(RTWModel, RTWGeometry) = 0;
+        virtual void AddVolume(RTWModel, RTWVolume) = 0;
+
+        virtual void SetString(RTWObject, const char *id, const char *s) = 0;
+        virtual void SetObject(RTWObject, const char *id, RTWObject other) = 0;
+        virtual void SetData(RTWObject, const char *id, RTWData) = 0;
+        virtual void SetMaterial(RTWGeometry, RTWMaterial) = 0;
+        virtual void Set1i(RTWObject, const char *id, int32_t x) = 0;
+        virtual void Set2i(RTWObject, const char *id, int32_t x, int32_t y) = 0;
+        virtual void Set1f(RTWObject, const char *id, float x) = 0;
+        virtual void Set2f(RTWObject, const char *id, float x, float y) = 0;
+        virtual void Set3i(RTWObject, const char *id, int x, int y, int z) = 0;
+        virtual void Set3f(RTWObject, const char *id, float x, float y, float z) = 0;
+        virtual void Set4f(RTWObject, const char *id, float x, float y, float z, float w) = 0;
+
+        virtual RTWError SetRegion(RTWVolume, void *source, const rtw::vec3i &regionCoords, const rtw::vec3i &regionSize) = 0;
+
+        virtual void Commit(RTWObject) = 0;
+
+        virtual float RenderFrame(RTWFrameBuffer, RTWRenderer, const uint32_t frameBufferChannels) = 0;
+
+        virtual void FrameBufferClear(RTWFrameBuffer, const uint32_t frameBufferChannels) = 0;
+        virtual const void* MapFrameBuffer(RTWFrameBuffer, const RTWFrameBufferChannel) = 0;
+        virtual void UnmapFrameBuffer(const void *mapped, RTWFrameBuffer) = 0;
+
+        virtual void SetDepthNormalizationGL(RTWFrameBuffer frameBuffer, float clipMin, float clipMax) = 0;
+        virtual int GetColorTextureGL(RTWFrameBuffer frameBuffer) = 0;
+        virtual int GetDepthTextureGL(RTWFrameBuffer frameBuffer) = 0;
+
+        // Convenience functions (TODO remove)
+        inline void Setf(RTWObject object, const char *id, float x)
+        {
+          Set1f(object, id, x);
+        }
+
+        inline void Set3fv(RTWObject object, const char *id, const float *xyz)
+        {
+          Set3f(object, id, xyz[0], xyz[1], xyz[2]);
+        }
+
+        inline void SetVec2f(RTWObject object, const char *id, const rtw::vec2f &v)
+        {
+          Set2f(object, id, v.x, v.y);
+        }
+
+    };
+}