GPUOpen-LibrariesAndSDKs · Zakhrov · Jul 24, 2019 · Jul 24, 2019 · Jul 24, 2019 · Jul 28, 2019
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,8 @@
 cmake_minimum_required(VERSION 3.4)
+
+if(MSVC)
 set(CMAKE_GENERATOR_PLATFORM x64)
+endif()
 
 project (Framework_${GFX_API})
 
@@ -11,18 +14,18 @@ foreach( OUTPUTCONFIG ${CMAKE_CONFIGURATION_TYPES} )
 endforeach( OUTPUTCONFIG CMAKE_CONFIGURATION_TYPES )
 
 # reference libs used by both backends
-add_subdirectory(src/Common)
+add_subdirectory(src/common)
 add_subdirectory(libs/json)
-add_subdirectory(libs/ImGUI)
+add_subdirectory(libs/imgui)
 
-if(GFX_API STREQUAL DX12)        
+if(GFX_API STREQUAL DX12)
     add_subdirectory(libs/d3d12x)
-    add_subdirectory(libs/ags)    
+    add_subdirectory(libs/ags)
     add_subdirectory(libs/dxc)
-    add_subdirectory(src/DX12)   
+    add_subdirectory(src/DX12)
 elseif(GFX_API STREQUAL VK)
     find_package(Vulkan REQUIRED)
-    add_subdirectory(libs/VulkanMemoryAllocator)    
+    add_subdirectory(libs/VulkanMemoryAllocator)
     add_subdirectory(src/VK)
 else()
     message(STATUS "----------------------------------------------------------------------------------------")
@@ -38,4 +41,3 @@ else()
     message(STATUS "----------------------------------------------------------------------------------------")
     message(FATAL_ERROR "")
 endif()
-
diff --git a/build/GenerateSolutions.bat b/build/GenerateSolutions.bat
diff --git a/readme.md b/readme.md
@@ -16,8 +16,8 @@ Cauldron is compiled as a static library, hence the sample application has to st
 - [glTF 2.0](https://github.com/KhronosGroup/glTF/tree/master/specification/2.0) File loader
   - Animation for cameras, objects, skeletons and lights
   - Skinning
-  - PBR Materials 
-    - Metallic-Roughness 
+  - PBR Materials
+    - Metallic-Roughness
     - Specular-Glossiness (KHR_materials_pbrSpecularGlossiness)
   - Lighting (KHR_lights_punctual extension)
     - Spot Lights w/ Shadows (up to 4)
@@ -39,7 +39,7 @@ Cauldron is compiled as a static library, hence the sample application has to st
   - Light Frustums
 - Window management & swapchain creation
   - Fullscreen/Windowed Modes
-- Support for DXC/SM6.x 
+- Support for DXC/SM6.x
 - Shader Binary & PSO caching
 
 # Directory Structure
@@ -49,7 +49,7 @@ Cauldron is compiled as a static library, hence the sample application has to st
   - `AGS` : AMD helper library for querying GPU info
   - `VulkanMemoryAllocator` : Helper library for memory management with Vulkan applications
   - `d3d12x` : The D3D12 helper library
-  - `dxc` : DirectX Shader Compiler 
+  - `dxc` : DirectX Shader Compiler
   - `imgui` : Graphical User Interface library
   - `json` : Library for adding JSON support w/ C++ syntax
 - `media` : Builtin textures and other data
@@ -62,20 +62,30 @@ Note: more info on the rendering backends can be found in the Readme of their re
 
 # Build
 
-## Prerequisites
+## Windows Prerequisites
 
 - [CMake 3.4](https://cmake.org/download/)
 - [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/)
 - [Windows 10 SDK 10.0.17763.0](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk)
 - [Vulkan SDK 1.1.106](https://www.lunarg.com/vulkan-sdk/)
 
+## Linux Prerequisites
+
+- [CMake 3.4](https://cmake.org/download/)
+- [GLM](https://glm.g-truc.net/0.9.9/index.html)
+- [GCC 8.0 or higher](https://gcc.gnu.org/)
+- [Vulkan SDK 1.1.106](https://www.lunarg.com/vulkan-sdk/)
+
+
 ## How-to-Build
 
+- Linux (Vulkan Only) run `cmake .. -DGFX_API=VK ` in the `build` directory
 - Run the `GenerateSolutions.bat` file in the `build` directory.
 - `build/VK` and `build/DX12` folders will contain the `Framework_*.sln` files
 - Simply build the solution file for the desired API
 - `build/DX12/src/DX12/` directory will contain the compiled static library `Framework_DX12.lib` for DX12 (similar for VK) under the selected configuration (Debug/Release) folder.
 
+
 # Framework Architecture
 
 Every feature in Cauldron has been implemented in a single file using C++11.
@@ -108,7 +118,7 @@ Cauldron was originally written using DX12 and later on ported to Vulkan using t
 
 # Known Issues
 
-Please bear in mind that in order to keep Cauldron simple we are only covering the most frequently used features (for now). 
+Please bear in mind that in order to keep Cauldron simple we are only covering the most frequently used features (for now).
 
 Please feel free to [open an issue](TODO:LinkToGitHubRepoIssuesPage) for bug reports.
 

diff --git a/src/DX12/CMakeLists.txt b/src/DX12/CMakeLists.txt
@@ -1,6 +1,6 @@
 project (Framework_DX12)
 
-add_compile_options(/MP)
+add_compile_options(-M)
 
 set(GLTF_src
     GLTF/GltfBBoxPass.cpp
@@ -91,10 +91,10 @@ set(Shaders_src
 
 set(media_src
     ${CMAKE_CURRENT_SOURCE_DIR}/../../media/brdfLut.dds
-)    
+)
 
 function(copyCommand list dest)
-	foreach(fullFileName ${list})    
+	foreach(fullFileName ${list})
 		get_filename_component(file ${fullFileName} NAME)
 		message("Generating custom command for ${fullFileName}")
 		add_custom_command(
@@ -103,9 +103,9 @@ function(copyCommand list dest)
 			COMMAND cmake -E make_directory ${dest}
 			COMMAND cmake -E copy ${fullFileName}  ${dest}
 			MAIN_DEPENDENCY  ${fullFileName}
-			COMMENT "Updating ${file} into ${dest}" 
+			COMMENT "Updating ${file} into ${dest}"
 		)
-	endforeach()    
+	endforeach()
 endfunction()
 
 copyCommand("${media_src}" ${CMAKE_HOME_DIRECTORY}/bin)
@@ -125,5 +125,3 @@ source_group("media"           FILES ${media_src})
 
 set_source_files_properties(${Shaders_src} PROPERTIES VS_TOOL_OVERRIDE "Text")
 set_source_files_properties(${media_src} PROPERTIES VS_TOOL_OVERRIDE "Media")
-
-
diff --git a/src/VK/CMakeLists.txt b/src/VK/CMakeLists.txt
@@ -1,6 +1,10 @@
 project (Framework_VK)
 
-add_compile_options(/MP)
+if(MSVC)
+  add_compile_options(/MP)
+else()
+add_compile_options(-M)
+endif()
 
 set(GLTF_src
     GLTF/GltfBBoxPass.cpp
@@ -37,8 +41,8 @@ set(Base_src
     base/CommandListRing.h
     base/DebugMarkersExt.cpp
     base/DebugMarkersExt.h
-    base/ValidationExt.cpp
-    base/ValidationExt.h
+    base/validationExt.cpp
+    base/validationExt.h
     base/Device.cpp
     base/Device.h
     base/DeviceProperties.cpp
@@ -102,11 +106,11 @@ set(Shaders_src
     )
 
 set(media_src
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../media/brdfLut.dds
-)    
+    ${CMAKE_CURRENT_SOURCE_DIR}/../../media/BrdfLut.dds
+)
 
 function(copyCommand list dest)
-    foreach(fullFileName ${list})    
+    foreach(fullFileName ${list})
         get_filename_component(file ${fullFileName} NAME)
         message("Generating custom command for ${fullFileName}")
         add_custom_command(
@@ -115,9 +119,9 @@ function(copyCommand list dest)
             COMMAND cmake -E make_directory ${dest}
             COMMAND cmake -E copy ${fullFileName}  ${dest}
             MAIN_DEPENDENCY  ${fullFileName}
-            COMMENT "Updating ${file} into ${dest}" 
+            COMMENT "Updating ${file} into ${dest}"
         )
-    endforeach()    
+    endforeach()
 endfunction()
 
 copyCommand("${media_src}" ${CMAKE_HOME_DIRECTORY}/bin)
@@ -137,4 +141,3 @@ source_group("media"           FILES ${media_src})
 
 set_source_files_properties(${Shaders_src} PROPERTIES VS_TOOL_OVERRIDE "Text")
 set_source_files_properties(${media_src} PROPERTIES VS_TOOL_OVERRIDE "Media")
-
diff --git a/src/VK/GLTF/GLTFTexturesAndBuffers.cpp b/src/VK/GLTF/GLTFTexturesAndBuffers.cpp
@@ -1,5 +1,5 @@
 // AMD AMDUtils code
-// 
+//
 // Copyright(c) 2018 Advanced Micro Devices, Inc.All rights reserved.
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files(the "Software"), to deal
@@ -17,12 +17,12 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-#include "stdafx.h"
-#include "GltfHelpers.h"
-#include "Base\UploadHeap.h"
+
+#include "glTFHelpers.h"
+#include "base/UploadHeap.h"
 #include "GLTFTexturesAndBuffers.h"
-#include "Misc\Misc.h"
-#include "Misc\ThreadPool.h"
+#include "Misc/Misc.h"
+#include "Misc/threadpool.h"
 
 namespace CAULDRON_VK
 {
@@ -53,7 +53,7 @@ namespace CAULDRON_VK
             {
                 // Identify what material uses this texture, this helps:
                 // 1) determine the color space if the texture and also the cut out level. Authoring software saves albedo and emissive images in SRGB mode, the rest are linear mode
-                // 2) tell the cutOff value, to prevent thinning of alpha tested PNGs when lower mips are used. 
+                // 2) tell the cutOff value, to prevent thinning of alpha tested PNGs when lower mips are used.
                 //
                 bool useSRGB = false;
                 float cutOff = 1.0f; // no cutoff

diff --git a/src/VK/GLTF/GLTFTexturesAndBuffers.h b/src/VK/GLTF/GLTFTexturesAndBuffers.h
@@ -1,5 +1,5 @@
 // AMD AMDUtils code
-// 
+//
 // Copyright(c) 2018 Advanced Micro Devices, Inc.All rights reserved.
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files(the "Software"), to deal
@@ -17,10 +17,10 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 #pragma once
-#include "GLTF\GltfCommon.h"
-#include "Base\Texture.h"
-#include "Base\StaticBufferPool.h"
-#include "Base\DynamicBufferRing.h"
+#include "GLTF/GltfCommon.h"
+#include "base/Texture.h"
+#include "base/StaticBufferPool.h"
+#include "base/DynamicBufferRing.h"
 
 namespace CAULDRON_VK
 {
@@ -65,4 +65,4 @@ namespace CAULDRON_VK
         void SetSkinningMatricesForSkeletons();
         void SetPerFrameConstants();
     };
-}
+}
diff --git a/src/VK/GLTF/GltfBBoxPass.cpp b/src/VK/GLTF/GltfBBoxPass.cpp
@@ -1,5 +1,5 @@
 // AMD AMDUtils code
-// 
+//
 // Copyright(c) 2018 Advanced Micro Devices, Inc.All rights reserved.
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files(the "Software"), to deal
@@ -17,11 +17,11 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-#include "stdafx.h"
-#include "Base\DebugMarkersExt.h"
+
+#include "base/DebugMarkersExt.h"
 #include "GltfBBoxPass.h"
-#include "GltfHelpers.h"
-#include "Base\ShaderCompilerHelper.h"
+#include "glTFHelpers.h"
+#include "base/ShaderCompilerHelper.h"
 
 namespace CAULDRON_VK
 {

diff --git a/src/VK/GLTF/GltfBBoxPass.h b/src/VK/GLTF/GltfBBoxPass.h
@@ -1,5 +1,5 @@
 // AMD AMDUtils code
-// 
+//
 // Copyright(c) 2018 Advanced Micro Devices, Inc.All rights reserved.
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files(the "Software"), to deal
@@ -18,12 +18,12 @@
 // THE SOFTWARE.
 #pragma once
 
-#include "Base\Device.h"
-#include "Base\StaticBufferPool.h"
-#include "Base\ResourceViewHeaps.h"
-#include "Base\DynamicBufferRing.h"
+#include "base/Device.h"
+#include "base/StaticBufferPool.h"
+#include "base/ResourceViewHeaps.h"
+#include "base/DynamicBufferRing.h"
 #include "GLTFTexturesAndBuffers.h"
-#include "Widgets\WireframeBox.h"
+#include "widgets/WireframeBox.h"
 
 namespace CAULDRON_VK
 {
@@ -46,5 +46,3 @@ namespace CAULDRON_VK
         WireframeBox m_wireframeBox;
     };
 }
-
-