Add RenderSystem::isDeviceLost()

OGRECave · Dec 26, 2024 · a3df89c · a3df89c
1 parent f08ef1d
commit a3df89c
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 2 deletions.
diff --git a/OgreMain/include/OgreRenderSystem.h b/OgreMain/include/OgreRenderSystem.h
@@ -287,8 +287,23 @@ namespace Ogre
          */
         virtual void shutdown();
 
-        /** Some render systems have moments when GPU device is temporarily unavailable,
-            for example when D3D11 device is lost, or when iOS app is in background, etc.
+        /** Returns true if device was lost and the application should destroy and recreate
+            the device and all device depended resources using validateDevice() call. Note,
+            that initial device lost condition detection is asynchronous, and can be reported
+            by any 3D API call, resulting in RenderingApiException that should be catched.
+            Device lost conditions are reported by 3D APIs as
+            - Direct3D 9: D3DERR_DEVICELOST
+            - Direct3D 10+: DXGI_ERROR_DEVICE_REMOVED/_RESET/_HUNG/etc
+            - Vulkan: VK_ERROR_DEVICE_LOST
+            - OpenGL[ES]: GL_CONTEXT_LOST
+            - Metal: MTLCommandBufferErrorDeviceRemoved/AccessRevoked, MTLDeviceWasRemovedNotification
+         */
+        virtual bool isDeviceLost() { return false; }
+
+        /** Checks if device was lost and recreates it with all depended resources.
+            Optionally elects best physical device even if current device was not lost.
+            Without forceDeviceElection param this function is pretty lightweight
+            and is automatically called by Ogre on start of each frame.
          */
         virtual bool validateDevice( bool forceDeviceElection = false ) { return true; }
 

diff --git a/RenderSystems/Direct3D11/include/OgreD3D11RenderSystem.h b/RenderSystems/Direct3D11/include/OgreD3D11RenderSystem.h
@@ -221,6 +221,7 @@ namespace Ogre
 
         void              reinitialise() override;
         void              shutdown() override;
+        bool              isDeviceLost() override;
         bool              validateDevice( bool forceDeviceElection = false ) override;
         void              handleDeviceLost();
         void              setShadingType( ShadeOptions so );

diff --git a/RenderSystems/Direct3D11/src/OgreD3D11RenderSystem.cpp b/RenderSystems/Direct3D11/src/OgreD3D11RenderSystem.cpp
@@ -1764,6 +1764,8 @@ namespace Ogre
                                                StringConverter::toString( passedTime ) + "ms" );
     }
     //---------------------------------------------------------------------
+    bool D3D11RenderSystem::isDeviceLost() { return !mDevice.isNull() && mDevice.IsDeviceLost(); }
+    //---------------------------------------------------------------------
     bool D3D11RenderSystem::validateDevice( bool forceDeviceElection )
     {
         if( mDevice.isNull() )

diff --git a/RenderSystems/Vulkan/include/OgreVulkanRenderSystem.h b/RenderSystems/Vulkan/include/OgreVulkanRenderSystem.h
@@ -156,6 +156,7 @@ namespace Ogre
         void shutdown() override;
         const FastArray<VulkanPhysicalDevice> &getVulkanPhysicalDevices() const;
         const VulkanPhysicalDevice &getActiveVulkanPhysicalDevice() const { return mActiveDevice; }
+        bool isDeviceLost() override;
         bool validateDevice( bool forceDeviceElection = false ) override;
         void handleDeviceLost();
 

diff --git a/RenderSystems/Vulkan/src/OgreVulkanRenderSystem.cpp b/RenderSystems/Vulkan/src/OgreVulkanRenderSystem.cpp
@@ -1279,6 +1279,8 @@ namespace Ogre
     {
         return mInstance->mVulkanPhysicalDevices;
     }
+    //---------------------------------------------------------------------
+    bool VulkanRenderSystem::isDeviceLost() { return mDevice && mDevice->isDeviceLost(); }
     //-------------------------------------------------------------------------
     bool VulkanRenderSystem::validateDevice( bool forceDeviceElection )
     {