Skip to content

Commit 7133585

Browse files
Updated Vulkan on iOS instructions and Core module
1 parent 363d036 commit 7133585

2 files changed

Lines changed: 5 additions & 11 deletions

File tree

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,9 @@ you will need to set appropriate development team in the project settings.
343343
### Configuring Vulkan Build Environment
344344

345345
To enable Vulkan on iOS, download and install [VulkanSDK](https://vulkan.lunarg.com/sdk/home#mac). There is no Vulkan loader
346-
on iOS, and Diligent Engine links directly with MoltenVK dynamic library that implements Vulkan on Metal.
346+
on iOS, and Diligent Engine links directly with MoltenVK static library (as recommended by
347+
[MoltenVk install guide](https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install-as-static-framework-static-library-or-dynamic-library)
348+
that implements Vulkan on Metal.
347349
Note that iOS simulator does not currently support Metal, and MoltenVK libraries are only available for arm64 architecture.
348350
To enable Vulkan in Diligent Engine on iOS, specify the path to Vulkan SDK when running CMake, for example (assuming
349351
that Vulkan SDK is installed at `/LunarG/vulkansdk-macos`):
@@ -352,18 +354,10 @@ that Vulkan SDK is installed at `/LunarG/vulkansdk-macos`):
352354
cmake -DCMAKE_TOOLCHAIN_FILE=DiligentCore/ios.toolchain.cmake -DIOS_PLATFORM=OS64 -DIOS_ARCH=arm64 -DVULKAN_SDK=/LunarG/vulkansdk-macos -H. -Bbuild/IOS -GXcode
353355
```
354356

355-
Xcode project [cannot be completely configured by CMake](https://github.com/DiligentGraphics/DiligentSamples/issues/9).
356-
For every executable target, the following manual steps have to be performed:
357-
358-
* Open *Build Phases* tab and add a new *Copy Files* phase.
359-
* Select `Executables` in the `Destination` list.
360-
* Drag `MoltenVK/iOS/dynamic/libMoltenVK.dylib` dynamic library from Vulkan SDK into the copy files list.
361-
* Make sure that *Code Sign On Copy* checkbox is marked.
362-
363357
Please refer to [MoltenVK user guide](https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install)
364358
for more details.
365359

366-
By default, the engine will link with dynamic version of MoltenVK library located in LunarG SDK. If this is not desired or an application wants
360+
By default, the engine will link with static version of MoltenVK library located in LunarG SDK. If this is not desired or an application wants
367361
to use a library from a specific location, it can provide the full path to the library via `MoltenVK_LIBRARY` CMake variable. When
368362
`MoltenVK_LIBRARY` is defined, `VULKAN_SDK` is ignored.
369363

0 commit comments

Comments
 (0)