cpp/openttd-patchpack/source Changeset - r24851:a41e925d9dc7

Changeset - r24851:a41e925d9dc7

Parent rev.

Child rev.

[Not reviewed]

master

0 11 0

Patric Stout - 3 years ago 2021-02-20 10:08:20
truebrain@openttd.org

Codechange: be consistent in naming the paint function Paint()

Also move this function to be a class member. This to allow
further deduplicating of code in a later commit.

11 files changed with 58 insertions and 23 deletions:

src/video/allegro_v.cpp

src/video/allegro_v.h

src/video/cocoa/cocoa_v.h

src/video/cocoa/cocoa_v.mm

src/video/sdl2_v.cpp

src/video/sdl2_v.h

src/video/sdl_v.cpp

src/video/sdl_v.h

src/video/video_driver.hpp

src/video/win32_v.cpp

src/video/win32_v.h

0 comments (0 inline, 0 general)

src/video/allegro_v.cpp

➞

Show inline comments

@@ @@ -53,13 +53,13 @@ void VideoDriver_Allegro::MakeDirty(int @@
 		_dirty_rects[_num_dirty_rects].width = width;
 		_dirty_rects[_num_dirty_rects].height = height;
+	}
 	_num_dirty_rects++;
+}
-static void DrawSurfaceToScreen()
+void VideoDriver_Allegro::Paint()
+{
 	PerformanceMeasurer framerate(PFE_VIDEO);
 	int n = _num_dirty_rects;
 	if (n == 0) return;
@@ @@ -521,13 +521,13 @@ void VideoDriver_Allegro::MainLoop() @@
 			this->InputLoop();
 			::InputLoop();
 			UpdateWindows();
 			CheckPaletteAnim();
-			DrawSurfaceToScreen();
+			this->Paint();
+		}
 		/* If we are not in fast-forward, create some time between calls to ease up CPU usage. */
 		if (!_fast_forward || _pause_mode) {
 			/* See how much time there is till we have to process the next event, and try to hit that as close as possible. */
 			auto next_tick = std::min(next_draw_tick, next_game_tick);

src/video/allegro_v.h

➞

Show inline comments

@@ @@ -32,12 +32,13 @@ public: @@
 	bool ClaimMousePointer() override;
 	const char *GetName() const override { return "allegro"; }
 protected:
 	void InputLoop() override;
 	void Paint() override;
 };
 /** Factory for the allegro video driver. */
 class FVideoDriver_Allegro : public DriverFactoryBase {
 public:
 	FVideoDriver_Allegro() : DriverFactoryBase(Driver::DT_VIDEO, 4, "allegro", "Allegro Video Driver") {}

src/video/cocoa/cocoa_v.h

➞

Show inline comments

@@ @@ -72,12 +72,13 @@ public: @@
 	void AllocateBackingStore();
 protected:
 	Dimension GetScreenSize() const override;
 	float GetDPIScale() override;
 	void InputLoop() override;
 	void Paint() override;
 private:
 	bool PollEvent();
 	bool IsFullscreen();
 	void GameSizeChanged();
@@ @@ -86,13 +87,12 @@ private: @@
 	bool MakeWindow(int width, int height);
 	void UpdatePalette(uint first_color, uint num_colors);
 	void CheckPaletteAnim();
 	void Draw(bool force_update = false);
 	void BlitIndexedToView32(int left, int top, int right, int bottom);
 };
 class FVideoDriver_Cocoa : public DriverFactoryBase {
 public:
 	FVideoDriver_Cocoa() : DriverFactoryBase(Driver::DT_VIDEO, 10, "cocoa", "Cocoa Video Driver") {}

src/video/cocoa/cocoa_v.mm

➞

Show inline comments

@@ @@ -462,16 +462,16 @@ void VideoDriver_Cocoa::BlitIndexedToVie @@
 			dst[y * pitch + x] = pal[src[y * width + x]];
+		}
+	}
+}
 /**
- * Draw window.
+ * Paint window.
  * @param force_update Whether to redraw unconditionally
  */
-void VideoDriver_Cocoa::Draw(bool force_update)
+void VideoDriver_Cocoa::Paint()
+{
 	PerformanceMeasurer framerate(PFE_VIDEO);
 	/* Check if we need to do anything */
 	if (this->num_dirty_rects == 0 || [ this->window isMiniaturized ]) return;
@@ @@ -499,15 +499,14 @@ void VideoDriver_Cocoa::Draw(bool force_ @@
 		dirtyrect.origin.x = this->dirty_rects[i].left;
 		dirtyrect.origin.y = this->window_height - this->dirty_rects[i].bottom;
 		dirtyrect.size.width = this->dirty_rects[i].right - this->dirty_rects[i].left;
 		dirtyrect.size.height = this->dirty_rects[i].bottom - this->dirty_rects[i].top;
 		/* Normally drawRect will be automatically called by Mac OS X during next update cycle,
-		 * and then blitting will occur. If force_update is true, it will be done right now. */
 		 * and then blitting will occur. */
 		[ this->cocoaview setNeedsDisplayInRect:[ this->cocoaview getVirtualRect:dirtyrect ] ];
 		if (force_update) [ this->cocoaview displayIfNeeded ];
+	}
 	this->num_dirty_rects = 0;
+}
 /** Update the palette. */
@@ @@ -705,13 +704,13 @@ void VideoDriver_Cocoa::GameLoop() @@
 				this->InputLoop();
 				::InputLoop();
 				UpdateWindows();
 				this->CheckPaletteAnim();
-				this->Draw();
+				this->Paint();
+			}
 			/* If we are not in fast-forward, create some time between calls to ease up CPU usage. */
 			if (!_fast_forward || _pause_mode) {
 				/* See how much time there is till we have to process the next event, and try to hit that as close as possible. */
 				auto next_tick = std::min(next_draw_tick, next_game_tick);

src/video/sdl2_v.cpp

➞

Show inline comments

@@ @@ -121,13 +121,13 @@ void VideoDriver_SDL::CheckPaletteAnim() @@
 	if (_cur_palette.count_dirty == 0) return;
 	_local_palette = _cur_palette;
 	this->MakeDirty(0, 0, _screen.width, _screen.height);
+}
-static void Paint()
+void VideoDriver_SDL::Paint()
+{
 	PerformanceMeasurer framerate(PFE_VIDEO);
 	if (IsEmptyRect(_dirty_rect) && _cur_palette.count_dirty == 0) return;
 	if (_cur_palette.count_dirty != 0) {
@@ @@ -158,28 +158,33 @@ static void Paint() @@
+	}
 	SDL_UpdateWindowSurfaceRects(_sdl_window, &r, 1);
 	MemSetT(&_dirty_rect, 0);
+}
-static void PaintThread()
+void VideoDriver_SDL::PaintThread()
+{
 	/* First tell the main thread we're started */
 	std::unique_lock<std::recursive_mutex> lock(*_draw_mutex);
 	_draw_signal->notify_one();
 	/* Now wait for the first thing to draw! */
 	_draw_signal->wait(*_draw_mutex);
 	while (_draw_continue) {
 		/* Then just draw and wait till we stop */
 		Paint();
+		this->Paint();
 		_draw_signal->wait(lock);
+	}
+}
 /* static */ void VideoDriver_SDL::PaintThreadThunk(VideoDriver_SDL *drv)
+{
 	drv->PaintThread();
+}
 static const Dimension default_resolutions[] = {
 	{  640,  480 },
 	{  800,  600 },
 	{ 1024,  768 },
 	{ 1152,  864 },
 	{ 1280,  800 },
@@ @@ -817,13 +822,13 @@ void VideoDriver_SDL::LoopOnce() @@
 		UpdateWindows();
 		this->CheckPaletteAnim();
 		if (_draw_mutex != nullptr && !HasModalProgress()) {
 			_draw_signal->notify_one();
 		} else {
 			Paint();
+			this->Paint();
+		}
+	}
 /* Emscripten is running an event-based mainloop; there is already some
  * downtime between each iteration, so no need to sleep. */
 #ifndef __EMSCRIPTEN__
@@ @@ -858,13 +863,13 @@ void VideoDriver_SDL::MainLoop() @@
 			_draw_threaded = false;
 		} else {
 			draw_lock = std::unique_lock<std::recursive_mutex>(*_draw_mutex);
 			_draw_signal = new std::condition_variable_any();
 			_draw_continue = true;
-			_draw_threaded = StartNewThread(&draw_thread, "ottd:draw-sdl", &PaintThread);
+			_draw_threaded = StartNewThread(&draw_thread, "ottd:draw-sdl", &VideoDriver_SDL::PaintThreadThunk, this);
 			/* Free the mutex if we won't be able to use it. */
 			if (!_draw_threaded) {
 				draw_lock.unlock();
 				draw_lock.release();
 				delete _draw_mutex;

src/video/sdl2_v.h

➞

Show inline comments

@@ @@ -43,12 +43,14 @@ public: @@
 protected:
 	Dimension GetScreenSize() const override;
 	void InputLoop() override;
 	bool LockVideoBuffer() override;
 	void UnlockVideoBuffer() override;
 	void Paint() override;
 	void PaintThread() override;
 private:
 	int PollEvent();
 	void LoopOnce();
 	void MainLoopCleanup();
 	bool CreateMainSurface(uint w, uint h, bool resize);
@@ @@ -70,12 +72,14 @@ private: @@
 	std::chrono::steady_clock::time_point next_game_tick;
 	std::chrono::steady_clock::time_point next_draw_tick;
 	int startup_display;
 	std::thread draw_thread;
 	std::unique_lock<std::recursive_mutex> draw_lock;
 	static void PaintThreadThunk(VideoDriver_SDL *drv);
 };
 /** Factory for the SDL video driver. */
 class FVideoDriver_SDL : public DriverFactoryBase {
 public:
 	FVideoDriver_SDL() : DriverFactoryBase(Driver::DT_VIDEO, 5, "sdl", "SDL Video Driver") {}

src/video/sdl_v.cpp

➞

Show inline comments

@@ @@ -144,13 +144,13 @@ static void CheckPaletteAnim() @@
 				NOT_REACHED();
+		}
 		_cur_palette.count_dirty = 0;
+	}
+}
-static void DrawSurfaceToScreen()
+void VideoDriver_SDL::Paint()
+{
 	PerformanceMeasurer framerate(PFE_VIDEO);
 	int n = _num_dirty_rects;
 	if (n == 0) return;
@@ @@ -170,29 +170,34 @@ static void DrawSurfaceToScreen() @@
+		}
 		SDL_UpdateRects(_sdl_realscreen, n, _dirty_rects);
+	}
+}
-static void DrawSurfaceToScreenThread()
+void VideoDriver_SDL::PaintThread()
+{
 	/* First tell the main thread we're started */
 	std::unique_lock<std::recursive_mutex> lock(*_draw_mutex);
 	_draw_signal->notify_one();
 	/* Now wait for the first thing to draw! */
 	_draw_signal->wait(*_draw_mutex);
 	while (_draw_continue) {
 		CheckPaletteAnim();
 		/* Then just draw and wait till we stop */
-		DrawSurfaceToScreen();
+		this->Paint();
 		_draw_signal->wait(lock);
+	}
+}
 /* static */ void VideoDriver_SDL::PaintThreadThunk(VideoDriver_SDL *drv)
+{
 	drv->PaintThread();
+}
 static const Dimension _default_resolutions[] = {
 	{ 640,  480},
 	{ 800,  600},
 	{1024,  768},
 	{1152,  864},
 	{1280,  800},
@@ @@ -714,13 +719,13 @@ void VideoDriver_SDL::MainLoop() @@
 			_draw_threaded = false;
 		} else {
 			this->draw_lock = std::unique_lock<std::recursive_mutex>(*_draw_mutex);
 			_draw_signal = new std::condition_variable_any();
 			_draw_continue = true;
-			_draw_threaded = StartNewThread(&draw_thread, "ottd:draw-sdl", &DrawSurfaceToScreenThread);
+			_draw_threaded = StartNewThread(&draw_thread, "ottd:draw-sdl", &VideoDriver_SDL::PaintThreadThunk, this);
 			/* Free the mutex if we won't be able to use it. */
 			if (!_draw_threaded) {
 				this->draw_lock.unlock();
 				this->draw_lock.release();
 				delete _draw_mutex;
@@ @@ -779,13 +784,13 @@ void VideoDriver_SDL::MainLoop() @@
 			_local_palette = _cur_palette;
 			if (_draw_mutex != nullptr && !HasModalProgress()) {
 				_draw_signal->notify_one();
 			} else {
 				CheckPaletteAnim();
-				DrawSurfaceToScreen();
+				this->Paint();
+			}
+		}
 		/* If we are not in fast-forward, create some time between calls to ease up CPU usage. */
 		if (!_fast_forward || _pause_mode) {
 			/* See how much time there is till we have to process the next event, and try to hit that as close as possible. */

src/video/sdl_v.h

➞

Show inline comments

@@ @@ -38,19 +38,23 @@ public: @@
 	const char *GetName() const override { return "sdl"; }
 protected:
 	void InputLoop() override;
 	bool LockVideoBuffer() override;
 	void UnlockVideoBuffer() override;
 	void Paint() override;
 	void PaintThread() override;
 private:
 	std::unique_lock<std::recursive_mutex> draw_lock;
 	int PollEvent();
 	bool CreateMainSurface(uint w, uint h);
 	void SetupKeyboard();
 	static void PaintThreadThunk(VideoDriver_SDL *drv);
 };
 /** Factory for the SDL video driver. */
 class FVideoDriver_SDL : public DriverFactoryBase {
 public:
 	FVideoDriver_SDL() : DriverFactoryBase(Driver::DT_VIDEO, 5, "sdl", "SDL Video Driver") {}

src/video/video_driver.hpp

➞

Show inline comments

@@ @@ -171,12 +171,22 @@ protected: @@
 	/**
 	 * Unlock a previously locked video buffer.
 	 */
 	virtual void UnlockVideoBuffer() {}
 	/**
 	 * Paint the window.
 	 */
 	virtual void Paint() {}
 	/**
 	 * Thread function for threaded drawing.
 	 */
 	virtual void PaintThread() {}
 	std::chrono::steady_clock::duration GetGameInterval()
+	{
 		return std::chrono::milliseconds(MILLISECONDS_PER_TICK);
+	}
 	std::chrono::steady_clock::duration GetDrawInterval()

src/video/win32_v.cpp

➞

Show inline comments

@@ @@ -329,13 +329,13 @@ bool VideoDriver_Win32::MakeWindow(bool @@
 	GameSizeChanged(); // invalidate all windows, force redraw
 	return true; // the request succeeded
+}
 /** Do palette animation and blit to the window. */
-static void PaintWindow()
+void VideoDriver_Win32::Paint()
+{
 	PerformanceMeasurer framerate(PFE_VIDEO);
 	if (IsEmptyRect(_dirty_rect)) return;
 	/* Convert update region from logical to device coordinates. */
@@ @@ -382,31 +382,36 @@ static void PaintWindow() @@
 	ReleaseDC(_wnd.main_wnd, dc);
 	MemSetT(&_dirty_rect, 0);
+}
-static void PaintWindowThread()
+void VideoDriver_Win32::PaintThread()
+{
 	/* First tell the main thread we're started */
 	std::unique_lock<std::recursive_mutex> lock(*_draw_mutex);
 	_draw_signal->notify_one();
 	/* Now wait for the first thing to draw! */
 	_draw_signal->wait(*_draw_mutex);
 	while (_draw_continue) {
-		PaintWindow();
+		this->Paint();
 		/* Flush GDI buffer to ensure drawing here doesn't conflict with any GDI usage in the main WndProc. */
 		GdiFlush();
 		_draw_signal->wait(*_draw_mutex);
+	}
+}
 /* static */ void VideoDriver_Win32::PaintThreadThunk(VideoDriver_Win32 *drv)
+{
 	drv->PaintThread();
+}
 /** Forward key presses to the window system. */
 static LRESULT HandleCharMsg(uint keycode, WChar charcode)
+{
 #if !defined(UNICODE)
 	static char prev_char = 0;
@@ @@ -1173,13 +1178,13 @@ void VideoDriver_Win32::MainLoop() @@
+		}
 		if (_draw_threaded) {
 			this->draw_lock = std::unique_lock<std::recursive_mutex>(*_draw_mutex);
 			_draw_continue = true;
-			_draw_threaded = StartNewThread(&draw_thread, "ottd:draw-win32", &PaintWindowThread);
+			_draw_threaded = StartNewThread(&draw_thread, "ottd:draw-win32", &VideoDriver_Win32::PaintThreadThunk, this);
 			/* Free the mutex if we won't be able to use it. */
 			if (!_draw_threaded) {
 				this->draw_lock.unlock();
 				this->draw_lock.release();
 				delete _draw_mutex;
@@ @@ -1251,13 +1256,13 @@ void VideoDriver_Win32::MainLoop() @@
 			UpdateWindows();
 			CheckPaletteAnim();
 			if (_draw_mutex != nullptr && !HasModalProgress()) {
 				_draw_signal->notify_one();
 			} else {
-				PaintWindow();
+				this->Paint();
+			}
+		}
 		/* If we are not in fast-forward, create some time between calls to ease up CPU usage. */
 		if (!_fast_forward || _pause_mode) {
 			/* See how much time there is till we have to process the next event, and try to hit that as close as possible. */

src/video/win32_v.h

➞

Show inline comments

@@ @@ -44,12 +44,14 @@ public: @@
 protected:
 	Dimension GetScreenSize() const override;
 	float GetDPIScale() override;
 	void InputLoop() override;
 	bool LockVideoBuffer() override;
 	void UnlockVideoBuffer() override;
 	void Paint() override;
 	void PaintThread() override;
 private:
 	std::unique_lock<std::recursive_mutex> draw_lock;
 	void CheckPaletteAnim();

0 comments (0 inline, 0 general)