Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheMostDiligent authored Apr 28, 2020
1 parent 81a0012 commit e2b0c40
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,23 +344,22 @@ you will need to set appropriate development team in the project settings.

To enable Vulkan on iOS, download and install [VulkanSDK](https://vulkan.lunarg.com/sdk/home#mac). There is no Vulkan loader
on iOS, and Diligent Engine links directly with MoltenVK static library (as recommended by
[MoltenVk install guide](https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install-as-static-framework-static-library-or-dynamic-library)
that implements Vulkan on Metal.
Note that iOS simulator does not currently support Metal, and MoltenVK libraries are only available for arm64 architecture.
[MoltenVk install guide](https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install-as-static-framework-static-library-or-dynamic-library))
that implements Vulkan on Metal. Note that MoltenVK libraries are only provided for arm64 architecture.
To enable Vulkan in Diligent Engine on iOS, specify the path to Vulkan SDK when running CMake, for example (assuming
that Vulkan SDK is installed at `/LunarG/vulkansdk-macos`):

```cmake
cmake -DCMAKE_TOOLCHAIN_FILE=DiligentCore/ios.toolchain.cmake -DIOS_PLATFORM=OS64 -DIOS_ARCH=arm64 -DVULKAN_SDK=/LunarG/vulkansdk-macos -H. -Bbuild/IOS -GXcode
```

Please refer to [MoltenVK user guide](https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install)
for more details.

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
to use a library from a specific location, it can provide the full path to the library via `MoltenVK_LIBRARY` CMake variable. When
`MoltenVK_LIBRARY` is defined, `VULKAN_SDK` is ignored.

Refer to [MoltenVK user guide](https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install)
for more information about MoltenVK installation and usage.

Last tested LunarG SDK version: 1.2.135.0.

<a name="build_and_run_integration"></a>
Expand Down

0 comments on commit e2b0c40

Please sign in to comment.