Changeset c324d6a in opengl-game

Timestamp:

Jan 2, 2021, 4:07:45 PM (4 years ago)

Author:

Dmitry Portnoy <dportnoy@…>

Branches:

feature/imgui-sdl, master

Children:

3b7d497, ca188cc

Parents:

a2f62d7

Message:

Make some minor updates to VulkanGame

Files:

• game-gui-sdl.cpp (modified) (5 diffs)
• game-gui-sdl.hpp (modified) (2 diffs)
• new-game.cpp (modified) (1 diff)
• vulkan-game.cpp (modified) (14 diffs)
• vulkan-game.hpp (modified) (6 diffs)
• vulkan-utils.cpp (modified) (1 diff)

game-gui-sdl.cpp

@@ -3 +3 @@
 #include <map>
 #include <queue>
+
+#include <SDL2/SDL_ttf.h>
 
 #include "compiler.hpp"
@@ -9 +11 @@
 using namespace std;
 
-string GameGui_SDL::s_errorMessage;
-
 GameGui_SDL::GameGui_SDL() : keyState(SDL_GetKeyboardState(NULL)) {
+   window = nullptr;
 }
 
 string& GameGui_SDL::getError() {
-   GameGui_SDL::s_errorMessage = SDL_GetError();
+   s_errorMessage = SDL_GetError();
 
-   return GameGui_SDL::s_errorMessage;
+   return s_errorMessage;
 }
 
@@ -24 +25 @@
    // prevents SDL from setting up its own handlers for SIG_SEGV and stuff like that
 
-   GameGui_SDL::s_errorMessage = "No error";
+   s_errorMessage = "No error";
 
    if (SDL_Init(SDL_INIT_EVERYTHING) < 0) {
@@ -56 +57 @@
 
 #ifdef WINDOWS
-    uint32_t flags = SDL_WINDOW_VULKAN | SDL_WINDOW_SHOWN | (fullscreen ? SDL_WINDOW_FULLSCREEN_DESKTOP : SDL_WINDOW_RESIZABLE);
+   uint32_t flags = SDL_WINDOW_VULKAN | SDL_WINDOW_SHOWN | SDL_WINDOW_ALLOW_HIGHDPI |
+      (fullscreen ? SDL_WINDOW_FULLSCREEN_DESKTOP : SDL_WINDOW_RESIZABLE);
 #else
-    uint32_t flags = SDL_WINDOW_VULKAN | SDL_WINDOW_SHOWN | (fullscreen ? SDL_WINDOW_FULLSCREEN : SDL_WINDOW_RESIZABLE);
+   uint32_t flags = SDL_WINDOW_VULKAN | SDL_WINDOW_SHOWN | SDL_WINDOW_ALLOW_HIGHDPI |
+      (fullscreen ? SDL_WINDOW_FULLSCREEN : SDL_WINDOW_RESIZABLE);
 #endif
 
-   window = SDL_CreateWindow(title.c_str(),
-               SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED,
-               width, height, flags);
+   window = SDL_CreateWindow(title.c_str(), SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED, width, height, flags);
 
    refreshWindowSize();
@@ -148 +149 @@
 
 void GameGui_SDL::refreshWindowSize() {
+   // TODO: Make sure this works on a mac (the analogous glfw function had issues on Mac retina displays)
    SDL_GetWindowSize(window, &windowWidth, &windowHeight);
 }

game-gui-sdl.hpp

@@ -5 +5 @@
 
 #include <SDL2/SDL.h>
-#include <SDL2/SDL_ttf.h>
 
 #ifdef GAMEGUI_INCLUDE_VULKAN
@@ -41 +40 @@
       const Uint8* keyState;
 
-      static string s_errorMessage;
+      string s_errorMessage;
 };
 

new-game.cpp

@@ -8 +8 @@
 #include <glm/gtc/type_ptr.hpp>
 
+#include <GL/glew.h>
+#include <GLFW/glfw3.h>
+
 #include "IMGUI/imgui.h"
 #include "IMGUI/imgui_impl_glfw.h"
 #include "IMGUI/imgui_impl_opengl3.h"
-
-#include <GL/glew.h>
-#include <GLFW/glfw3.h>
 
 #include <cstdio>

vulkan-game.cpp

@@ -5 +5 @@
 #include <numeric>
 #include <set>
-
-#include "consts.hpp"
+#include <stdexcept>
+
 #include "logger.hpp"
 
@@ -16 +16 @@
 using namespace std;
 
-// TODO: Update all occurances of instance variables to use this->
+// TODO: Update all occurances of instance variables to use this-> (Actually, not sure if I really want to do this)
+
+/* TODO: Try doing the following tasks based on the Vulkan implementation of IMGUI (Also maybe looks at Sascha Willems' code to see how he does these things)
+ *
+ * - When recreating the swapchain, pass the old one in and destroy the old one after the new one is created
+ * - Recreate semaphores when recreating the swapchain
+ *     - imgui uses one image acquired and one render complete sem  and once fence per frame\
+ * - IMGUI creates one command pool per framebuffer
+ */
 
 VulkanGame::VulkanGame(int maxFramesInFlight) : MAX_FRAMES_IN_FLIGHT(maxFramesInFlight) {
    this->gui = nullptr;
    this->window = nullptr;
+
+   this->debugMessenger = VK_NULL_HANDLE;
 
    this->currentFrame = 0;
@@ -85 +95 @@
 
    // TODO: Refactor the logger api to be more flexible,
-   // esp. since gl_log() and gl_log_err() have issues printing anything besides stirngs
+   // esp. since gl_log() and gl_log_err() have issues printing anything besides strings
    restart_gl_log();
    gl_log("starting SDL\n%s.%s.%s",
@@ -93 +103 @@
 
    // TODO: Use open_Log() and related functions instead of gl_log ones
+   // TODO: In addition, delete the gl_log functions
    open_log();
    get_log() << "starting SDL" << endl;
@@ -807 +818 @@
    }
 
+   // TODO: Should probably check the returned result
    vkDeviceWaitIdle(device);
 }
@@ -1131 +1143 @@
 }
 
-void VulkanGame::createVulkanInstance(const vector<const char*> &validationLayers) {
+void VulkanGame::createVulkanInstance(const vector<const char*>& validationLayers) {
    if (ENABLE_VALIDATION_LAYERS && !VulkanUtils::checkValidationLayerSupport(validationLayers)) {
       throw runtime_error("validation layers requested, but not available!");
@@ -1181 +1193 @@
 
 void VulkanGame::setupDebugMessenger() {
-   if (!ENABLE_VALIDATION_LAYERS) return;
+   if (!ENABLE_VALIDATION_LAYERS) {
+      return;
+   }
 
    VkDebugUtilsMessengerCreateInfoEXT createInfo;
@@ -1217 +1231 @@
 void VulkanGame::pickPhysicalDevice(const vector<const char*>& deviceExtensions) {
    uint32_t deviceCount = 0;
+   // TODO: Check VkResult
    vkEnumeratePhysicalDevices(instance, &deviceCount, nullptr);
 
@@ -1224 +1239 @@
 
    vector<VkPhysicalDevice> devices(deviceCount);
+   // TODO: Check VkResult
    vkEnumeratePhysicalDevices(instance, &deviceCount, devices.data());
 
@@ -1262 +1278 @@
 }
 
-void VulkanGame::createLogicalDevice(
-      const vector<const char*> validationLayers, const vector<const char*>& deviceExtensions) {
+void VulkanGame::createLogicalDevice(const vector<const char*>& validationLayers,
+      const vector<const char*>& deviceExtensions) {
    QueueFamilyIndices indices = VulkanUtils::findQueueFamilies(physicalDevice, surface);
 
@@ -1285 +1301 @@
    VkDeviceCreateInfo createInfo = {};
    createInfo.sType = VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO;
+
    createInfo.queueCreateInfoCount = static_cast<uint32_t>(queueCreateInfoList.size());
    createInfo.pQueueCreateInfos = queueCreateInfoList.data();
@@ -1317 +1334 @@
    VkExtent2D extent = VulkanUtils::chooseSwapExtent(swapChainSupport.capabilities, gui->getWindowWidth(), gui->getWindowHeight());
 
-   uint32_t imageCount = swapChainSupport.capabilities.minImageCount + 1;
-   if (swapChainSupport.capabilities.maxImageCount > 0 && imageCount > swapChainSupport.capabilities.maxImageCount) {
-      imageCount = swapChainSupport.capabilities.maxImageCount;
+   swapChainImageCount = swapChainSupport.capabilities.minImageCount + 1;
+   if (swapChainSupport.capabilities.maxImageCount > 0 && swapChainImageCount > swapChainSupport.capabilities.maxImageCount) {
+      swapChainImageCount = swapChainSupport.capabilities.maxImageCount;
    }
 
@@ -1325 +1342 @@
    createInfo.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR;
    createInfo.surface = surface;
-   createInfo.minImageCount = imageCount;
+   createInfo.minImageCount = swapChainImageCount;
    createInfo.imageFormat = surfaceFormat.format;
    createInfo.imageColorSpace = surfaceFormat.colorSpace;
@@ -1355 +1372 @@
    }
 
-   vkGetSwapchainImagesKHR(device, swapChain, &imageCount, nullptr);
-   swapChainImages.resize(imageCount);
-   vkGetSwapchainImagesKHR(device, swapChain, &imageCount, swapChainImages.data());
+   vkGetSwapchainImagesKHR(device, swapChain, &swapChainImageCount, nullptr);
+   swapChainImages.resize(swapChainImageCount);
+   vkGetSwapchainImagesKHR(device, swapChain, &swapChainImageCount, swapChainImages.data());
 
    swapChainImageFormat = surfaceFormat.format;

vulkan-game.hpp

@@ -15 +15 @@
 #include <vulkan/vulkan.h>
 
+#include <SDL2/SDL.h>
 #include <SDL2/SDL_ttf.h>
 
@@ -227 +228 @@
 
    private:
+      static VKAPI_ATTR VkBool32 VKAPI_CALL debugCallback(
+         VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
+         VkDebugUtilsMessageTypeFlagsEXT messageType,
+         const VkDebugUtilsMessengerCallbackDataEXT* pCallbackData,
+         void* pUserData);
+
       // TODO: Make these consts static
       // Also, maybe move them into consts.hpp
@@ -261 +268 @@
       VkQueue presentQueue;
 
+      uint32_t swapChainImageCount;
       VkSwapchainKHR swapChain;
       vector<VkImage> swapChainImages;
@@ -374 +382 @@
       void cleanup();
 
-      void createVulkanInstance(const vector<const char*> &validationLayers);
+      void createVulkanInstance(const vector<const char*>& validationLayers);
       void setupDebugMessenger();
       void populateDebugMessengerCreateInfo(VkDebugUtilsMessengerCreateInfoEXT& createInfo);
@@ -380 +388 @@
       void pickPhysicalDevice(const vector<const char*>& deviceExtensions);
       bool isDeviceSuitable(VkPhysicalDevice physicalDevice, const vector<const char*>& deviceExtensions);
-      void createLogicalDevice(
-         const vector<const char*> validationLayers,
+      void createLogicalDevice(const vector<const char*>& validationLayers,
          const vector<const char*>& deviceExtensions);
       void createSwapChain();
@@ -436 +443 @@
 
       void cleanupSwapChain();
-
-      static VKAPI_ATTR VkBool32 VKAPI_CALL debugCallback(
-            VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
-            VkDebugUtilsMessageTypeFlagsEXT messageType,
-            const VkDebugUtilsMessengerCallbackDataEXT* pCallbackData,
-            void* pUserData);
 };
 

vulkan-utils.cpp

@@ -145 +145 @@
    VkPresentModeKHR bestMode = VK_PRESENT_MODE_FIFO_KHR;
 
+   /* This functions effectively selects present modes in this order, which allows for unlimited framerate:
+    * { VK_PRESENT_MODE_MAILBOX_KHR, VK_PRESENT_MODE_IMMEDIATE_KHR, VK_PRESENT_MODE_FIFO_KHR }
+    *
+    * To cap the framerate (I assume to the monitor refresh rate), just use:
+    * { VK_PRESENT_MODE_FIFO_KHR }
+    * 
+    * Would be better to make a more generic function that takes a list of prefered modes ordered by preference.
+    * Example code:
+    * 
+    * for (int request_i = 0; request_i < request_modes_count; request_i++)
+    *    for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
+    *       if (request_modes[request_i] == avail_modes[avail_i])
+    *          return request_modes[request_i];
+    */
+
    for (const auto& availablePresentMode : availablePresentModes) {
       if (availablePresentMode == VK_PRESENT_MODE_MAILBOX_KHR) {
          return availablePresentMode;
-      }
-      else if (availablePresentMode == VK_PRESENT_MODE_IMMEDIATE_KHR) {
+      } else if (availablePresentMode == VK_PRESENT_MODE_IMMEDIATE_KHR) {
          bestMode = availablePresentMode;
       }