From a4e03562118ba2b146edefe3af176479110ca3ef Mon Sep 17 00:00:00 2001 From: assiduous Date: Sat, 2 Apr 2022 12:58:24 -0700 Subject: [PATCH] Updated submodules (readme updates) --- .vscode/launch.json | 38 ++++++++++++++++++++++++++++++++++++++ DiligentCore | 2 +- DiligentFX | 2 +- DiligentSamples | 2 +- DiligentTools | 2 +- README.md | 21 ++++++++++----------- 6 files changed, 52 insertions(+), 15 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 92adb3fb7..fab020264 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -574,6 +574,44 @@ } ] }, + { + "name": "Tutorial23_CommandQueues", + "type": "cppdbg", + "request": "launch", + "program": "${workspaceFolder}/build/DiligentSamples/Tutorials/Tutorial23_CommandQueues/Tutorial23_CommandQueues", + "args": ["-mode vk"], + "stopAtEntry": false, + "cwd": "${workspaceFolder}/DiligentSamples/Tutorials/Tutorial23_CommandQueues/assets", + "environment": [], + "externalConsole": true, + "MIMode": "gdb", + "setupCommands": [ + { + "description": "Enable pretty-printing for gdb", + "text": "-enable-pretty-printing", + "ignoreFailures": true + } + ] + }, + { + "name": "Tutorial24_VRS", + "type": "cppdbg", + "request": "launch", + "program": "${workspaceFolder}/build/DiligentSamples/Tutorials/Tutorial24_VRS/Tutorial24_VRS", + "args": ["-mode vk"], + "stopAtEntry": false, + "cwd": "${workspaceFolder}/DiligentSamples/Tutorials/Tutorial24_VRS/assets", + "environment": [], + "externalConsole": true, + "MIMode": "gdb", + "setupCommands": [ + { + "description": "Enable pretty-printing for gdb", + "text": "-enable-pretty-printing", + "ignoreFailures": true + } + ] + }, { "name": "DiligentCoreTest", "type": "cppdbg", diff --git a/DiligentCore b/DiligentCore index 6633a5196..2d40f591f 160000 --- a/DiligentCore +++ b/DiligentCore @@ -1 +1 @@ -Subproject commit 6633a5196fda5a86486e2beaadee173864e77aba +Subproject commit 2d40f591f7c7283baa1d3463d29e90bc9102ffcc diff --git a/DiligentFX b/DiligentFX index 19630e31d..0d1d80191 160000 --- a/DiligentFX +++ b/DiligentFX @@ -1 +1 @@ -Subproject commit 19630e31d40eab2183f15e7925978af46754d31b +Subproject commit 0d1d801912d52690f1826802d69ad593b244bf73 diff --git a/DiligentSamples b/DiligentSamples index d75f14d61..76a3aac8b 160000 --- a/DiligentSamples +++ b/DiligentSamples @@ -1 +1 @@ -Subproject commit d75f14d614aba58802d8d4b9e6587496c793513f +Subproject commit 76a3aac8bdf15258bd5288f70ad830c760ef2b08 diff --git a/DiligentTools b/DiligentTools index 019b36391..6b6875589 160000 --- a/DiligentTools +++ b/DiligentTools @@ -1 +1 @@ -Subproject commit 019b36391bdd506ba804f9e9ddc5cac86f857480 +Subproject commit 6b68755892bea854eb68849c7031e971083ee8ea diff --git a/README.md b/README.md index 553cb9711..7e74ad371 100644 --- a/README.md +++ b/README.md @@ -135,8 +135,10 @@ Master repository includes the following submodules: * [Tools](https://github.com/DiligentGraphics/DiligentTools) submodule contains [texture loading library](https://github.com/DiligentGraphics/DiligentTools/tree/master/TextureLoader), [asset loading library](https://github.com/DiligentGraphics/DiligentTools/blob/master/AssetLoader), - [dear imgui implementation](https://github.com/DiligentGraphics/DiligentTools/blob/master/Imgui), and - [native application implementation](https://github.com/DiligentGraphics/DiligentTools/blob/master/NativeApp). + [dear imgui implementation](https://github.com/DiligentGraphics/DiligentTools/blob/master/Imgui), + [native application implementation](https://github.com/DiligentGraphics/DiligentTools/blob/master/NativeApp), + [Diligent render state notation parser](https://github.com/DiligentGraphics/DiligentTools/tree/master/RenderStateNotation) and + [offline render state packaging tool](https://github.com/DiligentGraphics/DiligentTools/tree/master/RenderStatePackager). * [DiligentFX](https://github.com/DiligentGraphics/DiligentFX) is a high-level rendering framework that implements various rendering components. The module depends on Core and Tools modules. * [Samples](https://github.com/DiligentGraphics/DiligentSamples) submodule contains tutorials and sample applications @@ -182,7 +184,7 @@ cmake -S . -B ./build/MinGW -D CMAKE_BUILD_TYPE=Release -G "MinGW Makefiles" :warning: In current implementation, full path to cmake build folder **must not contain white spaces**. -To enable Vulkan validation layers, you will need to download [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) and add environemt +To enable Vulkan validation layers, you will need to download the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) and add environemt variable `VK_LAYER_PATH` that contains the path to the *Bin* directory in VulkanSDK installation folder. Open *DiligentEngine.sln* file in *build/Win64* folder, select configuration and build the engine. Set the desired project @@ -273,13 +275,13 @@ To configure Vulkan you will also need to: To generate make files for debug configuration, run the following CMake command from the engine's root folder: ``` -cmake -S . -B ./build/Linux64 -G "Unix Makefiles" -DCMAKE_BUILD_TYPE="Debug" +cmake -S . -B ./build -G "Unix Makefiles" -DCMAKE_BUILD_TYPE="Debug" ``` To build the engine, run the following command: ``` -cmake --build ./build/Linux64 +cmake --build ./build ``` The engine's root folder contains [Visual Studio Code](https://code.visualstudio.com/) settings files that configure @@ -314,8 +316,7 @@ By default, applications will run in OpenGLES mode. To run them in Vulkan mode, ## MacOS -After you clone the repo, run the following command from the engine's root folder to generate Xcode project -(you need to have [CMake](https://cmake.org/) installed on the system): +After you clone the repo, run the following command from the engine's root folder to generate Xcode project: ``` cmake -S . -B ./build/MacOS -G "Xcode" @@ -387,7 +388,7 @@ you will need to set appropriate development team in the project settings. ### Configuring Vulkan Build Environment -To enable Vulkan on iOS, download and install [VulkanSDK](https://vulkan.lunarg.com/sdk/home#mac). There is no Vulkan loader +To enable Vulkan on iOS, download and install the [VulkanSDK](https://vulkan.lunarg.com/sdk/home#mac). There is no Vulkan loader 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 @@ -546,8 +547,6 @@ For example, for Windows platform, the list of libraries your project will need DiligentCore.lib glslang.lib HLSL.lib OGLCompiler.lib OSDependent.lib spirv-cross-core.lib SPIRV.lib SPIRV-Tools-opt.lib SPIRV-Tools.lib glew-static.lib GenericCodeGen.lib MachineIndependent.lib dxgi.lib d3d11.lib d3d12.lib d3dcompiler.lib opengl32.lib ``` -Vulkan libraries can be found in [DiligentCore/ThirdParty/vulkan/libs](https://github.com/DiligentGraphics/DiligentCore/tree/master/ThirdParty/vulkan/libs) directory. - Diligent Engine headers require one of the following platform macros to be defined as `1`: `PLATFORM_WIN32`, `PLATFORM_UNIVERSAL_WINDOWS`, `PLATFORM_ANDROID`, `PLATFORM_LINUX`, `PLATFORM_MACOS`, `PLATFORM_IOS`. @@ -929,7 +928,7 @@ In submitting any content to this repository, and you agree that the content is free of any Intellectual Property claims and you have the right to license it under those terms. Diligent Engine uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to ensure -consistent source code style throughout the code base. The format is validated by appveyor and travis +consistent source code style throughout the code base. The format is validated by CI for each commit and pull request, and the build will fail if any code formatting issue is found. Please refer to [this page](https://github.com/DiligentGraphics/DiligentCore/blob/master/doc/code_formatting.md) for instructions on how to set up clang-format and automatic code formatting.