Skip to content

Commit

Permalink
Readme: updated Vulkan SDK version
Browse files Browse the repository at this point in the history
  • Loading branch information
TheMostDiligent committed Aug 8, 2023
1 parent 67cc875 commit a4e8031
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ By default, applications will run in OpenGLES mode. To run them in Vulkan mode,
Prerequisites:

* Xcode 14 or later
* Vulkan SDK 1.3.231.1 or later to enable Vulkan
* Vulkan SDK 1.3.250.1 or later to enable Vulkan

After you clone the repo, run the following command from the engine's root folder to generate Xcode project:

Expand All @@ -347,10 +347,10 @@ or [gfx-portability](https://github.com/gfx-rs/portability). Install [VulkanSDK]
and make sure that your system is properly configured as described
[here](https://vulkan.lunarg.com/doc/view/latest/mac/getting_started.html#user-content-sdk-system-paths).
In particular, you may need to define the following environment variables (assuming that Vulkan SDK is installed at
`/Users/MyName/VulkanSDK/1.3.231.1` and you want to use MoltenVK):
`/Users/MyName/VulkanSDK/1.3.250.1` and you want to use MoltenVK):

```
export VULKAN_SDK=/Users/MyName/VulkanSDK/1.3.231.1/macOS
export VULKAN_SDK=/Users/MyName/VulkanSDK/1.3.250.1/macOS
export PATH=$VULKAN_SDK/bin:$PATH
export DYLD_LIBRARY_PATH=$VULKAN_SDK/lib:$DYLD_LIBRARY_PATH
export VK_ICD_FILENAMES=$VULKAN_SDK/share/vulkan/icd.d/MoltenVK_icd.json
Expand All @@ -374,15 +374,15 @@ System Integrity Protection is disabled (which generally is not recommended). In
Vulkan library, it must be in rpath. If `VULKAN_SDK` environment variable is set and points to correct location, Diligent
Engine will configure the rpath for all applications automatically.

Last tested Vulkan SDK version: 1.3.231.1.
Last tested Vulkan SDK version: 1.3.250.1.

<a name="build_and_run_ios"></a>
## iOS

Prerequisites:

* Xcode 14 or later
* Vulkan SDK 1.3.231.1 or later to enable Vulkan
* Vulkan SDK 1.3.250.1 or later to enable Vulkan

Run the command below from the engine's root folder to generate Xcode project configured for
[iOS build](https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html#cross-compiling-for-ios-tvos-or-watchos):
Expand Down Expand Up @@ -413,10 +413,10 @@ To enable Vulkan on iOS, download and install the [VulkanSDK](https://vulkan.lun
on iOS, and Diligent Engine links directly with MoltenVK XCFramework (see
[MoltenVk install guide](https://github.com/KhronosGroup/MoltenVK/blob/master/Docs/MoltenVK_Runtime_UserGuide.md#install-moltenvk-as-a-universal-xcframework))
that implements Vulkan on Metal. 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 `/Users/MyName/VulkanSDK/1.3.231.1`):
when running CMake, for example (assuming that Vulkan SDK is installed at `/Users/MyName/VulkanSDK/1.3.250.1`):

```cmake
cmake -DCMAKE_SYSTEM_NAME=iOS -DVULKAN_SDK=/Users/MyName/VulkanSDK/1.3.231.1 -S . -B ./build/iOS -G "Xcode"
cmake -DCMAKE_SYSTEM_NAME=iOS -DVULKAN_SDK=/Users/MyName/VulkanSDK/1.3.250.1 -S . -B ./build/iOS -G "Xcode"
```

By default, the engine links with MoltenVK XCFramework located in Vulkan SDK. If this is not desired or an application wants
Expand All @@ -425,7 +425,7 @@ to use a specific library, it can provide the full path to the library via `MOLT
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 Vulkan SDK version: 1.3.231.1.
Last tested Vulkan SDK version: 1.3.250.1.

<a name="build_and_run_emscripten"></a>
## Emscripten
Expand Down

0 comments on commit a4e8031

Please sign in to comment.