GUI: prepare for DirectX 11 render backend

CMakeLists.txt

@@ -60,6 +60,11 @@ if (APPLE)
 else()
   set(WITH_RENDER_OPENGL_DEFAULT ON)
 endif()
+if (WIN32)
+  set(WITH_RENDER_DX11_DEFAULT ON)
+else()
+  set(WITH_RENDER_DX11_DEFAULT OFF)
+endif()
 
 if (ANDROID)
   set(USE_GLES_DEFAULT ON)
@@ -75,6 +80,7 @@ option(USE_BACKWARD "Use backward-cpp to print a backtrace on crash/abort." ${US
 option(WITH_JACK "Whether to build with JACK support. Auto-detects if JACK is available" ${WITH_JACK_DEFAULT})
 option(WITH_RENDER_SDL "Whether to build with the SDL_Renderer render backend." ${WITH_RENDER_SDL_DEFAULT})
 option(WITH_RENDER_OPENGL "Whether to build with the OpenGL render backend." ${WITH_RENDER_OPENGL_DEFAULT})
+option(WITH_RENDER_DX11 "Whether to build with the DirectX 11 render backend." ${WITH_RENDER_DX11_DEFAULT})
 option(USE_GLES "Use OpenGL ES for the OpenGL render backend." ${USE_GLES_DEFAULT})
 option(SYSTEM_FFTW "Use a system-installed version of FFTW instead of the vendored one" OFF)
 option(SYSTEM_FMT "Use a system-installed version of fmt instead of the vendored one" OFF)
@@ -302,7 +308,7 @@ else()
 endif()
 
 if (BUILD_GUI)
-  if (NOT WITH_RENDER_SDL AND NOT WITH_RENDER_OPENGL)
+  if (NOT WITH_RENDER_SDL AND NOT WITH_RENDER_OPENGL AND NOT WITH_RENDER_DX11)
     message(FATAL_ERROR "No render backends selected!")
   endif()
 endif()
@@ -731,6 +737,18 @@ if (WITH_RENDER_OPENGL)
   message(STATUS "UI render backend: OpenGL")
 endif()
 
+if (WITH_RENDER_DX11)
+  if (WIN32)
+    list(APPEND GUI_SOURCES src/gui/render/renderDX11.cpp)
+    list(APPEND GUI_SOURCES extern/imgui_patched/backends/imgui_impl_dx11.cpp)
+    list(APPEND DEPENDENCIES_DEFINES HAVE_RENDER_DX11)
+    list(APPEND DEPENDENCIES_LIBRARIES D3D11 d3dcompiler)
+    message(STATUS "UI render backend: DirectX 11")
+  else()
+    message(FATAL_ERROR "DirectX 11 render backend only for Windows!")
+  endif()
+endif()
+
 if (NOT WIN32 AND NOT APPLE)
   CHECK_INCLUDE_FILE(sys/io.h SYS_IO_FOUND)
   CHECK_INCLUDE_FILE(linux/input.h LINUX_INPUT_FOUND)

src/gui/gui.cpp

@@ -6148,7 +6148,7 @@ bool FurnaceGUI::init() {
   logV("window size: %dx%d",scrW,scrH);
 
   if (!initRender()) {
-    if (settings.renderBackend=="OpenGL") {
+    if (settings.renderBackend!="SDL" && !settings.renderBackend.empty()) {
       settings.renderBackend="";
       e->setConf("renderBackend","");
       e->saveConf();
@@ -6234,7 +6234,7 @@ bool FurnaceGUI::init() {
 
   logD("starting render backend...");
   if (!rend->init(sdlWin)) {
-    if (settings.renderBackend=="OpenGL") {
+    if (settings.renderBackend!="SDL" && !settings.renderBackend.empty()) {
       settings.renderBackend="";
       e->setConf("renderBackend","");
       e->saveConf();

src/gui/gui.h

@@ -71,16 +71,22 @@
 
 enum FurnaceGUIRenderBackend {
   GUI_BACKEND_SDL=0,
-  GUI_BACKEND_GL
+  GUI_BACKEND_GL,
+  GUI_BACKEND_DX11
 };
 
 #ifdef HAVE_RENDER_SDL
 #define GUI_BACKEND_DEFAULT GUI_BACKEND_SDL
 #define GUI_BACKEND_DEFAULT_NAME "SDL"
 #else
+#ifdef HAVE_RENDER_DX11
+#define GUI_BACKEND_DEFAULT GUI_BACKEND_DX11
+#define GUI_BACKEND_DEFAULT_NAME "DirectX 11"
+#else
 #define GUI_BACKEND_DEFAULT GUI_BACKEND_GL
 #define GUI_BACKEND_DEFAULT_NAME "OpenGL"
 #endif
+#endif
 
 // TODO:
 // - add colors for FM envelope and waveform

src/gui/render.cpp

@@ -25,12 +25,17 @@
 #ifdef HAVE_RENDER_GL
 #include "render/renderGL.h"
 #endif
+#ifdef HAVE_RENDER_DX11
+#include "render/renderDX11.h"
+#endif
 
 bool FurnaceGUI::initRender() {
   if (rend!=NULL) return false;
 
   if (settings.renderBackend=="OpenGL") {
     renderBackend=GUI_BACKEND_GL;
+  } else if (settings.renderBackend=="DirectX 11") {
+    renderBackend=GUI_BACKEND_DX11;
   } else if (settings.renderBackend=="SDL") {
     renderBackend=GUI_BACKEND_SDL;
   } else {
@@ -44,6 +49,12 @@ bool FurnaceGUI::initRender() {
       rend=new FurnaceGUIRenderGL;
       break;
 #endif
+#ifdef HAVE_RENDER_DX11
+    case GUI_BACKEND_DX11:
+      logI("render backend: DirectX 11");
+      rend=new FurnaceGUIRenderDX11;
+      break;
+#endif
 #ifdef HAVE_RENDER_SDL
     case GUI_BACKEND_SDL:
       logI("render backend: SDL_Renderer");

src/gui/render/renderDX11.cpp

@@ -0,0 +1,100 @@
+/**
+ * Furnace Tracker - multi-system chiptune tracker
+ * Copyright (C) 2021-2023 tildearrow and contributors
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "renderDX11.h"
+
+ImTextureID FurnaceGUIRenderDX11::getTextureID(void* which) {
+  return NULL;
+}
+
+bool FurnaceGUIRenderDX11::lockTexture(void* which, void** data, int* pitch) {
+  return false;
+}
+
+bool FurnaceGUIRenderDX11::unlockTexture(void* which) {
+  return false;
+}
+
+bool FurnaceGUIRenderDX11::updateTexture(void* which, void* data, int pitch) {
+  return false;
+}
+
+void* FurnaceGUIRenderDX11::createTexture(bool dynamic, int width, int height) {
+  return NULL;
+}
+
+bool FurnaceGUIRenderDX11::destroyTexture(void* which) {
+  return false;
+}
+
+void FurnaceGUIRenderDX11::setTextureBlendMode(void* which, FurnaceGUIBlendMode mode) {
+}
+
+void FurnaceGUIRenderDX11::setBlendMode(FurnaceGUIBlendMode mode) {
+}
+
+void FurnaceGUIRenderDX11::clear(ImVec4 color) {
+}
+
+bool FurnaceGUIRenderDX11::newFrame() {
+  return true;
+}
+
+void FurnaceGUIRenderDX11::createFontsTexture() {
+}
+
+void FurnaceGUIRenderDX11::destroyFontsTexture() {
+}
+
+void FurnaceGUIRenderDX11::renderGUI() {
+}
+
+void FurnaceGUIRenderDX11::wipe(float alpha) {
+}
+
+void FurnaceGUIRenderDX11::present() {
+}
+
+bool FurnaceGUIRenderDX11::getOutputSize(int& w, int& h) {
+  return false;
+}
+
+int FurnaceGUIRenderDX11::getWindowFlags() {
+  return 0;
+}
+
+void FurnaceGUIRenderDX11::preInit() {
+}
+
+bool FurnaceGUIRenderDX11::init(SDL_Window* win) {
+  return false;
+}
+
+void FurnaceGUIRenderDX11::initGUI(SDL_Window* win) {
+}
+
+bool FurnaceGUIRenderDX11::quit() {
+  return false;
+}
+
+void FurnaceGUIRenderDX11::quitGUI() { 
+}
+
+FurnaceGUIRenderDX11::~FurnaceGUIRenderDX11() {
+}

src/gui/render/renderDX11.h

@@ -0,0 +1,64 @@
+/**
+ * Furnace Tracker - multi-system chiptune tracker
+ * Copyright (C) 2021-2023 tildearrow and contributors
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "../gui.h"
+
+class FurnaceGUIRenderDX11: public FurnaceGUIRender {
+  ID3D11Device* device;
+  ID3D11DeviceContext* context;
+  ID3D11RenderTargetView* renderTarget;
+  SDL_Window* sdlWin;
+  IDXGISwapChain* swapchain;
+  float quadVertex[4][3];
+  unsigned int quadBuf;
+
+  void createRenderTarget();
+
+  public:
+    ImTextureID getTextureID(void* which);
+    bool lockTexture(void* which, void** data, int* pitch);
+    bool unlockTexture(void* which);
+    bool updateTexture(void* which, void* data, int pitch);
+    void* createTexture(bool dynamic, int width, int height);
+    bool destroyTexture(void* which);
+    void setTextureBlendMode(void* which, FurnaceGUIBlendMode mode);
+    void setBlendMode(FurnaceGUIBlendMode mode);
+    void clear(ImVec4 color);
+    bool newFrame();
+    void createFontsTexture();
+    void destroyFontsTexture();
+    void renderGUI();
+    void wipe(float alpha);
+    void present();
+    bool getOutputSize(int& w, int& h);
+    int getWindowFlags();
+    void preInit();
+    bool init(SDL_Window* win);
+    void initGUI(SDL_Window* win);
+    void quitGUI();
+    bool quit();
+    FurnaceGUIRenderDX11():
+      device(NULL),
+      context(NULL),
+      renderTarget(NULL),
+      sdlWin(NULL),
+      swapchain(NULL) {
+      memset(quadVertex,0,4*3*sizeof(float));
+    }
+};

src/gui/settings.cpp

@@ -1303,6 +1303,11 @@ void FurnaceGUI::drawSettings() {
               settings.renderBackend="SDL";
             }
 #endif
+#ifdef HAVE_RENDER_DX11
+            if (ImGui::Selectable("DirectX 11",curRenderBackend=="DirectX 11")) {
+              settings.renderBackend="DirectX 11";
+            }
+#endif
 #ifdef HAVE_RENDER_GL
             if (ImGui::Selectable("OpenGL",curRenderBackend=="OpenGL")) {
               settings.renderBackend="OpenGL";