From 6387291e37e9dafde17bdc56a04f86c3e3bca3d1 Mon Sep 17 00:00:00 2001
From: YoshiRulz <OSSYoshiRulz@gmail.com>
Date: Fri, 10 Mar 2023 03:55:05 +1000
Subject: [PATCH] Deprecate `IGuiApi.DrawText` in favour of new method
 `PixelText`

to match Lua
---
 src/BizHawk.Client.Common/Api/Classes/GuiApi.cs | 17 +++++++++++++++++
 .../Api/Interfaces/IGuiApi.cs                   |  4 ++++
 .../lua/CommonLibs/GuiLuaLibrary.cs             |  2 +-
 3 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/src/BizHawk.Client.Common/Api/Classes/GuiApi.cs b/src/BizHawk.Client.Common/Api/Classes/GuiApi.cs
index ad002e0638..1603f9db63 100644
--- a/src/BizHawk.Client.Common/Api/Classes/GuiApi.cs
+++ b/src/BizHawk.Client.Common/Api/Classes/GuiApi.cs
@@ -544,6 +544,23 @@ namespace BizHawk.Client.Common
 		}
 
 		public void DrawText(int x, int y, string message, Color? forecolor = null, Color? backcolor = null, string fontfamily = null, DisplaySurfaceID? surfaceID = null)
+			=> PixelText(
+				x: x,
+				y: y,
+				message: message,
+				forecolor: forecolor,
+				backcolor: backcolor,
+				fontfamily: fontfamily,
+				surfaceID: surfaceID);
+
+		public void PixelText(
+			int x,
+			int y,
+			string message,
+			Color? forecolor = null,
+			Color? backcolor = null,
+			string fontfamily = null,
+			DisplaySurfaceID? surfaceID = null)
 		{
 			try
 			{
diff --git a/src/BizHawk.Client.Common/Api/Interfaces/IGuiApi.cs b/src/BizHawk.Client.Common/Api/Interfaces/IGuiApi.cs
index 757f2298a8..e10e1eb65e 100644
--- a/src/BizHawk.Client.Common/Api/Interfaces/IGuiApi.cs
+++ b/src/BizHawk.Client.Common/Api/Interfaces/IGuiApi.cs
@@ -56,8 +56,12 @@ namespace BizHawk.Client.Common
 		void DrawString(int x, int y, string message, Color? forecolor = null, Color? backcolor = null, int? fontsize = null, string fontfamily = null, string fontstyle = null, string horizalign = null, string vertalign = null, DisplaySurfaceID? surfaceID = null);
 
 		/// <remarks>exposed to Lua as <c>gui.pixelText</c></remarks>
+		[Obsolete("method renamed to PixelText to match Lua")]
 		void DrawText(int x, int y, string message, Color? forecolor = null, Color? backcolor = null, string fontfamily = null, DisplaySurfaceID? surfaceID = null);
 
+		/// <remarks>exposed to Lua as <c>gui.pixelText</c></remarks>
+		void PixelText(int x, int y, string message, Color? forecolor = null, Color? backcolor = null, string fontfamily = null, DisplaySurfaceID? surfaceID = null);
+
 		/// <remarks>exposed to Lua as <c>gui.text</c></remarks>
 		void Text(int x, int y, string message, Color? forecolor = null, string anchor = null);
 	}
diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/GuiLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/GuiLuaLibrary.cs
index 68b99224a4..ac7f6a5ba0 100644
--- a/src/BizHawk.Client.Common/lua/CommonLibs/GuiLuaLibrary.cs
+++ b/src/BizHawk.Client.Common/lua/CommonLibs/GuiLuaLibrary.cs
@@ -313,7 +313,7 @@ namespace BizHawk.Client.Common
 			[LuaColorParam] object backcolor = null,
 			string fontfamily = null,
 			string surfaceName = null)
-				=> APIs.Gui.DrawText(x, y, message, _th.SafeParseColor(forecolor), _th.SafeParseColor(backcolor) ?? APIs.Gui.GetDefaultTextBackground().Value, fontfamily, surfaceID: UseOrFallback(surfaceName));
+				=> APIs.Gui.PixelText(x, y, message, _th.SafeParseColor(forecolor), _th.SafeParseColor(backcolor) ?? APIs.Gui.GetDefaultTextBackground().Value, fontfamily, surfaceID: UseOrFallback(surfaceName));
 
 		[LuaMethodExample("gui.text( 16, 32, \"Some message\", 0x7F0000FF, \"bottomleft\" );")]
 		[LuaMethod("text", "Displays the given text on the screen at the given coordinates. Optional Foreground color. The optional anchor flag anchors the text to one of the four corners. Anchor flag parameters: topleft, topright, bottomleft, bottomright")]