Vulkan renderer backend

[adrian-cojocaru]

Rough implementation of a Vulkan renderer backend (tested on Windows).

Notes:

• Vulkan 1.0
• validation layers are populated from the environment (VulkanSDK, vkconfig, etc)
• Vulkan-Headers C++ bindings with dynamic function loader
• VulkanMemoryAllocator
• runtime shader compilation using glslang
• vsync is forcefully enabled
• requires a valid surface (no offscreen rendering at the moment)
• a common pipeline layout is used for compatibility
• one command buffer submitted per frame

List of working shaders (and associated functionality):

• [x] BackgroundShader
• [x] BackgroundPatternShader
• [x] CircleShader
• [x] ClippingMaskProgram
• [x] CollisionBoxShader
• [x] CollisionCircleShader
• [x] CustomSymbolIconShader
• [x] DebugShader
• [x] FillShader
• [x] FillOutlineShader
• [x] FillPatternShader
• [x] FillOutlinePatternShader
• [x] FillOutlineTriangulatedShader
• [x] FillExtrusionShader
• [x] FillExtrusionPatternShader
• [x] HeatmapShader
• [x] HeatmapTextureShader
• [x] HillshadeShader
• [x] HillshadePrepareShader
• [x] LineShader
• [x] LineGradientShader
• [x] LineSDFShader
• [x] LinePatternShader
• [x] RasterShader
• [x] SymbolIconShader
• [x] SymbolSDFIconShader
• [x] SymbolTextAndIconShader
• [ ] WideVectorShader

[github-actions[bot]]

Bloaty Results (iOS) 🐋

Compared to main

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0% +1.27Ki  [ = ]       0    TOTAL

Full report: https://maplibre-native.s3.eu-central-1.amazonaws.com/bloaty-results-ios/pr-2564-compared-to-main.txt

[github-actions[bot]]

Bloaty Results 🐋

Compared to main

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0% +20.7Ki  +0.0% +3.88Ki    TOTAL

Full report: https://maplibre-native.s3.eu-central-1.amazonaws.com/bloaty-results/pr-2564-compared-to-main.txt

Compared to d38709084a9865fe0bb8300aec70ebf8243b3d43 (legacy)

    FILE SIZE        VM SIZE    
 --------------  -------------- 
   +21% +24.7Mi  +411% +24.6Mi    TOTAL

Full report: https://maplibre-native.s3.eu-central-1.amazonaws.com/bloaty-results/pr-2564-compared-to-legacy.txt

[github-actions[bot]]

Benchmark Results ⚡

Benchmark                                                     Time             CPU      Time Old      Time New       CPU Old       CPU New
------------------------------------------------------------------------------------------------------------------------------------------
OVERALL_GEOMEAN                                            +0.0019         +0.0017             0             0             0             0

Full report: https://maplibre-native.s3.eu-central-1.amazonaws.com/benchmark-results/pr-2564-compared-to-main.txt

[louwers]

As discussed, let's not add any tests to CI yet for the Vulkan backend, but make sure it builds for Linux on CI.

@adrian-cojocaru If you can share some build instructions I am happy to add it to linux-ci.yml.

[adrian-cojocaru]

Windows: cmake -B build -G "Visual Studio 17 2022" DCMAKE_BUILD_TYPE=RelWithDebInfo -DMLN_DRAWABLE_RENDERER=ON -DMLN_LEGACY_RENDERER=OFF -DMLN_WITH_VULKAN=ON -DMLN_WITH_OPENGL=OFF

Linux: cmake -B build -GNinja -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo -DMLN_DRAWABLE_RENDERER=ON -DMLN_LEGACY_RENDERER=OFF -DMLN_WITH_VULKAN=ON -DMLN_WITH_OPENGL=OFF

Tested for mbgl-glfw, mbgl-render and mbgl-render-test-runner

[jwinarske]

Fails to build with clang 10 and gcc 9.4. This is a lowest common denominator build config for us.

Clang 10
CXX=/usr/bin/clang++ CC=/usr/bin/clang cmake .. -GNinja -DMMLN_WITH_X11=OFF -DMLN_WITH_WAYLAND=ON -DCMAKE_CXX_FLAGS=-stdlib=libc++ -DMLN_DRAWABLE_RENDERER=ON -DMLN_LEGACY_RENDERER=OFF -DMLN_WITH_VULKAN=ON -DMLN_WITH_OPENGL=OFF

configure_log.txt build_log.txt

GCC 9.4
cmake .. -GNinja -DMMLN_WITH_X11=OFF -DMLN_WITH_WAYLAND=ON -DMLN_DRAWABLE_RENDERER=ON -DMLN_LEGACY_RENDERER=OFF -DMLN_WITH_VULKAN=ON -DMLN_WITH_OPENGL=OFF

gcc_build_log.txt gcc_configure_log.txt

[louwers]

@jwinarske The same errors show up on the CI build, so they will be addressed.

[jwinarske]

Has anyone ran this with molten-vk? Curious what the Delta with metal is.

[adrian-cojocaru]

@mwilsnd The OOM when allocating descriptor sets is a limitation at the moment. This will be fixed in a future PR with an abstraction layer for descriptors and resizable descriptor pools. This will also fully implement RenderPass::bindVertex / RenderPass::bindFragment functions and their calls. I think I found a similar issue on Android with flickering symbols with long/smooth camera movements. Seems to be sync related

[jwinarske]

I am able to build and run mbgl-glfw built with clang 10 as well as GCC 9.4 with attached patch.

Lots of clang-tidy issues; some are directly related to the compiler errors.

Build flags:

-DMLN_WITH_VULKAN=ON
-DMLN_WITH_X11=OFF
-DMLN_WITH_WAYLAND=OFF
-DMLN_DRAWABLE_RENDERER=ON
-DMLN_LEGACY_RENDERER=OFF
-DMLN_WITH_VULKAN=ON
-DMLN_WITH_OPENGL=OFF
-DMLN_WITH_EGL=OFF

0001-Changes-to-build-GCC-9.4-Clang-10.zip

[louwers]

@jwinarske Could you share your clang-tidy config? Here is ours: https://github.com/maplibre/maplibre-native/blob/main/.clang-tidy

Any chance you could upstream your patch as a PR?

[adrian-cojocaru]

@jwinarske Seems to compile without any issue on clang 10/GCC 9.4. As @louwers suggested the difference is probably in clang-tidy config.