First Sketch of a possible Magnum::Vk (Vulkan Target)

CMakeLists.txt

@@ -53,6 +53,7 @@ endif()
 cmake_dependent_option(TARGET_GLES2 "Build for OpenGL ES 2 / WebGL 1.0" ON "TARGET_GLES" OFF)
 cmake_dependent_option(TARGET_DESKTOP_GLES "Build for OpenGL ES on desktop" OFF "TARGET_GLES" OFF)
 option(TARGET_HEADLESS "Build command-line utilities for use on a headless machines" OFF)
+option(TARGET_VULKAN "Build for Vulkan" OFF)
 
 # Magnum Info (currently only using GLX, CGL, WGL/EGL on Windows or on NaCl)
 if(CORRADE_TARGET_UNIX OR CORRADE_TARGET_NACL OR CORRADE_TARGET_WINDOWS)
@@ -211,7 +212,9 @@ endif()
 if(TARGET_HEADLESS)
     set(MAGNUM_TARGET_HEADLESS 1)
 endif()
-
+if(TARGET_VULKAN)
+    set(MAGNUM_TARGET_VULKAN 1)
+endif()
 if(CORRADE_TARGET_EMSCRIPTEN)
     include(UseEmscripten)
 endif()

modules/FindMagnum.cmake

@@ -364,7 +364,7 @@ endif()
 
 # Component distinction (listing them explicitly to avoid mistakes with finding
 # components from other repositories)
-set(_MAGNUM_LIBRARY_COMPONENTS "^(Audio|DebugTools|MeshTools|Primitives|SceneGraph|Shaders|Shapes|Text|TextureTools|AndroidApplication|GlfwApplication|GlutApplication|GlxApplication|NaClApplication|Sdl2Application|XEglApplication|WindowlessCglApplication|WindowlessEglApplication|WindowlessGlxApplication|WindowlessIosApplication|WindowlessNaClApplication|WindowlessWglApplication|WindowlessWindowsEglApplication|CglContext|EglContext|GlxContext|WglContext)$")
+set(_MAGNUM_LIBRARY_COMPONENTS "^(Audio|DebugTools|MeshTools|Primitives|SceneGraph|Shaders|Shapes|Text|TextureTools|Vk|AndroidApplication|GlfwApplication|GlutApplication|GlxApplication|NaClApplication|Sdl2Application|XEglApplication|WindowlessCglApplication|WindowlessEglApplication|WindowlessGlxApplication|WindowlessIosApplication|WindowlessNaClApplication|WindowlessWglApplication|WindowlessWindowsEglApplication|CglContext|EglContext|GlxContext|WglContext)$")
 set(_MAGNUM_PLUGIN_COMPONENTS "^(MagnumFont|MagnumFontConverter|ObjImporter|TgaImageConverter|TgaImporter|WavAudioImporter)$")
 set(_MAGNUM_EXECUTABLE_COMPONENTS "^(distancefieldconverter|fontconverter|imageconverter|info|al-info)$")
 
@@ -563,7 +563,7 @@ foreach(_component ${Magnum_FIND_COMPONENTS})
         # Context libraries
         elseif(_component MATCHES ".+Context")
             set(_MAGNUM_${_COMPONENT}_INCLUDE_PATH_SUFFIX Magnum/Platform)
-            set(_MAGNUM_${_COMPONENT}_INCLUDE_PATH_NAMES Context.h)
+            set(_MAGNUM_${_COMPONENT}_INCLUDE_PATH_NAMES Instance.h)
 
             # GLX context dependencies
             if(_component STREQUAL GlxContext)
@@ -609,6 +609,14 @@ foreach(_component ${Magnum_FIND_COMPONENTS})
         # TextureTools library
         elseif(_component STREQUAL TextureTools)
             set(_MAGNUM_${_COMPONENT}_INCLUDE_PATH_NAMES Atlas.h)
+
+        elseif(_component STREQUAL Vk)
+            find_package(Vulkan)
+            set_property(TARGET Magnum::${_component} APPEND PROPERTY
+                    INTERFACE_LINK_LIBRARIES Vulkan::Vulkan)
+            set_target_properties(Magnum::${_component} PROPERTIES
+                    INTERFACE_CORRADE_CXX_STANDARD 14)
+            set(_MAGNUM_${_COMPONENT}_INCLUDE_PATH_NAMES Context.h)
         endif()
 
         # Find library/plugin includes

modules/FindVulkan.cmake

@@ -0,0 +1,83 @@
+#.rst:
+# Find Vulkan
+# ---------
+#
+# Finds the Vulkan library. This module defines:
+#
+#  VULKAN_FOUND               - True if VULKAN library is found
+#  VULKAN::VULKAN             - VULKAN imported target
+#
+# Additionally these variables are defined for internal usage:
+#
+#  VULKAN_LIBRARY             - VULKAN library
+#  VULKAN_INCLUDE_DIR         - Root include dir
+#
+
+#
+#   This file is part of Magnum.
+#
+#   Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016
+#             Vladimír Vondruš <mosra@centrum.cz>
+#   Copyright © 2016 Jonathan Hale <squareys@googlemail.com>
+#
+#   Permission is hereby granted, free of charge, to any person obtaining a
+#   copy of this software and associated documentation files (the "Software"),
+#   to deal in the Software without restriction, including without limitation
+#   the rights to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell copies of the Software, and to permit persons to whom the
+#   Software is furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included
+#   in all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+#   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#
+
+if (WIN32)
+    find_path(VULKAN_INCLUDE_DIR NAMES vulkan.h HINTS
+        "$ENV{VULKAN_SDK}/Include"
+        "$ENV{VK_SDK_PATH}/Include"
+        PATH_SUFFIXES vulkan)
+    if (CMAKE_CL_64)
+        find_library(VULKAN_LIBRARY NAMES vulkan-1 HINTS
+            "$ENV{VULKAN_SDK}/Bin"
+            "$ENV{VK_SDK_PATH}/Bin")
+    else()
+        find_library(VULKAN_LIBRARY NAMES vulkan-1 HINTS
+            "$ENV{VULKAN_SDK}/Bin32"
+            "$ENV{VK_SDK_PATH}/Bin32")
+    endif()
+else()
+    find_path(VULKAN_INCLUDE_DIR NAMES vulkan.h HINTS
+        "$ENV{VULKAN_SDK}/Include" PATH_SUFFIXES vulkan)
+    find_library(VULKAN_LIBRARY NAMES vulkan HINTS
+        "$ENV{VULKAN_SDK}/Bin")
+endif()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args("VULKAN" DEFAULT_MSG
+    VULKAN_LIBRARY
+    VULKAN_INCLUDE_DIR)
+
+if(NOT TARGET Vulkan::Vulkan)
+    add_library(Vulkan::Vulkan UNKNOWN IMPORTED)
+
+    # Work around BUGGY framework support on OSX
+    # https://cmake.org/Bug/view.php?id=14105
+    if(CORRADE_TARGET_APPLE AND ${VULKAN_LIBRARY} MATCHES "\\.framework$")
+        set_property(TARGET Vulkan::Vulkan PROPERTY IMPORTED_LOCATION ${VULKAN_LIBRARY}/VULKAN)
+    else()
+        set_property(TARGET Vulkan::Vulkan PROPERTY IMPORTED_LOCATION ${VULKAN_LIBRARY})
+    endif()
+
+    set_property(TARGET Vulkan::Vulkan PROPERTY
+        INTERFACE_INCLUDE_DIRECTORIES ${VULKAN_INCLUDE_DIR})
+endif()
+
+

src/Magnum/CMakeLists.txt

@@ -323,6 +323,11 @@ if(WITH_TEXTURETOOLS)
     add_subdirectory(TextureTools)
 endif()
 
+# Vulkan stuff
+if(TARGET_VULKAN)
+    add_subdirectory(Vk)
+endif()
+
 if(BUILD_TESTS)
     # Library with graceful assert for testing
     add_library(MagnumMathTestLib ${SHARED_OR_STATIC}

src/Magnum/Context.cpp

@@ -468,7 +468,10 @@ Context::Context(Context&& other): _version{std::move(other._version)},
 }
 
 Context::~Context() {
-    delete _state;
+    if(_version != Version::None) {
+        /* Context was not created */
+        delete _state;
+    }
 
     if(currentContext == this) currentContext = nullptr;
 }

src/Magnum/Platform/CMakeLists.txt

@@ -106,6 +106,13 @@ if(WITH_GLFWAPPLICATION)
         message(FATAL_ERROR "GLFW library, required by GlfwApplication, was not found. Set WITH_GLFWAPPLICATION to OFF to skip building it.")
     endif()
 
+    if(TARGET_VULKAN)
+        find_package(Vulkan)
+        if(NOT GLFW_FOUND)
+            message(FATAL_ERROR "Vulakn SDK was not found. Set TARGET_VULKAN to OFF to turn off Vulkan support.")
+        endif()
+    endif()
+
     set(MagnumGlfwApplication_SRCS
         GlfwApplication.cpp
         ${MagnumSomeContext_OBJECTS})
@@ -119,6 +126,10 @@ if(WITH_GLFWAPPLICATION)
     # linked to the executable and not to any intermediate shared lib
     target_link_libraries(MagnumGlfwApplication Magnum GLFW::GLFW)
 
+    if(TARGET_VULKAN)
+        target_link_libraries(MagnumGlfwApplication Magnum Vulkan::Vulkan)
+    endif()
+
     install(FILES ${MagnumGlfwApplication_HEADERS} DESTINATION ${MAGNUM_INCLUDE_INSTALL_DIR}/Platform)
     install(TARGETS MagnumGlfwApplication
         RUNTIME DESTINATION ${MAGNUM_BINARY_INSTALL_DIR}

src/Magnum/Platform/GlfwApplication.cpp

@@ -33,6 +33,10 @@
 #include "Magnum/Platform/Context.h"
 #include "Magnum/Platform/ScreenedApplication.hpp"
 
+#ifdef MAGNUM_TARGET_VULKAN
+#include "Magnum/Vk/Instance.h"
+#endif
+
 namespace Magnum { namespace Platform {
 
 GlfwApplication* GlfwApplication::_instance = nullptr;
@@ -90,6 +94,7 @@ bool GlfwApplication::tryCreateContext(const Configuration& configuration) {
         glfwWindowHint(GLFW_ICONIFIED, flags >= Configuration::WindowFlag::Minimized);
         glfwWindowHint(GLFW_FLOATING, flags >= Configuration::WindowFlag::Floating);
     }
+
     glfwWindowHint(GLFW_FOCUSED, configuration.windowFlags() >= Configuration::WindowFlag::Focused);
 
     /* Context window hints */
@@ -120,7 +125,10 @@ bool GlfwApplication::tryCreateContext(const Configuration& configuration) {
         #else
         glfwWindowHint(GLFW_CLIENT_API, GLFW_OPENGL_ES_API);
         #endif
+    } else {
+        glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
     }
+    glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
 
     /* Set context flags */
     _window = glfwCreateWindow(configuration.size().x(), configuration.size().y(), configuration.title().c_str(), monitor, nullptr);
@@ -140,7 +148,15 @@ bool GlfwApplication::tryCreateContext(const Configuration& configuration) {
     glfwMakeContextCurrent(_window);
 
     /* Return true if the initialization succeeds */
-    return _context->tryCreate();
+<<<<<<< HEAD
+    if(configuration.version() != Version::None) {
+        return _context->tryCreate();
+    } else {
+        return true;
+    }
+=======
+    return true; //_context->tryCreate();
+>>>>>>> WIP/TEMP
 }
 
 GlfwApplication::~GlfwApplication() {
@@ -237,6 +253,19 @@ void GlfwApplication::mouseReleaseEvent(MouseEvent&) {}
 void GlfwApplication::mouseMoveEvent(MouseMoveEvent&) {}
 void GlfwApplication::mouseScrollEvent(MouseScrollEvent&) {}
 
+#ifdef MAGNUM_TARGET_VULKAN
+VkSurfaceKHR GlfwApplication::createVkSurface() {
+    VkSurfaceKHR surface;
+
+    VkResult res = glfwCreateWindowSurface(Magnum::Vk::Instance::current(), _window, nullptr, &surface);
+    if(res != VK_SUCCESS) {
+        Error() << "Vulkan Surface creation failed.";
+    }
+
+    return surface;
+}
+#endif
+
 GlfwApplication::Configuration::Configuration():
     _title{"Magnum GLFW Application"},
     _size{800, 600}, _sampleCount{0},

src/Magnum/Platform/GlfwApplication.h

@@ -40,7 +40,13 @@
 /* We must include our own GL headers first to avoid conflicts */
 #include "Magnum/OpenGL.h"
 
+#ifdef MAGNUM_TARGET_VULKAN
+#include "vulkan.h"
+#endif
+
 #include <glfw3.h>
+#define GLFW_EXPOSE_NATIVE_WIN32
+#include <glfw3native.h>
 
 namespace Magnum { namespace Platform {
 
@@ -216,6 +222,15 @@ class GlfwApplication {
             glfwSetCursorPos(_window, Double(position.x()), Double(position.y()));
         }
 
+
+        #ifdef MAGNUM_TARGET_VULKAN
+        VkSurfaceKHR createVkSurface();
+
+        HWND getPlatformWindow() {
+            return glfwGetWin32Window(_window);
+        }
+        #endif
+
     #ifdef DOXYGEN_GENERATING_OUTPUT
     protected:
     #else

src/Magnum/Test/ContextTest.cpp

@@ -3,6 +3,7 @@
 
     Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016
               Vladimír Vondruš <mosra@centrum.cz>
+    Copyright © 2016 Jonathan Hale <squareys@googlemail.com>
 
     Permission is hereby granted, free of charge, to any person obtaining a
     copy of this software and associated documentation files (the "Software"),
@@ -33,21 +34,26 @@ namespace Magnum { namespace Test {
 struct ContextTest: TestSuite::Tester {
     explicit ContextTest();
 
-    void debugFlag();
+    void createAndDestroy();
+    void flag();
+    void result();
 };
 
 ContextTest::ContextTest() {
-    addTests({&ContextTest::debugFlag});
+    addTests({&ContextTest::createAndDestroy,
+              &ContextTest::flag,
+              &ContextTest::result});
 }
 
-void ContextTest::debugFlag() {
-    #ifdef MAGNUM_TARGET_WEBGL
-    CORRADE_SKIP("No context flags on Emscripten yet.");
-    #else
+void ContextTest::createAndDestroy() {
+    Vk::Context c{{}};
+    CORRADE_COMPARE(c.version(), Vk::Version::Vulkan_1_0);
+}
+
+void ContextTest::flag() {
     std::ostringstream out;
     Debug(&out) << Context::Flag::Debug << Context::Flag(0xdead);
     CORRADE_COMPARE(out.str(), "Context::Flag::Debug Context::Flag(0xdead)\n");
-    #endif
 }
 
 }}