[Vk] added VulkanWindowNull, that could be used as fake initial windo…

…w or for headless operations
OGRECave · Jun 3, 2022 · 10e32c8 · 10e32c8
1 parent 1871a53
commit 10e32c8
Show file tree

Hide file tree

Showing 15 changed files with 156 additions and 64 deletions.
diff --git a/RenderSystems/Vulkan/include/OgreVulkanPrerequisites.h b/RenderSystems/Vulkan/include/OgreVulkanPrerequisites.h
@@ -107,6 +107,7 @@ namespace Ogre
     class VulkanTextureGpuManager;
     class VulkanVaoManager;
     class VulkanWindow;
+    class VulkanWindowSwapChainBased;
     class VulkanDiscardBuffer;
     class VulkanDiscardBufferManager;
 

diff --git a/RenderSystems/Vulkan/include/OgreVulkanQueue.h b/RenderSystems/Vulkan/include/OgreVulkanQueue.h
@@ -113,7 +113,7 @@ namespace Ogre
         RefCountedFenceMap mRefCountedFences;
 
     public:
-        FastArray<VulkanWindow *> mWindowsPendingSwap;
+        FastArray<VulkanWindowSwapChainBased *> mWindowsPendingSwap;
 
     protected:
         FastArray<VkCommandBuffer> mPendingCmds;

diff --git a/RenderSystems/Vulkan/include/OgreVulkanTextureGpuManager.h b/RenderSystems/Vulkan/include/OgreVulkanTextureGpuManager.h
@@ -97,7 +97,7 @@ namespace Ogre
                                  VulkanDevice *device, bool bCanRestrictImageViewUsage );
         ~VulkanTextureGpuManager() override;
 
-        TextureGpu *createTextureGpuWindow( VulkanWindow *window );
+        TextureGpu *createTextureGpuWindow( VulkanWindowSwapChainBased *window );
         TextureGpu *createWindowDepthBuffer();
 
         VkImage getBlankTextureVulkanName( TextureTypes::TextureTypes textureType ) const;

diff --git a/RenderSystems/Vulkan/include/OgreVulkanTextureGpuWindow.h b/RenderSystems/Vulkan/include/OgreVulkanTextureGpuWindow.h
@@ -37,7 +37,7 @@ namespace Ogre
 {
     class _OgreVulkanExport VulkanTextureGpuWindow final : public VulkanTextureGpuRenderTarget
     {
-        VulkanWindow *mWindow;
+        VulkanWindowSwapChainBased *mWindow;
 
         uint32 mCurrentSwapchainIdx;
 
@@ -48,7 +48,7 @@ namespace Ogre
         VulkanTextureGpuWindow( GpuPageOutStrategy::GpuPageOutStrategy pageOutStrategy,
                                 VaoManager *vaoManager, IdString name, uint32 textureFlags,
                                 TextureTypes::TextureTypes initialType,
-                                TextureGpuManager *textureManager, VulkanWindow *window );
+                                TextureGpuManager *textureManager, VulkanWindowSwapChainBased *window );
         ~VulkanTextureGpuWindow() override;
 
         void setTextureType( TextureTypes::TextureTypes textureType ) override;

diff --git a/RenderSystems/Vulkan/include/OgreVulkanWindow.h b/RenderSystems/Vulkan/include/OgreVulkanWindow.h
@@ -36,18 +36,49 @@ namespace Ogre
 {
     class VulkanWindow : public Window
     {
+    protected:
+        VulkanDevice *mDevice;
+
+    public:
+        VulkanWindow( const String &title, uint32 width, uint32 height, bool fullscreenMode );
+
+        void _setDevice( VulkanDevice *device );
+        void _initialize( TextureGpuManager *textureGpuManager ) override;
+        virtual void _initialize( TextureGpuManager *textureGpuManager,
+                                  const NameValuePairList *miscParams ) = 0;
+    };
+
+    class VulkanWindowNull : public VulkanWindow
+    {
+    public:
+        VulkanWindowNull( const String &title, uint32 width, uint32 height, bool fullscreenMode );
+
+        void destroy() override;
+        void reposition( int32 leftPt, int32 topPt ) override;
+        bool isClosed() const override;
+        void _setVisible( bool visible ) override;
+        bool isVisible() const override;
+        void setHidden( bool hidden ) override;
+        bool isHidden() const override;
+        void _initialize( TextureGpuManager *textureGpuManager,
+                          const NameValuePairList *miscParams ) override;
+        void swapBuffers() override;
+    };
+
+    class VulkanWindowSwapChainBased : public VulkanWindow
+    {
     public:
         enum Backend
         {
             BackendX11 = 1u << 0u
         };
         enum SwapchainStatus
         {
-            /// We already called VulkanWindow::acquireNextSwapchain.
+            /// We already called VulkanWindowSwapChainBased::acquireNextSwapchain.
             ///
             /// Can only go into this state if we're coming from SwapchainReleased
             SwapchainAcquired,
-            /// We already called VulkanWindow::getImageAcquiredSemaphore.
+            /// We already called VulkanWindowSwapChainBased::getImageAcquiredSemaphore.
             /// Further calls to getImageAcquiredSemaphore will return null.
             /// Ogre is rendering or intends to into this swapchain.
             ///
@@ -66,8 +97,6 @@ namespace Ogre
         bool mHwGamma;
         bool mClosed;
 
-        VulkanDevice *mDevice;
-
         VkSurfaceKHR mSurfaceKHR;
         VkSwapchainKHR mSwapchain;
         FastArray<VkImage> mSwapchainImages;
@@ -89,16 +118,11 @@ namespace Ogre
         void acquireNextSwapchain();
 
     public:
-        VulkanWindow( const String &title, uint32 width, uint32 height, bool fullscreenMode );
-        ~VulkanWindow() override;
+        VulkanWindowSwapChainBased( const String &title, uint32 width, uint32 height, bool fullscreenMode );
+        ~VulkanWindowSwapChainBased() override;
 
         void destroy() override;
 
-        void _setDevice( VulkanDevice *device );
-        void _initialize( TextureGpuManager *textureGpuManager ) override;
-        virtual void _initialize( TextureGpuManager *textureGpuManager,
-                                  const NameValuePairList *miscParams ) = 0;
-
         /// Returns null if getImageAcquiredSemaphore has already been called during this frame
         VkSemaphore getImageAcquiredSemaphore();
 

diff --git a/RenderSystems/Vulkan/include/Windowing/Android/OgreVulkanAndroidWindow.h b/RenderSystems/Vulkan/include/Windowing/Android/OgreVulkanAndroidWindow.h
@@ -41,7 +41,7 @@ struct ANativeWindow;
 
 namespace Ogre
 {
-    class _OgreVulkanExport VulkanAndroidWindow final : public VulkanWindow
+    class _OgreVulkanExport VulkanAndroidWindow final : public VulkanWindowSwapChainBased
     {
         ANativeWindow *mNativeWindow;
 

diff --git a/RenderSystems/Vulkan/include/Windowing/X11/OgreVulkanXcbWindow.h b/RenderSystems/Vulkan/include/Windowing/X11/OgreVulkanXcbWindow.h
@@ -44,7 +44,7 @@ typedef uint32_t xcb_atom_t;
 
 namespace Ogre
 {
-    class _OgreVulkanExport VulkanXcbWindow : public VulkanWindow
+    class _OgreVulkanExport VulkanXcbWindow : public VulkanWindowSwapChainBased
     {
         xcb_connection_t *mConnection;
         xcb_screen_t *mScreen;

diff --git a/RenderSystems/Vulkan/include/Windowing/win32/OgreVulkanWin32Window.h b/RenderSystems/Vulkan/include/Windowing/win32/OgreVulkanWin32Window.h
@@ -34,7 +34,7 @@ Copyright (c) 2000-present Torus Knot Software Ltd
 
 namespace Ogre
 {
-    class VulkanWin32Window final : public VulkanWindow
+    class VulkanWin32Window final : public VulkanWindowSwapChainBased
     {
     private:
         HWND mHwnd;  // Win32 Window handle

diff --git a/RenderSystems/Vulkan/src/OgreVulkanRenderSystem.cpp b/RenderSystems/Vulkan/src/OgreVulkanRenderSystem.cpp
@@ -954,13 +954,30 @@ namespace Ogre
                                                      bool fullScreen,
                                                      const NameValuePairList *miscParams )
     {
+        String windowType;
+        if( miscParams )
+        {
+            // Get variable-length params
+            NameValuePairList::const_iterator opt = miscParams->find( "windowType" );
+            if( opt != miscParams->end() )
+                windowType = opt->second;
+        }
+
+        VulkanWindow *win = nullptr;
+        if( windowType == "Null" )
+        {
+            win = OGRE_NEW VulkanWindowNull( name, width, height, fullScreen );
+        }
+        else
+        {
 #if OGRE_PLATFORM == OGRE_PLATFORM_WIN32
-        VulkanWindow *win = OGRE_NEW VulkanWin32Window( name, width, height, fullScreen );
+            win = OGRE_NEW VulkanWin32Window( name, width, height, fullScreen );
 #elif OGRE_PLATFORM == OGRE_PLATFORM_ANDROID
-        VulkanWindow *win = OGRE_NEW VulkanAndroidWindow( name, width, height, fullScreen );
+            win = OGRE_NEW VulkanAndroidWindow( name, width, height, fullScreen );
 #else
-        VulkanWindow *win = OGRE_NEW VulkanXcbWindow( name, width, height, fullScreen );
+            win = OGRE_NEW VulkanXcbWindow( name, width, height, fullScreen );
 #endif
+        }
         mWindows.insert( win );
 
         if( !mInitialized )

diff --git a/RenderSystems/Vulkan/src/OgreVulkanTextureGpuManager.cpp b/RenderSystems/Vulkan/src/OgreVulkanTextureGpuManager.cpp
@@ -314,7 +314,7 @@ namespace Ogre
         }
     }
     //-----------------------------------------------------------------------------------
-    TextureGpu *VulkanTextureGpuManager::createTextureGpuWindow( VulkanWindow *window )
+    TextureGpu *VulkanTextureGpuManager::createTextureGpuWindow( VulkanWindowSwapChainBased *window )
     {
         return OGRE_NEW VulkanTextureGpuWindow( GpuPageOutStrategy::Discard, mVaoManager,
                                                 "RenderWindow",                      //

diff --git a/RenderSystems/Vulkan/src/OgreVulkanTextureGpuWindow.cpp b/RenderSystems/Vulkan/src/OgreVulkanTextureGpuWindow.cpp
@@ -47,7 +47,7 @@ namespace Ogre
     VulkanTextureGpuWindow::VulkanTextureGpuWindow(
         GpuPageOutStrategy::GpuPageOutStrategy pageOutStrategy, VaoManager *vaoManager, IdString name,
         uint32 textureFlags, TextureTypes::TextureTypes initialType, TextureGpuManager *textureManager,
-        VulkanWindow *window ) :
+        VulkanWindowSwapChainBased *window ) :
         VulkanTextureGpuRenderTarget( pageOutStrategy, vaoManager, name, textureFlags, initialType,
                                       textureManager ),
         mWindow( window ),