Feature: allow a toggle to enable/disable vsync

Vsync should be off by default, as for most players it will be
better to play without vsync. Exception exist, mainly people who
play in fullscreen mode.

6 files changed, 29 insertions, 10 deletions

diff --git a/src/video/sdl2_opengl_v.cpp b/src/video/sdl2_opengl_v.cpp
index 5df283751..08718a01e 100644
--- a/src/video/sdl2_opengl_v.cpp
+++ b/src/video/sdl2_opengl_v.cpp
@@ -70,8 +70,6 @@ const char *VideoDriver_SDL_OpenGL::Start(const StringList &param)
 	SDL_GetWindowSize(this->sdl_window, &w, &h);
 	this->ClientSizeChanged(w, h, true);
 
-	SDL_GL_SetSwapInterval(GetDriverParamBool(param, "vsync") ? 1 : 0);
-
 	return nullptr;
 }
 
@@ -91,6 +89,11 @@ void VideoDriver_SDL_OpenGL::DestroyContext()
 	}
 }
 
+void VideoDriver_SDL_OpenGL::ToggleVsync(bool vsync)
+{
+	SDL_GL_SetSwapInterval(vsync);
+}
+
 const char *VideoDriver_SDL_OpenGL::AllocateContext()
 {
 	SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 8);
@@ -107,6 +110,8 @@ const char *VideoDriver_SDL_OpenGL::AllocateContext()
 	this->gl_context = SDL_GL_CreateContext(this->sdl_window);
 	if (this->gl_context == nullptr) return "SDL2: Can't active GL context";
 
+	ToggleVsync(_video_vsync);
+
 	return OpenGLBackend::Create(&GetOGLProcAddressCallback);
 }
 
diff --git a/src/video/sdl2_opengl_v.h b/src/video/sdl2_opengl_v.h
index f749b1f45..c7e647ca8 100644
--- a/src/video/sdl2_opengl_v.h
+++ b/src/video/sdl2_opengl_v.h
@@ -29,6 +29,8 @@ public:
 	bool HasAnimBuffer() override { return true; }
 	uint8 *GetAnimBuffer() override { return this->anim_buffer; }
 
+	void ToggleVsync(bool vsync) override;
+
 	const char *GetName() const override { return "sdl-opengl"; }
 
 protected:
diff --git a/src/video/video_driver.cpp b/src/video/video_driver.cpp
index bee67e1ea..eaff0b741 100644
--- a/src/video/video_driver.cpp
+++ b/src/video/video_driver.cpp
@@ -21,6 +21,7 @@
 #include "video_driver.hpp"
 
 bool _video_hw_accel; ///< Whether to consider hardware accelerated video drivers.
+bool _video_vsync; ///< Whether we should use vsync (only if _video_hw_accel is enabled).
 
 void VideoDriver::GameLoop()
 {
diff --git a/src/video/video_driver.hpp b/src/video/video_driver.hpp
index 7a859565a..f143b61a8 100644
--- a/src/video/video_driver.hpp
+++ b/src/video/video_driver.hpp
@@ -28,6 +28,7 @@ extern std::vector<Dimension> _resolutions;
 extern Dimension _cur_resolution;
 extern bool _rightclick_emulate;
 extern bool _video_hw_accel;
+extern bool _video_vsync;
 
 /** The base of all video drivers. */
 class VideoDriver : public Driver {
@@ -67,6 +68,12 @@ public:
 	virtual bool ToggleFullscreen(bool fullscreen) = 0;
 
 	/**
+	 * Change the vsync setting.
+	 * @param vsync The new setting.
+	 */
+	virtual void ToggleVsync(bool vsync) {}
+
+	/**
 	 * Callback invoked after the blitter was changed.
 	 * @return True if no error.
 	 */
diff --git a/src/video/win32_v.cpp b/src/video/win32_v.cpp
index 426d74c0a..467478461 100644
--- a/src/video/win32_v.cpp
+++ b/src/video/win32_v.cpp
@@ -1290,7 +1290,6 @@ const char *VideoDriver_Win32OpenGL::Start(const StringList &param)
 	if (BlitterFactory::GetCurrentBlitter()->GetScreenDepth() == 0) return "Only real blitters supported";
 
 	Dimension old_res = _cur_resolution; // Save current screen resolution in case of errors, as MakeWindow invalidates it.
-	this->vsync = GetDriverParamBool(param, "vsync");
 
 	LoadWGLExtensions();
 
@@ -1335,6 +1334,15 @@ void VideoDriver_Win32OpenGL::DestroyContext()
 	}
 }
 
+void VideoDriver_Win32OpenGL::ToggleVsync(bool vsync)
+{
+	if (_wglSwapIntervalEXT != nullptr) {
+		_wglSwapIntervalEXT(vsync);
+	} else if (vsync) {
+		DEBUG(driver, 0, "OpenGL: Vsync requested, but not supported by driver");
+	}
+}
+
 const char *VideoDriver_Win32OpenGL::AllocateContext()
 {
 	this->dc = GetDC(this->main_wnd);
@@ -1363,12 +1371,7 @@ const char *VideoDriver_Win32OpenGL::AllocateContext()
 	}
 	if (!wglMakeCurrent(this->dc, rc)) return "Can't active GL context";
 
-	/* Enable/disable Vsync if supported. */
-	if (_wglSwapIntervalEXT != nullptr) {
-		_wglSwapIntervalEXT(this->vsync ? 1 : 0);
-	} else if (vsync) {
-		DEBUG(driver, 0, "OpenGL: Vsync requested, but not supported by driver");
-	}
+	this->ToggleVsync(_video_vsync);
 
 	this->gl_rc = rc;
 	return OpenGLBackend::Create(&GetOGLProcAddressCallback);
diff --git a/src/video/win32_v.h b/src/video/win32_v.h
index f6ca291f1..8c63aeedf 100644
--- a/src/video/win32_v.h
+++ b/src/video/win32_v.h
@@ -138,12 +138,13 @@ public:
 	bool HasAnimBuffer() override { return true; }
 	uint8 *GetAnimBuffer() override { return this->anim_buffer; }
 
+	void ToggleVsync(bool vsync) override;
+
 	const char *GetName() const override { return "win32-opengl"; }
 
 protected:
 	HDC    dc;          ///< Window device context.
 	HGLRC  gl_rc;       ///< OpenGL context.
-	bool   vsync;       ///< Enable VSync?
 	uint8 *anim_buffer; ///< Animation buffer from OpenGL back-end.
 
 	uint8 GetFullscreenBpp() override { return 32; } // OpenGL is always 32 bpp.