Rework the native scale handling for new MoltenVK

Author: deveee

lib/graphics_engine/include/ge_vulkan_driver.hpp

@@ -86,9 +86,6 @@ namespace GE
         //! sets a viewport
         virtual void setViewPort(const core::rect<s32>& area);
 
-        //! gets the area of the current viewport
-        virtual const core::rect<s32>& getViewPort() const { return m_viewport; }
-
         //! updates hardware buffer if needed
         virtual bool updateHardwareBuffer(SHWBufferLink *HWBuffer) { return false; }
 
@@ -369,7 +366,7 @@ namespace GE
                                               { return m_separate_rtt_texture; }
         void handleDeletedTextures();
         void addRTTPolyCount(unsigned count)       { m_rtt_polycount += count; }
-        SDL_Window* getSDLWindow() const                    { return m_window; }
+        SDL_Window* getSDLWindow() const       { return m_params.m_sdl_window; }
         void clearDrawCallsCache();
         void addDrawCallToCache(std::unique_ptr<GEVulkanDrawCall>& dc);
         std::unique_ptr<GEVulkanDrawCall> getDrawCallFromCache();
@@ -506,13 +503,11 @@ namespace GE
         uint32_t m_image_index;
         video::SColor m_clear_color, m_rtt_clear_color;
         core::rect<s32> m_clip;
-        core::rect<s32> m_viewport;
         core::matrix4 m_pre_rotation_matrix;
 
         video::ITexture* m_white_texture;
         video::ITexture* m_transparent_texture;
 
-        SDL_Window* m_window;
         bool m_disable_wait_idle;
 
         IrrlichtDevice* m_irrlicht_device;

lib/graphics_engine/src/ge_vulkan_driver.cpp

@@ -531,7 +531,6 @@ GEVulkanDriver::GEVulkanDriver(const SIrrlichtCreationParameters& params,
     m_transparent_texture = NULL;
     m_pre_rotation_matrix = core::matrix4(core::matrix4::EM4CONST_IDENTITY);
 
-    m_window = window;
     m_disable_wait_idle = false;
     g_schedule_pausing_rendering.store(false);
     g_paused_rendering.store(false);
@@ -569,10 +568,6 @@ GEVulkanDriver::GEVulkanDriver(const SIrrlichtCreationParameters& params,
 
     if (SDL_Vulkan_CreateSurface(window, m_vk->instance, &m_vk->surface) == SDL_FALSE)
         throw std::runtime_error("SDL_Vulkan_CreateSurface failed");
-    int w, h = 0;
-    SDL_Vulkan_GetDrawableSize(window, &w, &h);
-    ScreenSize.Width = w;
-    ScreenSize.Height = h;
 
     m_device_extensions.push_back(VK_KHR_SWAPCHAIN_EXTENSION_NAME);
     findPhysicalDevice();
@@ -1242,7 +1237,7 @@ void GEVulkanDriver::createSwapChain()
     }
 
     int w, h = 0;
-    SDL_Vulkan_GetDrawableSize(m_window, &w, &h);
+    SDL_Vulkan_GetDrawableSize(m_params.m_sdl_window, &w, &h);
     VkExtent2D max_extent = m_surface_capabilities.maxImageExtent;
     VkExtent2D min_extent = m_surface_capabilities.minImageExtent;
     VkExtent2D actual_extent =
@@ -1252,6 +1247,11 @@ void GEVulkanDriver::createSwapChain()
         std::max(
             std::min((unsigned)h, max_extent.height), min_extent.height)
     };
+#if defined(__APPLE__)
+    // MoltenVK stores the correctly rounded, high-dpi screen size in
+    // currentExtent using half-to-even rounding
+    actual_extent = m_surface_capabilities.currentExtent;
+#endif
 
     VkSwapchainCreateInfoKHR create_info = {};
     create_info.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR;
@@ -1684,6 +1684,7 @@ void GEVulkanDriver::copyBuffer(VkBuffer src_buffer, VkBuffer dst_buffer,
 // ----------------------------------------------------------------------------
 void GEVulkanDriver::OnResize(const core::dimension2d<u32>& size)
 {
+    m_params.WindowSize = size;
     CNullDriver::OnResize(size);
     if (g_paused_rendering.load() == false)
     {
@@ -2210,7 +2211,7 @@ void GEVulkanDriver::setViewPort(const core::rect<s32>& area)
     vp.clipAgainst(rendert);
     if (vp.getHeight() > 0 && vp.getWidth() > 0)
     {
-        m_viewport = vp;
+        ViewPort = vp;
         if (m_irrlicht_device->getSceneManager() &&
             m_irrlicht_device->getSceneManager()->getActiveCamera())
         {
@@ -2363,7 +2364,7 @@ void GEVulkanDriver::createSwapChainRelated(bool handle_surface)
     waitIdle();
     if (handle_surface)
     {
-        if (SDL_Vulkan_CreateSurface(m_window, m_vk->instance, &m_vk->surface) == SDL_FALSE)
+        if (SDL_Vulkan_CreateSurface(m_params.m_sdl_window, m_vk->instance, &m_vk->surface) == SDL_FALSE)
             throw std::runtime_error("SDL_Vulkan_CreateSurface failed");
     }
     updateSurfaceInformation(m_physical_device, &m_surface_capabilities,

lib/irrlicht/include/SIrrCreationParameters.h

@@ -14,6 +14,8 @@
 
 #if !defined(SERVER_ONLY) && defined(_IRR_COMPILE_WITH_SDL_DEVICE_)
 #include "SDL_video.h"
+#else
+#define SDL_Window void
 #endif
 
 namespace irr
@@ -58,7 +60,9 @@ namespace irr
 			UsePerformanceTimer(true),
             ForceLegacyDevice(false),
             ShadersPath(""),
-			SDK_version_do_not_use(IRRLICHT_SDK_VERSION)
+			SDK_version_do_not_use(IRRLICHT_SDK_VERSION),
+			PrivateData(NULL),
+			m_sdl_window(NULL)
 		{
 		}
 
@@ -94,6 +98,7 @@ namespace irr
             ShadersPath = other.ShadersPath;
 			PrivateData = other.PrivateData;
 			WindowPosition = other.WindowPosition;
+			m_sdl_window = other.m_sdl_window;
 			return *this;
 		}
 
@@ -327,6 +332,7 @@ namespace irr
 		Java RE. */
 		void *PrivateData;
 
+		SDL_Window* m_sdl_window;
 	};
 
 

lib/irrlicht/source/Irrlicht/CIrrDeviceSDL.cpp

@@ -69,8 +69,7 @@ CIrrDeviceSDL::CIrrDeviceSDL(const SIrrlichtCreationParameters& param)
 	TopPadding(0), BottomPadding(0), LeftPadding(0), RightPadding(0),
 	InitialOrientation(0), WindowHasFocus(false), WindowMinimized(false),
 	Resizable(false), AccelerometerIndex(-1), AccelerometerInstance(-1),
-	GyroscopeIndex(-1), GyroscopeInstance(-1), NativeScaleX(1.0f),
-	NativeScaleY(1.0f)
+	GyroscopeIndex(-1), GyroscopeInstance(-1)
 {
 	#ifdef _DEBUG
 	setDebugName("CIrrDeviceSDL");
@@ -187,11 +186,6 @@ CIrrDeviceSDL::CIrrDeviceSDL(const SIrrlichtCreationParameters& param)
 		}
 		else
 			return;
-		updateNativeScale(&Width, &Height);
-		Width = (u32)((f32)Width * NativeScaleX);
-		Height = (u32)((f32)Height * NativeScaleY);
-		CreationParams.WindowSize.Width = Width;
-		CreationParams.WindowSize.Height = Height;
 	}
 
 	// create cursor control
@@ -213,30 +207,6 @@ CIrrDeviceSDL::CIrrDeviceSDL(const SIrrlichtCreationParameters& param)
 }
 
 
-void CIrrDeviceSDL::updateNativeScale(u32* saving_width, u32* saving_height)
-{
-	int width, height = 0;
-	SDL_GetWindowSize(Window, &width, &height);
-	int real_width = width;
-	int real_height = height;
-	if (CreationParams.DriverType == video::EDT_OPENGL ||
-		CreationParams.DriverType == video::EDT_OGLES2)
-	{
-		SDL_GL_GetDrawableSize(Window, &real_width, &real_height);
-	}
-	else if (CreationParams.DriverType == video::EDT_VULKAN)
-	{
-		SDL_Vulkan_GetDrawableSize(Window, &real_width, &real_height);
-	}
-	NativeScaleX = (f32)real_width / (f32)width;
-	NativeScaleY = (f32)real_height / (f32)height;
-	if (saving_width)
-		*saving_width = width;
-	if (saving_height)
-		*saving_height = height;
-}
-
-
 //! destructor
 CIrrDeviceSDL::~CIrrDeviceSDL()
 {
@@ -422,6 +392,7 @@ extern "C" void update_swap_interval(int swap_interval)
 
 bool CIrrDeviceSDL::createWindow()
 {
+	CreationParams.m_sdl_window = NULL;
 	// Ignore alpha size here, this follow irr_driver.cpp:450
 	// Try 32 and, upon failure, 24 then 16 bit per pixels
 	if (CreationParams.DriverType == video::EDT_OPENGL ||
@@ -520,6 +491,7 @@ bool CIrrDeviceSDL::createWindow()
 			return false;
 		}
 	}
+	CreationParams.m_sdl_window = Window;
 	return true;
 }
 
@@ -723,10 +695,6 @@ void CIrrDeviceSDL::createDriver()
 		try
 		{
 			VideoDriver = video::createVulkanDriver(CreationParams, FileSystem, Window, this);
-			// SDL_Vulkan_GetDrawableSize only works after driver is created
-			updateNativeScale(&Width, &Height);
-			Width = (u32)((f32)Width * NativeScaleX);
-			Height = (u32)((f32)Height * NativeScaleY);
 		}
 		catch (std::exception& e)
 		{
@@ -845,8 +813,8 @@ bool CIrrDeviceSDL::run()
 			irrevent.TouchInput.ID = getTouchId(SDL_event.tfinger.fingerId);
 			if (SDL_event.type == SDL_FINGERUP)
 				removeTouchId(SDL_event.tfinger.fingerId);
-			irrevent.TouchInput.X = SDL_event.tfinger.x * Width;
-			irrevent.TouchInput.Y = SDL_event.tfinger.y * Height;
+			irrevent.TouchInput.X = SDL_event.tfinger.x * getRealScreenSize().Width;
+			irrevent.TouchInput.Y = SDL_event.tfinger.y * getRealScreenSize().Height;
 			postEventFromUser(irrevent);
 			break;
 
@@ -871,8 +839,8 @@ bool CIrrDeviceSDL::run()
 		case SDL_MOUSEMOTION:
 			irrevent.EventType = irr::EET_MOUSE_INPUT_EVENT;
 			irrevent.MouseInput.Event = irr::EMIE_MOUSE_MOVED;
-			MouseX = irrevent.MouseInput.X = SDL_event.motion.x * NativeScaleX;
-			MouseY = irrevent.MouseInput.Y = SDL_event.motion.y * NativeScaleY;
+			MouseX = irrevent.MouseInput.X = SDL_event.motion.x * getNativeScaleX();
+			MouseY = irrevent.MouseInput.Y = SDL_event.motion.y * getNativeScaleY();
 			irrevent.MouseInput.ButtonStates = MouseButtonStates;
 
 			postEventFromUser(irrevent);
@@ -882,8 +850,8 @@ bool CIrrDeviceSDL::run()
 		case SDL_MOUSEBUTTONUP:
 
 			irrevent.EventType = irr::EET_MOUSE_INPUT_EVENT;
-			irrevent.MouseInput.X = SDL_event.button.x * NativeScaleX;
-			irrevent.MouseInput.Y = SDL_event.button.y * NativeScaleY;
+			irrevent.MouseInput.X = SDL_event.button.x * getNativeScaleX();
+			irrevent.MouseInput.Y = SDL_event.button.y * getNativeScaleY();
 
 			irrevent.MouseInput.Event = irr::EMIE_MOUSE_MOVED;
 
@@ -1060,13 +1028,10 @@ bool CIrrDeviceSDL::run()
 
 void CIrrDeviceSDL::handleNewSize(u32 width, u32 height)
 {
-	updateNativeScale();
-	u32 new_width = width * NativeScaleX;
-	u32 new_height = height * NativeScaleY;
-	if (new_width != Width || new_height != Height)
+	if (width != Width || height != Height)
 	{
-		Width = new_width;
-		Height = new_height;
+		Width = width;
+		Height = height;
 		if (VideoDriver)
 			VideoDriver->OnResize(core::dimension2d<u32>(Width, Height));
 		reset_network_body();
@@ -1597,7 +1562,7 @@ extern "C" int Android_getMovedHeight();
 s32 CIrrDeviceSDL::getMovedHeight() const
 {
 #if defined(IOS_STK)
-	return SDL_GetMovedHeightByScreenKeyboard() * NativeScaleY;
+	return SDL_GetMovedHeightByScreenKeyboard() * getNativeScaleY();
 #elif defined(ANDROID)
 	return Android_getMovedHeight();
 #else
@@ -1610,7 +1575,7 @@ extern "C" int Android_getKeyboardHeight();
 u32 CIrrDeviceSDL::getOnScreenKeyboardHeight() const
 {
 #if defined(IOS_STK)
-	return SDL_GetScreenKeyboardHeight() * NativeScaleY;
+	return SDL_GetScreenKeyboardHeight() * getNativeScaleY();
 #elif defined(ANDROID)
 	return Android_getKeyboardHeight();
 #else
@@ -1621,13 +1586,17 @@ u32 CIrrDeviceSDL::getOnScreenKeyboardHeight() const
 
 f32 CIrrDeviceSDL::getNativeScaleX() const
 {
-	return NativeScaleX;
+	if (VideoDriver)
+		return (f32)VideoDriver->getScreenSize().Width / (f32)Width;
+	return 1.0f;
 }
 
 
 f32 CIrrDeviceSDL::getNativeScaleY() const
 {
-	return NativeScaleY;
+	if (VideoDriver)
+		return (f32)VideoDriver->getScreenSize().Height / (f32)Height;
+	return 1.0f;
 }
 
 
@@ -1701,6 +1670,15 @@ void CIrrDeviceSDL::createGUIAndVulkanScene()
 }
 
 
+const core::dimension2du& CIrrDeviceSDL::getRealScreenSize() const
+{
+	static core::dimension2du ss;
+	if (VideoDriver)
+		return VideoDriver->getScreenSize();
+	return ss;
+}
+
+
 } // end namespace irr
 
 #endif // _IRR_COMPILE_WITH_SDL_DEVICE_

lib/irrlicht/source/Irrlicht/CIrrDeviceSDL.h

@@ -182,7 +182,7 @@ class MoltenVK;
 			//! Sets the new position of the cursor.
 			virtual void setPosition(f32 x, f32 y)
 			{
-				setPosition((s32)(x*Device->Width), (s32)(y*Device->Height));
+				setPosition((s32)(x*Device->getRealScreenSize().Width), (s32)(y*Device->getRealScreenSize().Height));
 			}
 
 			//! Sets the new position of the cursor.
@@ -208,8 +208,8 @@ class MoltenVK;
 			virtual core::position2d<f32> getRelativePosition()
 			{
 				updateCursorPos();
-				return core::position2d<f32>(CursorPos.X / (f32)Device->Width,
-					CursorPos.Y / (f32)Device->Height);
+				return core::position2d<f32>(CursorPos.X / (f32)Device->getRealScreenSize().Width,
+					CursorPos.Y / (f32)Device->getRealScreenSize().Height);
 			}
 
 			virtual void setReferenceRect(core::rect<s32>* rect=0)
@@ -225,12 +225,12 @@ class MoltenVK;
 
 				if (CursorPos.X < 0)
 					CursorPos.X = 0;
-				if (CursorPos.X > (s32)Device->Width)
-					CursorPos.X = Device->Width;
+				if (CursorPos.X > (s32)Device->getRealScreenSize().Width)
+					CursorPos.X = Device->getRealScreenSize().Width;
 				if (CursorPos.Y < 0)
 					CursorPos.Y = 0;
-				if (CursorPos.Y > (s32)Device->Height)
-					CursorPos.Y = Device->Height;
+				if (CursorPos.Y > (s32)Device->getRealScreenSize().Height)
+					CursorPos.Y = Device->getRealScreenSize().Height;
 			}
 
 			CIrrDeviceSDL* Device;
@@ -305,8 +305,6 @@ class MoltenVK;
 		s32 GyroscopeIndex;
 		s32 GyroscopeInstance;
 
-		f32 NativeScaleX, NativeScaleY;
-
 		struct SKeyMap
 		{
 			SKeyMap() {}
@@ -332,7 +330,7 @@ class MoltenVK;
 		MoltenVK* m_moltenvk;
 #endif
 		void createGUIAndVulkanScene();
-		void updateNativeScale(u32* saving_width = NULL, u32* saving_height = NULL);
+		const core::dimension2du& getRealScreenSize() const;
 	};
 
 } // end namespace irr