Added text overlay to the example base (by default off)

base/vulkanexamplebase.cpp

@@ -265,6 +265,25 @@ void VulkanExampleBase::prepare()
 #if defined(__ANDROID__)
 	textureLoader->assetManager = androidApp->activity->assetManager;
 #endif
+	if (enableTextOverlay)
+	{
+		// Load the text rendering shaders
+		std::vector<VkPipelineShaderStageCreateInfo> shaderStages;
+		shaderStages.push_back(loadShader(getAssetPath() + "shaders/base/textoverlay.vert.spv", VK_SHADER_STAGE_VERTEX_BIT));
+		shaderStages.push_back(loadShader(getAssetPath() + "shaders/base/textoverlay.frag.spv", VK_SHADER_STAGE_FRAGMENT_BIT));
+		textOverlay = new VulkanTextOverlay(
+			physicalDevice,
+			device,
+			queue,
+			frameBuffers,
+			colorformat,
+			depthFormat,
+			&width,
+			&height,
+			shaderStages
+			);
+		updateTextOverlay();
+	}
 }
 
 VkPipelineShaderStageCreateInfo VulkanExampleBase::loadShader(std::string fileName, VkShaderStageFlagBits stage)
@@ -394,8 +413,12 @@ void VulkanExampleBase::renderLoop()
 		if (fpsTimer > 1000.0f)
 		{
 			std::string windowTitle = getWindowTitle();
+			if (!enableTextOverlay)
+			{
 				SetWindowText(window, windowTitle.c_str());
+			}
 			lastFPS = frameCounter;
+			updateTextOverlay();
 			fpsTimer = 0.0f;
 			frameCounter = 0.0f;
 		}
@@ -452,8 +475,8 @@ void VulkanExampleBase::renderLoop()
 			fpsTimer += (float)tDiff;
 			if (fpsTimer > 1000.0f)
 			{
-				LOGD("%d fps", frameCounter);
 				lastFPS = frameCounter;
+				updateTextOverlay();
 				fpsTimer = 0.0f;
 				frameCounter = 0.0f;
 			}
@@ -515,12 +538,16 @@ void VulkanExampleBase::renderLoop()
 		}
 		fpsTimer += (float)tDiff;
 		if (fpsTimer > 1000.0f)
+		{
+			if (!enableTextOverlay)
 			{
 				std::string windowTitle = getWindowTitle();
 				xcb_change_property(connection, XCB_PROP_MODE_REPLACE,
 					window, XCB_ATOM_WM_NAME, XCB_ATOM_STRING, 8,
 					windowTitle.size(), windowTitle.c_str());
+			}
 			lastFPS = frameCounter;
+			updateTextOverlay();
 			fpsTimer = 0.0f;
 			frameCounter = 0.0f;
 		}
@@ -617,6 +644,26 @@ VkSubmitInfo VulkanExampleBase::prepareSubmitInfo(
 	return submitInfo;
 }
 
+void VulkanExampleBase::updateTextOverlay()
+{
+	if (!enableTextOverlay)
+		return;
+
+	textOverlay->beginTextUpdate();
+
+	textOverlay->addText(title, 5.0f, 5.0f, VulkanTextOverlay::alignLeft);
+
+	std::stringstream ss;
+	ss << std::fixed << std::setprecision(2) << (frameTimer * 1000.0f) << "ms (" << lastFPS << " fps)";
+	textOverlay->addText(ss.str(), 5.0f, 25.0f, VulkanTextOverlay::alignLeft);
+
+	textOverlay->addText(deviceProperties.deviceName, 5.0f, 45.0f, VulkanTextOverlay::alignLeft);
+
+	// todo : callback for adding text from derived classes
+
+	textOverlay->endTextUpdate();
+}
+
 VulkanExampleBase::VulkanExampleBase(bool enableValidation)
 {
 	// Check for validation command line flag
@@ -690,6 +737,12 @@ VulkanExampleBase::~VulkanExampleBase()
 
 	vkDestroySemaphore(device, semaphores.presentComplete, nullptr);
 	vkDestroySemaphore(device, semaphores.renderComplete, nullptr);
+	vkDestroySemaphore(device, semaphores.textOverlayComplete, nullptr);
+
+	if (enableTextOverlay)
+	{
+		delete textOverlay;
+	}
 
 	vkDestroyDevice(device, nullptr);
 
@@ -798,12 +851,14 @@ void VulkanExampleBase::initVulkan(bool enableValidation)
 	VkSemaphoreCreateInfo semaphoreCreateInfo = vkTools::initializers::semaphoreCreateInfo();
 	// Create a semaphore used to synchronize image presentation
 	// Ensures that the image is displayed before we start submitting new commands to the queu
-	err = vkCreateSemaphore(device, &semaphoreCreateInfo, nullptr, &semaphores.presentComplete);
+	VK_CHECK_RESULT(vkCreateSemaphore(device, &semaphoreCreateInfo, nullptr, &semaphores.presentComplete));
-	assert(!err);
 	// Create a semaphore used to synchronize command submission
 	// Ensures that the image is not presented until all commands have been sumbitted and executed
-	err = vkCreateSemaphore(device, &semaphoreCreateInfo, nullptr, &semaphores.renderComplete);
+	VK_CHECK_RESULT(vkCreateSemaphore(device, &semaphoreCreateInfo, nullptr, &semaphores.renderComplete));
-	assert(!err);
+	// Create a semaphore used to synchronize command submission
+	// Ensures that the image is not presented until all commands for the text overlay have been sumbitted and executed
+	// Will be inserted after the render complete semaphore if the text overlay is enabled
+	VK_CHECK_RESULT(vkCreateSemaphore(device, &semaphoreCreateInfo, nullptr, &semaphores.textOverlayComplete));
 
 	// Set up submit info structure
 	// Semaphores will stay the same during application lifetime
@@ -1029,7 +1084,7 @@ void VulkanExampleBase::handleMessages(HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
 		{
 			destWidth = LOWORD(lParam);
 			destHeight = HIWORD(lParam);
-			if ((wParam == SIZE_MAXIMIZED) || (wParam == SIZE_RESTORED))
+			if ((wParam == SIZE_MAXIMIZED) || (wParam == SIZE_MINIMIZED))
 			{
 				windowResize();
 			}
@@ -1543,6 +1598,12 @@ void VulkanExampleBase::windowResize()
 	vkQueueWaitIdle(queue);
 	vkDeviceWaitIdle(device);
 
+	if (enableTextOverlay)
+	{
+		textOverlay->reallocateCommandBuffers();
+		updateTextOverlay();
+	}
+
 	// Notify derived class
 	windowResized();
 	viewChanged();

base/vulkanexamplebase.h

@@ -39,6 +39,7 @@
 #include "vulkanswapchain.hpp"
 #include "vulkanTextureLoader.hpp"
 #include "vulkanMeshLoader.hpp"
+#include "vulkantextoverlay.hpp"
 
 #define GAMEPAD_BUTTON_A 0x1000
 #define GAMEPAD_BUTTON_B 0x1001
@@ -125,6 +126,8 @@ protected:
 		VkSemaphore presentComplete;
 		// Command buffer submission and execution
 		VkSemaphore renderComplete;
+		// Text overlay submission and execution
+		VkSemaphore textOverlayComplete;
 	} semaphores;
 	// Simple texture loader
 	vkTools::VulkanTextureLoader *textureLoader = nullptr;
@@ -147,6 +150,9 @@ public:
 	
 	bool paused = false;
 
+	bool enableTextOverlay = false;
+	VulkanTextOverlay *textOverlay;
+
 	// Use to adjust mouse rotation speed
 	float rotationSpeed = 1.0f;
 	// Use to adjust mouse zoom speed
@@ -332,5 +338,7 @@ public:
 	VkSubmitInfo prepareSubmitInfo(
 		std::vector<VkCommandBuffer> commandBuffers,
 		VkPipelineStageFlags *pipelineStages);
+
+	void updateTextOverlay();
 };
 

base/vulkantextoverlay.hpp

@@ -634,8 +634,6 @@ public:
 
 		for (int32_t i = 0; i < cmdBuffers.size(); ++i)
 		{
-			std::cout << "update text cmd buff " << i << " with fb " << *frameBuffers[i] << std::endl;
-
 			renderPassBeginInfo.framebuffer = *frameBuffers[i];
 
 			VK_CHECK_RESULT(vkBeginCommandBuffer(cmdBuffers[i], &cmdBufInfo));
@@ -666,7 +664,6 @@ public:
 	}
 
 	// Submit the text command buffers to a queue
-	// Does a queue wait idle
 	void submit(VkQueue queue, uint32_t bufferindex, VkSubmitInfo submitInfo)
 	{
 		if (!visible)