Skip to content

Commit

Permalink
Revert IDE Release config logic and adjust docs; remove MoltenVK proj…
Browse files Browse the repository at this point in the history
…ect option from docs
  • Loading branch information
SRSaunders committed Sep 25, 2024
1 parent fa92f8e commit 5e0c3e7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 24 deletions.
5 changes: 0 additions & 5 deletions app/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,6 @@ endif()

target_link_libraries(${PROJECT_NAME} PRIVATE vkb__core vkb__filesystem apps plugins)

# Force multi-config generators (VS, Xcode, Ninja Multi-Config) to build for the Release config when cmake build type is Release
if(${CMAKE_BUILD_TYPE} STREQUAL "Release")
set(CMAKE_CONFIGURATION_TYPES "Release;RelWithDebInfo" CACHE STRING "Release build types for multi-config generators" FORCE)
endif()

# Create android project
if(ANDROID)
if(CMAKE_VS_NsightTegra_VERSION)
Expand Down
22 changes: 3 additions & 19 deletions docs/build.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ ____
`Step 1.` The following command will generate the VS project

----
cmake -G "Visual Studio 15 2017 Win64" -S . -Bbuild/windows -DCMAKE_BUILD_TYPE=Release
cmake -G "Visual Studio 15 2017 Win64" -S . -Bbuild/windows
----

(Prior to CMake v3.13)
Expand All @@ -190,14 +190,14 @@ cmake -G "Visual Studio 15 2017 Win64" . -Bbuild/windows
Visual Studio 2019 must be installed)

----
cmake -G "Visual Studio 16 2019" -A x64 -S . -Bbuild/windows -DCMAKE_BUILD_TYPE=Release
cmake -G "Visual Studio 16 2019" -A x64 -S . -Bbuild/windows
----

(New in CMake v3.21.
Visual Studio 2022 must be installed)

----
cmake -G "Visual Studio 17 2022" -A x64 -S . -Bbuild/windows -DCMAKE_BUILD_TYPE=Release
cmake -G "Visual Studio 17 2022" -A x64 -S . -Bbuild/windows
----

Open the *vulkan_samples.sln* VS project inside build/windows and build with Ctrl-Shift-B. To run Vulkan Samples, use Visual Studio's Debug Properties selection and set the Debugging Command Arguments to --help. Click the "Local Windows Debugger" button and you should see the help output in the terminal. For convenience, the default setting is to run the hello_triangle sample; just edit that to your desired sample to run.
Expand Down Expand Up @@ -266,14 +266,6 @@ cmake --build build/linux --config Release --target vulkan_samples -j$(nproc)
source /PATH/TO/VULKAN/SDK/setup-env.sh
----

Alternatively, to use MoltenVK built locally from its github project

----
export VULKAN_SDK=/PATH/TO/MoltenVK/Package/Release/MoltenVK
----

Then generate the project as shown below, adding the additional cmake option `-DUSE_MoltenVK=ON`. Note when using this feature the Vulkan SDK should first be installed with the _System Global Installation_ option selected. This will ensure that *dxc* is available for HLSL shader compilation even though `VULKAN_SDK` points to the MoltenVK project.

=== Build with CMake and Xcode

`Step 1.` The following command will generate the project
Expand Down Expand Up @@ -321,14 +313,6 @@ NB: For iOS you must run the setup-env.sh located inside the Vulkan SDK's iOS di
source /PATH/TO/VULKAN/SDK/iOS/setup-env.sh
----

Alternatively, to use MoltenVK built locally from its github project

----
export VULKAN_SDK=/PATH/TO/MoltenVK/Package/Release/MoltenVK
----

Then generate the project as shown below, adding the additional cmake option `-DUSE_MoltenVK=ON`. Note when using this feature the Vulkan SDK should first be installed with the _System Global Installation_ option selected. This will ensure that *dxc* is available for HLSL shader compilation even though `VULKAN_SDK` points to the MoltenVK project.

=== Build with CMake and Xcode

`Step 1.` The following command will generate the project
Expand Down

0 comments on commit 5e0c3e7

Please sign in to comment.