Hide platform dependent details of IAPIConnection

Also fix the Vulkan SDK issue once and for all.

Author: devshgraphicsprogramming

.gitmodules

@@ -89,3 +89,7 @@
 [submodule "3rdparty/pstl/oneDPL/oneDPL"]
 	path = 3rdparty/pstl/oneDPL/oneDPL
 	url = https://github.com/Devsh-Graphics-Programming/oneDPL.git
+[submodule "3rdparty/Vulkan-Headers"]
+	path = 3rdparty/Vulkan-Headers
+	url = [email protected]:KhronosGroup/Vulkan-Headers.git
+	branch = main

3rdparty/CMakeLists.txt

@@ -47,29 +47,30 @@ set(BUILD_SHARED_LIBS ${_OLD_BUILD_SHARED_LIBS})
 set(BUILD_STATIC_LIBS ${_OLD_BUILD_STATIC_LIBS})
 set(BUILD_TESTING ${_OLD_BUILD_TESTING})
 
+
 # openssl
 add_subdirectory(openssl openssl EXCLUDE_FROM_ALL)
 
+
 # volk
-if(DEFINED ENV{VULKAN_SDK})
-	# workaround to make sure vulkan library will not be linked in examples
-	set(VOLK_PULL_IN_VULKAN OFF CACHE INTERNAL "" FORCE)
-	
-	if (WIN32)
-		set(VOLK_STATIC_DEFINES VK_USE_PLATFORM_WIN32_KHR)
-	endif()
-	add_subdirectory(volk volk EXCLUDE_FROM_ALL)
+set(VOLK_PULL_IN_VULKAN OFF CACHE INTERNAL "" FORCE) # Needed to make sure vulkan library will not be linked in examples
 
-    target_include_directories(volk PUBLIC "$ENV{VULKAN_SDK}/Include")
-    target_include_directories(volk_headers INTERFACE "$ENV{VULKAN_SDK}/Include")
+if (WIN32)
+	set(VOLK_STATIC_DEFINES VK_USE_PLATFORM_WIN32_KHR)
 endif()
+add_subdirectory(volk volk EXCLUDE_FROM_ALL)
+	
+target_include_directories(volk PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/Vulkan-Headers/include")
+target_include_directories(volk_headers INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/Vulkan-Headers/include")
 
 if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
 	add_subdirectory(pstl pstl)
 endif()
 
+
+# TODO: redo
 find_package(OpenGL OPTIONAL_COMPONENTS EGL)
-find_package(Wayland)  # TODO: remove, do it dynamically
+find_package(Wayland)  # TODO: remove, load Wayland dynamically
 #[[if (OpenGL_EGL_FOUND)
 	message(FATAL_ERROR "FOUND EGL!!")
 else()
@@ -85,8 +86,10 @@ if (OpenGL_EGL_FOUND AND UNIX AND NOT APPLE)
 		message(FATAL_ERROR "Using Wayland backend!!!")
 	endif()
 endif()
+# all of the above fuckery can be dismissed
 add_subdirectory(EGL/EGL)
 
+
 # zlib (target is zlibstatic)
 set(_OLD_BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS})
 set(_OLD_SKIP_INSTALL_ALL ${SKIP_INSTALL_ALL})
@@ -139,6 +142,7 @@ set(ZLIB_LIBRARY # for PNGLIB purposes
 		$<$<CONFIG:RelWithDebInfo>:${ZLIB_LIBRARY_RELWITHDEBINFO}>
 CACHE INTERNAL "" FORCE)
 
+
 set(SPIRV_HEADERS_SKIP_INSTALL ON CACHE INTERNAL "Skip SPIRV-Headers install")
 set(SPIRV_HEADERS_SKIP_EXAMPLES ON CACHE INTERNAL "Skip SPIRV-Headers examples")
 add_subdirectory(SPIRV-Headers SPIRV-Headers EXCLUDE_FROM_ALL)
@@ -164,6 +168,7 @@ if (UNIX)
 endif()
 add_subdirectory(shaderc shaderc EXCLUDE_FROM_ALL)
 
+
 # libjpeg-turbo
 option(WITH_SIMD "libjpeg-turbo" ON)
 option(WITH_MEM_SRCDST "libjpeg-turbo" ON)
@@ -179,13 +184,15 @@ add_subdirectory(libjpeg-turbo libjpeg-turbo EXCLUDE_FROM_ALL)
 unset(CMAKE_INSTALL_DOCDIR)
 unset(CMAKE_INSTALL_MANDIR)
 
+
 #manipulating libpng cmake options from within cmake script
 set(PNG_BUILD_ZLIB ON CACHE INTERNAL "" FORCE) # get ZLIB from our /3rdparty
 option(PNG_SHARED "Build shared lib" OFF)
 option(PNG_TESTS  "Build libpng tests" OFF)
 add_subdirectory(libpng libpng EXCLUDE_FROM_ALL)
 add_dependencies(png_static zlibstatic)
 
+
 #openexr
 option(_NBL_COMPILE_WITH_OPEN_EXR_ "Build with OpenEXR library" ON)
 if (_NBL_COMPILE_WITH_OPEN_EXR_)
@@ -204,6 +211,7 @@ if (_NBL_COMPILE_WITH_OPEN_EXR_)
 	set(BUILD_TESTING ${_OLD_BUILD_TESTING})
 endif()
 
+
 #gli
 option(_NBL_COMPILE_WITH_GLI_ "Build with GLI library" ON)
 if(_NBL_COMPILE_WITH_GLI_)
@@ -219,8 +227,10 @@ if(_NBL_COMPILE_WITH_GLI_)
 	set(BUILD_TESTING ${_OLD_BUILD_TESTING})
 endif()
 
+
 nbl_adjust_flags()
 
+
 add_library(lzma OBJECT
 	lzma/C/Alloc.c
 	lzma/C/LzFind.c
@@ -229,13 +239,15 @@ add_library(lzma OBJECT
 )
 target_compile_definitions(lzma PRIVATE _7ZIP_ST)
 
+
 add_library(lz4 OBJECT
 	lz4/lib/lz4.c
 	lz4/lib/lz4frame.c
 	lz4/lib/lz4hc.c
 	lz4/lib/xxhash.c
 )
 
+
 add_library(bzip2 OBJECT
 	bzip2/blocksort.c
 	bzip2/bzlib.c
@@ -256,11 +268,13 @@ add_library(spirv_cross OBJECT
 )
 target_compile_definitions(spirv_cross PUBLIC SPIRV_CROSS_EXCEPTIONS_TO_ASSERTIONS)
 
+
 # TODO: remove
 add_library(convert_utf OBJECT
 	convertutf/ConvertUTF.cpp
 )
 
+
 add_library(aesGladman OBJECT
 	aesGladman/aes_ni.c
 	aesGladman/aescrypt.c
@@ -279,6 +293,7 @@ option(GLM_TEST_ENABLE "Build unit tests" OFF)
 set(BUILD_SHARED_LIBS ${_OLD_BUILD_SHARED_LIBS})
 set(BUILD_STATIC_LIBS ${_OLD_BUILD_STATIC_LIBS})
 
+
 if (NBL_BUILD_MITSUBA_LOADER)
 	if(NBL_UPDATE_GIT_SUBMODULE)
 		update_git_submodule(./libexpat)
@@ -304,6 +319,7 @@ if (NBL_BUILD_MITSUBA_LOADER)
    set(MITSUBA_LOADER_DEPENDENT_LIBS ${MITSUBA_LOADER_DEPENDENT_LIBS} PARENT_SCOPE)
 endif()
 
+
 if (NBL_BUILD_BULLET)
 	if(NBL_UPDATE_GIT_SUBMODULE)
 		update_git_submodule(./bullet3)
@@ -322,6 +338,8 @@ if (NBL_COMPILE_WITH_CUDA)
 	endif()
 endif()
 
+
+# Final gather
 set(NBL_3RDPARTY_TARGETS
 				lzma
 				lz4
@@ -376,14 +394,16 @@ endforeach()
 
 set(_NBL_3RDPARTY_TARGETS_ ${NBL_3RDPARTY_TARGETS} PARENT_SCOPE)
 
+
+## REMINDER / NOTE : This is how we install 3rdparty headers we need !
 # parallel hashmap headers
 install(
 	DIRECTORY ./parallel-hashmap/parallel_hashmap 
 	DESTINATION ./include/parallel-hashmap
 	CONFIGURATIONS Release
 )
 install(
-	DIRECTORY ./parallel-hashmap//parallel_hashmap 
+	DIRECTORY ./parallel-hashmap/parallel_hashmap 
 	DESTINATION ./debug/include/parallel-hashmap
 	CONFIGURATIONS Debug
 )

3rdparty/Vulkan-Headers

@@ -1,5 +1,6 @@
 #ifndef _NBL_SYSTEM_C_SYSTEM_ANDROID_H_INCLUDED_
 #define _NBL_SYSTEM_C_SYSTEM_ANDROID_H_INCLUDED_
+
 #ifdef _NBL_PLATFORM_ANDROID_
 #include "nbl/system/ISystem.h"
 #include "nbl/system/CAPKResourcesArchive.h"
@@ -34,4 +35,5 @@ namespace nbl::system
 	};
 }
 #endif
+
 #endif

include/nbl/system/CSystemAndroid.h

@@ -26,7 +26,7 @@ class CSystemWin32 : public ISystem
 {
 public:
     CSystemWin32(core::smart_refctd_ptr<ISystemCaller>&& caller) : ISystem(std::move(caller)) {}
-    //LOL the struct definition wasn't added to winapi headers do they ask to declare them yourself (probably in another header?)
+    //LOL the struct definition wasn't added to winapi headers do they ask to declare them yourself
     typedef struct _PROCESSOR_POWER_INFORMATION {
         ULONG Number;
         ULONG MaxMhz;

include/nbl/system/CSystemWin32.h

@@ -14,51 +14,27 @@ class IPhysicalDevice;
 
 class IAPIConnection : public core::IReferenceCounted
 {
-public:
-    // TODO: are these "instance features" ?
-    enum E_FEATURE
-    {
-        EF_SURFACE = 0,
-        EF_COUNT
-    };
+    public:
+        // TODO: are these "instance features" ?
+        enum E_FEATURE
+        {
+            EF_SURFACE = 0,
+            EF_COUNT
+        };
 
-    virtual E_API_TYPE getAPIType() const = 0;
+        virtual E_API_TYPE getAPIType() const = 0;
 
-    virtual IDebugCallback* getDebugCallback() const = 0;
+        virtual IDebugCallback* getDebugCallback() const = 0;
 
-    core::SRange<IPhysicalDevice* const> getPhysicalDevices() const;
+        core::SRange<IPhysicalDevice* const> getPhysicalDevices() const;
 
-    static core::SRange<const E_FEATURE> getDependentFeatures(const E_FEATURE feature);
+        static core::SRange<const E_FEATURE> getDependentFeatures(const E_FEATURE feature);
 
-protected:
-    // TODO: move to IAPIConnection.cpp
-    inline IAPIConnection() : m_physicalDevices(), m_rdoc_api(nullptr)
-    {
-#ifdef _NBL_PLATFORM_WINDOWS_
-        if (HMODULE mod = GetModuleHandleA("renderdoc.dll"))
-#elif defined(_NBL_PLATFORM_ANDROID_)
-        if (void* mod = dlopen("libVkLayer_GLES_RenderDoc.so", RTLD_NOW | RTLD_NOLOAD))
-#elif defined(_NBL_PLATFORM_LINUX_)
-        if (void* mod = dlopen("librenderdoc.so", RTLD_NOW | RTLD_NOLOAD))
-#else
-        if (false)
-#endif
-        {
-#if defined(_NBL_PLATFORM_WINDOWS_)
-            pRENDERDOC_GetAPI RENDERDOC_GetAPI =
-                (pRENDERDOC_GetAPI)GetProcAddress(mod, "RENDERDOC_GetAPI");
-            int ret = RENDERDOC_GetAPI(MinRenderdocVersion, (void**)&m_rdoc_api);
-            assert(ret == 1);
-#elif defined(_NBL_PLATFORM_ANDROID_) || defined(_NBL_PLATFORM_LINUX_)
-            pRENDERDOC_GetAPI RENDERDOC_GetAPI = (pRENDERDOC_GetAPI)dlsym(mod, "RENDERDOC_GetAPI");
-            int ret = RENDERDOC_GetAPI(MinRenderdocVersion, (void**)&m_rdoc_api);
-            assert(ret == 1);
-#endif
-        }
-    }
+    protected:
+        IAPIConnection();
 
-    std::vector<std::unique_ptr<IPhysicalDevice>> m_physicalDevices;
-    renderdoc_api_t* m_rdoc_api;
+        std::vector<std::unique_ptr<IPhysicalDevice>> m_physicalDevices;
+        renderdoc_api_t* m_rdoc_api;
 };
 
 }

include/nbl/video/IAPIConnection.h

@@ -1,5 +1,5 @@
-#ifndef __NBL_VIDEO_UTILITIES_RENDERDOC_H_INCLUDED_
-#define __NBL_VIDEO_UTILITIES_RENDERDOC_H_INCLUDED_
+#ifndef _NBL_VIDEO_UTILITIES_RENDERDOC_H_INCLUDED_
+#define _NBL_VIDEO_UTILITIES_RENDERDOC_H_INCLUDED_
 
 #include "renderdoc/renderdoc_app.h" // renderdoc_app from /3rdparty
 

include/nbl/video/utilities/renderdoc.h

@@ -384,10 +384,6 @@ set(COMMON_INCLUDE_DIRS
 	$<TARGET_PROPERTY:jpeg-static,BINARY_DIR> #for dynamically generated jconfig.h
 )
 
-macro(nbl_target_link_vulkan _trgt) # we don't want to link against library directly
-	target_include_directories(${_trgt} PUBLIC "$ENV{VULKAN_SDK}/include")
-endmacro()
-
 macro(nbl_target_link_utfcpp _trgt)  # TODO: remove
 	target_include_directories(${_trgt} PUBLIC ${THIRD_PARTY_SOURCE_DIR}/utfcpp/source)
 endmacro()
@@ -536,9 +532,7 @@ set_property(TARGET Nabla PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG
 if(ANDROID AND NOT "${CMAKE_HOST_SYSTEM_NAME}" STREQUAL "Windows") # OpenSSL can't be built for Android platform using windows OS host
 	add_dependencies(Nabla openssl_build)
 endif()
-if(DEFINED ENV{VULKAN_SDK})
-	nbl_target_link_vulkan(Nabla)
-endif()
+target_include_directories(Nabla PUBLIC "${THIRD_PARTY_SOURCE_DIR}/Vulkan-Headers/include")
 nbl_target_link_openssl(Nabla)
 nbl_target_link_zlib(Nabla)
 nbl_target_link_shaderc(Nabla)

src/nbl/CMakeLists.txt

@@ -1,6 +1,7 @@
 #include "nbl/video/IAPIConnection.h"
 
 #include "nbl/video/IPhysicalDevice.h"
+#include "nbl/video/utilities/renderdoc.h"
 
 namespace nbl::video
 {
@@ -28,4 +29,29 @@ core::SRange<const IAPIConnection::E_FEATURE> IAPIConnection::getDependentFeatur
     }
 }
 
+IAPIConnection::IAPIConnection() : m_physicalDevices(), m_rdoc_api(nullptr)
+{
+#ifdef _NBL_PLATFORM_WINDOWS_
+    if (HMODULE mod = GetModuleHandleA("renderdoc.dll"))
+#elif defined(_NBL_PLATFORM_ANDROID_)
+    if (void* mod = dlopen("libVkLayer_GLES_RenderDoc.so", RTLD_NOW | RTLD_NOLOAD))
+#elif defined(_NBL_PLATFORM_LINUX_)
+    if (void* mod = dlopen("librenderdoc.so", RTLD_NOW | RTLD_NOLOAD))
+#else
+#error "Nabla Unsupported Platform!"
+#endif
+    {
+    #if defined(_NBL_PLATFORM_WINDOWS_)
+        pRENDERDOC_GetAPI RENDERDOC_GetAPI =
+            (pRENDERDOC_GetAPI)GetProcAddress(mod, "RENDERDOC_GetAPI");
+        int ret = RENDERDOC_GetAPI(MinRenderdocVersion, (void**)&m_rdoc_api);
+        assert(ret == 1);
+    #elif defined(_NBL_PLATFORM_ANDROID_) || defined(_NBL_PLATFORM_LINUX_)
+        pRENDERDOC_GetAPI RENDERDOC_GetAPI = (pRENDERDOC_GetAPI)dlsym(mod, "RENDERDOC_GetAPI");
+        int ret = RENDERDOC_GetAPI(MinRenderdocVersion, (void**)&m_rdoc_api);
+        assert(ret == 1);
+    #endif
+    }
+}
+
 }