Replaced per-sample validation define with global define in base class

Toggling validation via command line arguments is the preferred way anyway Define was also added as a CMake option
SaschaWillems · Dec 30, 2023 · d0211d1 · d0211d1
1 parent a04a506
commit d0211d1
Show file tree

Hide file tree

Showing 86 changed files with 90 additions and 205 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -22,6 +22,7 @@ OPTION(USE_DIRECTFB_WSI "Build the project using DirectFB swapchain" OFF)
 OPTION(USE_WAYLAND_WSI "Build the project using Wayland swapchain" OFF)
 OPTION(USE_HEADLESS "Build the project using headless extension swapchain" OFF)
 OPTION(USE_RELATIVE_ASSET_PATH "Load assets (shaders, models, textures) from a fixed path relative to the binar" OFF)
+OPTION(FORCE_VALIDATION "Forces validation on for all samples at compile time (prefer using the -v / --validation command line arguments)" OFF)
 
 set(RESOURCE_INSTALL_DIR "" CACHE PATH "Path to install resources to (leave empty for running uninstalled)")
 
@@ -128,6 +129,11 @@ else()
 	endif()
 endif()
 
+# Force validation at compile time
+if (FORCE_VALIDATION)
+	add_definitions(-DFORCE_VALIDATION)
+endif()
+
 # Compiler specific stuff
 IF(MSVC)
 	SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /EHsc")

diff --git a/base/vulkanexamplebase.cpp b/base/vulkanexamplebase.cpp
@@ -779,7 +779,7 @@ void VulkanExampleBase::submitFrame()
 	VK_CHECK_RESULT(vkQueueWaitIdle(queue));
 }
 
-VulkanExampleBase::VulkanExampleBase(bool enableValidation)
+VulkanExampleBase::VulkanExampleBase()
 {
 #if !defined(VK_USE_PLATFORM_ANDROID_KHR)
 	// Check for a valid asset path
@@ -796,7 +796,10 @@ VulkanExampleBase::VulkanExampleBase(bool enableValidation)
 	}
 #endif
 
-	settings.validation = enableValidation;
+	// Validation for all samples can be forced at compile time using the FORCE_VALIDATION define
+#if defined(FORCE_VALIDATION) 
+	settings.validation = true;
+#endif
 
 	// Command line arguments
 	commandLineParser.add("help", { "--help" }, 0, "Show help");

diff --git a/base/vulkanexamplebase.h b/base/vulkanexamplebase.h
@@ -276,7 +276,8 @@ class VulkanExampleBase
 	bool quit = false;
 #endif
 
-	VulkanExampleBase(bool enableValidation = false);
+	/** @brief Default base class constructor */
+	VulkanExampleBase();
 	virtual ~VulkanExampleBase();
 	/** @brief Setup the vulkan instance, enable required extensions and connect to the physical device (GPU) */
 	bool initVulkan();

diff --git a/examples/bloom/bloom.cpp b/examples/bloom/bloom.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 // Offscreen frame buffer properties
 #define FB_DIM 256
@@ -93,7 +92,7 @@ class VulkanExample : public VulkanExampleBase
 		std::array<FrameBuffer, 2> framebuffers;
 	} offscreenPass;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Bloom (offscreen rendering)";
 		timerSpeed *= 0.5f;

diff --git a/examples/computecloth/computecloth.cpp b/examples/computecloth/computecloth.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -89,7 +88,7 @@ class VulkanExample : public VulkanExampleBase
 		glm::vec2 size = glm::vec2(5.0f);
 	} cloth;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Compute shader cloth simulation";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/computecullandlod/computecullandlod.cpp b/examples/computecullandlod/computecullandlod.cpp
@@ -11,7 +11,6 @@
 #include "VulkanglTFModel.h"
 #include "frustum.hpp"
 
-#define ENABLE_VALIDATION false
 
 // Total number of objects (^3) in the scene
 #if defined(__ANDROID__)
@@ -89,7 +88,7 @@ class VulkanExample : public VulkanExampleBase
 
 	uint32_t objectCount = 0;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Vulkan Example - Compute cull and lod";
 		camera.type = Camera::CameraType::firstperson;

diff --git a/examples/computenbody/computenbody.cpp b/examples/computenbody/computenbody.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 
 #define VERTEX_BUFFER_BIND_ID 0
-#define ENABLE_VALIDATION false
 #if defined(__ANDROID__)
 // Lower particle count on Android for performance reasons
 #define PARTICLES_PER_ATTRACTOR 3 * 1024
@@ -79,7 +78,7 @@ class VulkanExample : public VulkanExampleBase
 		glm::vec4 vel;								// xyz = velocity, w = gradient texture position
 	};
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Compute shader N-body system";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/computeparticles/computeparticles.cpp b/examples/computeparticles/computeparticles.cpp
@@ -11,7 +11,6 @@
 #include "vulkanexamplebase.h"
 
 #define VERTEX_BUFFER_BIND_ID 0
-#define ENABLE_VALIDATION false
 #if defined(__ANDROID__)
 // Lower particle count on Android for performance reasons
 #define PARTICLE_COUNT 128 * 1024
@@ -75,7 +74,7 @@ class VulkanExample : public VulkanExampleBase
 		glm::vec4 gradientPos;						// Texture coordinates for the gradient ramp map
 	};
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Compute shader particle system";
 	}

diff --git a/examples/computeraytracing/computeraytracing.cpp b/examples/computeraytracing/computeraytracing.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 
 #define VERTEX_BUFFER_BIND_ID 0
-#define ENABLE_VALIDATION false
 
 #if defined(__ANDROID__)
 #define TEX_DIM 1024
@@ -79,7 +78,7 @@ class VulkanExample : public VulkanExampleBase
 		glm::ivec3 _pad;
 	};
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Compute shader ray tracing";
 		compute.ubo.aspectRatio = (float)width / (float)height;

diff --git a/examples/computeshader/computeshader.cpp b/examples/computeshader/computeshader.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 
 #define VERTEX_BUFFER_BIND_ID 0
-#define ENABLE_VALIDATION false
 
 // Vertex layout for this example
 struct Vertex {
@@ -67,7 +66,7 @@ class VulkanExample : public VulkanExampleBase
 
 	std::vector<std::string> shaderNames;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Compute shader image load/store";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/conditionalrender/conditionalrender.cpp b/examples/conditionalrender/conditionalrender.cpp
@@ -14,7 +14,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -40,7 +39,7 @@ class VulkanExample : public VulkanExampleBase
 	VkDescriptorSetLayout descriptorSetLayout;
 	VkDescriptorSet descriptorSet;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Conditional rendering";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/conservativeraster/conservativeraster.cpp b/examples/conservativeraster/conservativeraster.cpp
@@ -12,7 +12,6 @@
 
 #include "vulkanexamplebase.h"
 
-#define ENABLE_VALIDATION false
 
 #define FB_COLOR_FORMAT VK_FORMAT_R8G8B8A8_UNORM
 #define ZOOM_FACTOR 16
@@ -84,7 +83,7 @@ class VulkanExample : public VulkanExampleBase
 		VkDescriptorImageInfo descriptor;
 	} offscreenPass;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Conservative rasterization";
 

diff --git a/examples/debugprintf/debugprintf.cpp b/examples/debugprintf/debugprintf.cpp
@@ -17,7 +17,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -36,7 +35,7 @@ class VulkanExample : public VulkanExampleBase
 	VkDescriptorSetLayout descriptorSetLayout{ VK_NULL_HANDLE };
 	VkDescriptorSet descriptorSet{ VK_NULL_HANDLE };
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Debug output with shader printf";
 		camera.setRotation(glm::vec3(-4.35f, 16.25f, 0.0f));

diff --git a/examples/debugutils/debugutils.cpp b/examples/debugutils/debugutils.cpp
@@ -9,8 +9,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
-
 class VulkanExample : public VulkanExampleBase
 {
 public:
@@ -79,7 +77,7 @@ class VulkanExample : public VulkanExampleBase
 	PFN_vkQueueEndDebugUtilsLabelEXT vkQueueEndDebugUtilsLabelEXT{ nullptr };
 	PFN_vkSetDebugUtilsObjectNameEXT vkSetDebugUtilsObjectNameEXT{ nullptr };
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Debugging with VK_EXT_debug_utils";
 		camera.setRotation(glm::vec3(-4.35f, 16.25f, 0.0f));

diff --git a/examples/deferred/deferred.cpp b/examples/deferred/deferred.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 // Texture properties
 #define TEX_DIM 2048
@@ -100,7 +99,7 @@ class VulkanExample : public VulkanExampleBase
 	// Semaphore used to synchronize between offscreen and final scene rendering
 	VkSemaphore offscreenSemaphore = VK_NULL_HANDLE;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Deferred shading";
 		camera.type = Camera::CameraType::firstperson;

diff --git a/examples/deferredmultisampling/deferredmultisampling.cpp b/examples/deferredmultisampling/deferredmultisampling.cpp
@@ -10,7 +10,6 @@
 #include "VulkanFrameBuffer.hpp"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 #if defined(__ANDROID__)
 // Use max. screen dimension as deferred framebuffer size
@@ -90,7 +89,7 @@ class VulkanExample : public VulkanExampleBase
 	// Semaphore used to synchronize between offscreen and final scene rendering
 	VkSemaphore offscreenSemaphore = VK_NULL_HANDLE;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Multi sampled deferred shading";
 		camera.type = Camera::CameraType::firstperson;

diff --git a/examples/deferredshadows/deferredshadows.cpp b/examples/deferredshadows/deferredshadows.cpp
@@ -11,7 +11,6 @@
 #include "VulkanglTFModel.h"
 
 #define VERTEX_BUFFER_BIND_ID 0
-#define ENABLE_VALIDATION false
 
 // Shadowmap properties
 #if defined(__ANDROID__)
@@ -129,7 +128,7 @@ class VulkanExample : public VulkanExampleBase
 	// Semaphore used to synchronize between offscreen and final scene rendering
 	VkSemaphore offscreenSemaphore = VK_NULL_HANDLE;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Deferred shading with shadows";
 		camera.type = Camera::CameraType::firstperson;

diff --git a/examples/descriptorbuffer/descriptorbuffer.cpp b/examples/descriptorbuffer/descriptorbuffer.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -63,7 +62,7 @@ class VulkanExample : public VulkanExampleBase
 		return vkGetBufferDeviceAddressKHR(vulkanDevice->logicalDevice, &bufferDeviceAI);
 	}
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Descriptor buffers (VK_EXT_descriptor_buffer)";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/descriptorindexing/descriptorindexing.cpp b/examples/descriptorindexing/descriptorindexing.cpp
@@ -13,7 +13,6 @@
 
 #include "vulkanexamplebase.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -45,7 +44,7 @@ class VulkanExample : public VulkanExampleBase
 		int32_t textureIndex;
 	};
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Descriptor indexing";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/descriptorsets/descriptorsets.cpp b/examples/descriptorsets/descriptorsets.cpp
@@ -11,7 +11,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -38,7 +37,7 @@ class VulkanExample : public VulkanExampleBase
 
 	VkDescriptorSetLayout descriptorSetLayout;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Using descriptor Sets";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/displacement/displacement.cpp b/examples/displacement/displacement.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -48,7 +47,7 @@ class VulkanExample : public VulkanExampleBase
 	VkDescriptorSet descriptorSet;
 	VkDescriptorSetLayout descriptorSetLayout;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Tessellation shader displacement";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/distancefieldfonts/distancefieldfonts.cpp b/examples/distancefieldfonts/distancefieldfonts.cpp
@@ -11,7 +11,6 @@
 #include "vulkanexamplebase.h"
 
 #define VERTEX_BUFFER_BIND_ID 0
-#define ENABLE_VALIDATION false
 
 // Vertex layout for this example
 struct Vertex {
@@ -93,7 +92,7 @@ class VulkanExample : public VulkanExampleBase
 	VkPipelineLayout pipelineLayout;
 	VkDescriptorSetLayout descriptorSetLayout;
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Distance field font rendering";
 		camera.type = Camera::CameraType::lookat;

diff --git a/examples/dynamicrendering/dynamicrendering.cpp b/examples/dynamicrendering/dynamicrendering.cpp
@@ -9,7 +9,6 @@
 #include "vulkanexamplebase.h"
 #include "VulkanglTFModel.h"
 
-#define ENABLE_VALIDATION false
 
 class VulkanExample : public VulkanExampleBase
 {
@@ -33,7 +32,7 @@ class VulkanExample : public VulkanExampleBase
 	VkDescriptorSet descriptorSet{ VK_NULL_HANDLE };
 	VkDescriptorSetLayout descriptorSetLayout{ VK_NULL_HANDLE };
 
-	VulkanExample() : VulkanExampleBase(ENABLE_VALIDATION)
+	VulkanExample() : VulkanExampleBase()
 	{
 		title = "Dynamic rendering";
 		camera.type = Camera::CameraType::lookat;