STARK: Move the Color struct into a separate header

madmoose · Feb 3, 2023 · aa5076f · aa5076f
1 parent 46118c2
commit aa5076f
Show file tree

Hide file tree

Showing 23 changed files with 103 additions and 68 deletions.
diff --git a/engines/stark/gfx/color.h b/engines/stark/gfx/color.h
@@ -0,0 +1,50 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef STARK_GFX_COLOR_H
+#define STARK_GFX_COLOR_H
+
+#include "common/scummsys.h"
+
+namespace Stark {
+namespace Gfx {
+
+struct Color {
+	uint8 r;
+	uint8 g;
+	uint8 b;
+	uint8 a;
+
+	Color(uint8 red, uint8 green, uint8 blue, uint8 alpha = 0xFF) :
+			r(red), g(green), b(blue), a(alpha) {}
+
+	bool operator==(const Color &color) const {
+		return r == color.r &&
+		       g == color.g &&
+		       b == color.b &&
+		       a == color.a;
+	}
+};
+
+} // End of namespace Gfx
+} // End of namespace Stark
+
+#endif // STARK_GFX_COLOR_H
diff --git a/engines/stark/resources/image.cpp b/engines/stark/resources/image.cpp
@@ -262,7 +262,7 @@ void ImageStill::printData() {
 
 ImageText::ImageText(Object *parent, byte subType, uint16 index, const Common::String &name) :
 		Image(parent, subType, index, name),
-		_color(Color(0, 0, 0)),
+		_color(Gfx::Color(0, 0, 0)),
 		_font(0) {
 }
 

diff --git a/engines/stark/resources/image.h b/engines/stark/resources/image.h
@@ -26,12 +26,13 @@
 #include "common/str.h"
 
 #include "engines/stark/resources/object.h"
-#include "engines/stark/visual/text.h"
+#include "engines/stark/gfx/color.h"
 
 namespace Stark {
 
 class Visual;
 class VisualImageXMG;
+class VisualText;
 namespace Formats {
 class XRCReadStream;
 }
@@ -140,7 +141,7 @@ class ImageText : public Image {
 
 	Common::Point _size;
 	Common::String _text;
-	Color _color;
+	Gfx::Color _color;
 	uint32 _font;
 };
 

diff --git a/engines/stark/ui/cursor.cpp b/engines/stark/ui/cursor.cpp
@@ -165,8 +165,8 @@ void Cursor::setMouseHint(const Common::String &hint) {
 		if (!hint.empty()) {
 			_mouseText = new VisualText(_gfx);
 			_mouseText->setText(hint);
-			_mouseText->setColor(Color(0xFF, 0xFF, 0xFF));
-			_mouseText->setBackgroundColor(Color(0x00, 0x00, 0x00, 0x80));
+			_mouseText->setColor(Gfx::Color(0xFF, 0xFF, 0xFF));
+			_mouseText->setBackgroundColor(Gfx::Color(0x00, 0x00, 0x00, 0x80));
 			_mouseText->setFont(FontProvider::kSmallFont);
 			_mouseText->setTargetWidth(96);
 		} else {

diff --git a/engines/stark/ui/dialogbox.h b/engines/stark/ui/dialogbox.h
@@ -24,7 +24,7 @@
 
 #include "engines/stark/stark.h"
 #include "engines/stark/ui/window.h"
-#include "engines/stark/visual/text.h"
+#include "engines/stark/gfx/color.h"
 
 #include "common/keyboard.h"
 #include "common/scummsys.h"
@@ -90,7 +90,7 @@ class DialogBox : public Window {
 	Common::Rect _cancelButtonRect;
 	Common::Rect _messageRect;
 
-	const Color _textColor = Color(0xFF, 0xFF, 0xFF);
+	const Gfx::Color _textColor = Gfx::Color(0xFF, 0xFF, 0xFF);
 
 	ConfirmCallback *_confirmCallback;
 };

diff --git a/engines/stark/ui/menu/dialogmenu.cpp b/engines/stark/ui/menu/dialogmenu.cpp
@@ -328,7 +328,7 @@ DialogLineText::DialogLineText(Gfx::Driver *gfx, uint logIndex, uint lineIndex,
 	Common::String name = StarkGlobal->getCharacterName(logLine.characterId);
 	name.toUppercase();
 
-	Color color = logLine.characterId == StarkGlobal->getApril()->getCharacterIndex() ? _textColorApril : _textColorNormal;
+	Gfx::Color color = logLine.characterId == StarkGlobal->getApril()->getCharacterIndex() ? _textColorApril : _textColorNormal;
 
 	_nameText.setText(name);
 	_nameText.setColor(color);

diff --git a/engines/stark/ui/menu/dialogmenu.h b/engines/stark/ui/menu/dialogmenu.h
@@ -99,7 +99,7 @@ class ChapterTitleText {
 	void onScreenChanged() { _text.reset(); }
 
 private:
-	const Color _color = Color(0x68, 0x05, 0x04);
+	const Gfx::Color _color = Gfx::Color(0x68, 0x05, 0x04);
 
 	Common::Point _pos;
 	VisualText _text;
@@ -127,8 +127,8 @@ class DialogLineText {
 	}
 
 private:
-	const Color _textColorApril = Color(0x68, 0x05, 0x04);
-	const Color _textColorNormal = Color(0x1E, 0x1E, 0x96);
+	const Gfx::Color _textColorApril = Gfx::Color(0x68, 0x05, 0x04);
+	const Gfx::Color _textColorNormal = Gfx::Color(0x1E, 0x1E, 0x96);
 
 	Common::Point _namePos, _linePos;
 	VisualText _nameText, _lineText;
@@ -158,8 +158,8 @@ class DialogTitleWidget : public StaticLocationWidget {
 	void onScreenChanged() override;
 
 private:
-	const Color _textColorHovered = Color(0x1E, 0x1E, 0x96);
-	const Color _textColorDefault = Color(0x00, 0x00, 0x00);
+	const Gfx::Color _textColorHovered = Gfx::Color(0x1E, 0x1E, 0x96);
+	const Gfx::Color _textColorDefault = Gfx::Color(0x00, 0x00, 0x00);
 
 	uint _logIndex, _chapter;
 	int _width, _height;

diff --git a/engines/stark/ui/menu/diaryindex.cpp b/engines/stark/ui/menu/diaryindex.cpp
@@ -104,7 +104,7 @@ void DiaryIndexScreen::open() {
 
 void DiaryIndexScreen::widgetTextColorHandler(StaticLocationWidget &widget, const Common::Point &mousePos) {
 	if (widget.isVisible()) {
-		Color textColor = widget.isMouseInside(mousePos) ? _textColorHovered : _textColorDefault;
+		Gfx::Color textColor = widget.isMouseInside(mousePos) ? _textColorHovered : _textColorDefault;
 		widget.setTextColor(textColor);
 	}
 }

diff --git a/engines/stark/ui/menu/diaryindex.h b/engines/stark/ui/menu/diaryindex.h
@@ -48,8 +48,8 @@ class DiaryIndexScreen : public StaticLocationScreen {
 	void dialogHandler();
 	void quitHandler();
 
-	const Color _textColorHovered = Color(0x1E, 0x1E, 0x96);
-	const Color _textColorDefault = Color(0x00, 0x00, 0x00);
+	const Gfx::Color _textColorHovered = Gfx::Color(0x1E, 0x1E, 0x96);
+	const Gfx::Color _textColorDefault = Gfx::Color(0x00, 0x00, 0x00);
 };
 
 } // End of namespace Stark

diff --git a/engines/stark/ui/menu/fmvmenu.h b/engines/stark/ui/menu/fmvmenu.h
@@ -90,13 +90,13 @@ class FMVWidget {
 
 	void onClick();
 
-	void setTextColor(const Color &color) { _title.setColor(color); }
+	void setTextColor(const Gfx::Color &color) { _title.setColor(color); }
 
 	void onScreenChanged() { _title.reset(); }
 
 private:
-	const Color _textColorHovered = Color(0x1E, 0x1E, 0x96);
-	const Color _textColorDefault = Color(0x00, 0x00, 0x00);
+	const Gfx::Color _textColorHovered = Gfx::Color(0x1E, 0x1E, 0x96);
+	const Gfx::Color _textColorDefault = Gfx::Color(0x00, 0x00, 0x00);
 
 	Common::Point _formatRectPos;
 	int _fontHeight;

diff --git a/engines/stark/ui/menu/locationscreen.cpp b/engines/stark/ui/menu/locationscreen.cpp
@@ -228,7 +228,7 @@ void StaticLocationWidget::setupSounds(int16 enterSound, int16 clickSound) {
 	}
 }
 
-void StaticLocationWidget::setTextColor(const Color &textColor) {
+void StaticLocationWidget::setTextColor(const Gfx::Color &textColor) {
 	if (!_renderEntry) return;
 
 	VisualText *text = _renderEntry->getText();

diff --git a/engines/stark/ui/menu/locationscreen.h b/engines/stark/ui/menu/locationscreen.h
@@ -24,7 +24,7 @@
 
 #include "engines/stark/ui/screen.h"
 #include "engines/stark/ui/window.h"
-#include "engines/stark/visual/text.h"
+#include "engines/stark/gfx/color.h"
 
 namespace Stark {
 
@@ -121,7 +121,7 @@ class StaticLocationWidget {
 	 *
 	 * Only applies for widget referring to a RenderEntry for a text visual
 	 */
-	void setTextColor(const Color &textColor);
+	void setTextColor(const Gfx::Color &textColor);
 
 	/** Widgets must be visible to be rendered and interactive */
 	bool isVisible() const;

diff --git a/engines/stark/ui/menu/saveloadmenu.cpp b/engines/stark/ui/menu/saveloadmenu.cpp
@@ -93,15 +93,15 @@ void SaveLoadMenuScreen::open() {
 			CLICK_HANDLER(SaveLoadMenuScreen, prevPageHandler),
 			nullptr));
 	_widgets.back()->setupSounds(0, 1);
-	_widgets.back()->setTextColor(Color(0, 0, 0));
+	_widgets.back()->setTextColor(Gfx::Color(0, 0, 0));
 	_widgets.back()->setVisible(_page > 0);
 
 	_widgets.push_back(new StaticLocationWidget(
 			"Next",
 			CLICK_HANDLER(SaveLoadMenuScreen, nextPageHandler),
 			nullptr));
 	_widgets.back()->setupSounds(0, 1);
-	_widgets.back()->setTextColor(Color(0, 0, 0));
+	_widgets.back()->setTextColor(Gfx::Color(0, 0, 0));
 	_widgets.back()->setVisible(_page < _maxPage);
 
 	loadSaveData(_page);

diff --git a/engines/stark/ui/menu/saveloadmenu.h b/engines/stark/ui/menu/saveloadmenu.h
@@ -156,8 +156,8 @@ class SaveDataWidget : public StaticLocationWidget {
 	bool hasSave() { return _hasSave; }
 
 private:
-	const Color _outlineColor = Color(0x1E, 0x1E, 0x96);
-	const Color _textColor = Color(0x5C, 0x48, 0x3D);
+	const Gfx::Color _outlineColor = Gfx::Color(0x1E, 0x1E, 0x96);
+	const Gfx::Color _textColor = Gfx::Color(0x5C, 0x48, 0x3D);
 
 	int _slot;
 	SaveLoadMenuScreen *_screen;

diff --git a/engines/stark/ui/menu/settingsmenu.h b/engines/stark/ui/menu/settingsmenu.h
@@ -105,8 +105,8 @@ class SettingsMenuScreen : public StaticLocationScreen {
 	void backHandler();
 
 private:
-	const Color _textColorHovered = Color(0x1E, 0x1E, 0x96);
-	const Color _textColorDefault = Color(0x00, 0x00, 0x00);
+	const Gfx::Color _textColorHovered = Gfx::Color(0x1E, 0x1E, 0x96);
+	const Gfx::Color _textColorDefault = Gfx::Color(0x00, 0x00, 0x00);
 
 	TestSoundManager _soundManager;
 };
@@ -155,7 +155,7 @@ class VolumeWidget : public StaticLocationWidget {
 	void onMouseUp() override;
 
 private:
-	const Color _textColorBgHovered = Color(0xFF, 0xFF, 0xFF);
+	const Gfx::Color _textColorBgHovered = Gfx::Color(0xFF, 0xFF, 0xFF);
 	static const int _maxVolume = 256;
 
 	VisualImageXMG *_sliderImage;

diff --git a/engines/stark/ui/world/actionmenu.cpp b/engines/stark/ui/world/actionmenu.cpp
@@ -57,8 +57,8 @@ ActionMenu::ActionMenu(Gfx::Driver *gfx, Cursor *cursor) :
 	_background = StarkStaticProvider->getUIElement(StaticProvider::kActionMenuBg);
 
 	_itemDescription = new VisualText(gfx);
-	_itemDescription->setColor(Color(0xFF, 0xFF, 0xFF));
-	_itemDescription->setBackgroundColor(Color(0x00, 0x00, 0x00, 0x80));
+	_itemDescription->setColor(Gfx::Color(0xFF, 0xFF, 0xFF));
+	_itemDescription->setBackgroundColor(Gfx::Color(0x00, 0x00, 0x00, 0x80));
 	_itemDescription->setFont(FontProvider::kSmallFont);
 	_itemDescription->setTargetWidth(96);
 

diff --git a/engines/stark/ui/world/button.cpp b/engines/stark/ui/world/button.cpp
@@ -84,7 +84,7 @@ void Button::showButtonHint() {
 	if (!_mouseText) {
 		_mouseText = new VisualText(StarkGfx);
 		_mouseText->setText(_text);
-		_mouseText->setColor(Color(0xFF, 0xFF, 0xFF));
+		_mouseText->setColor(Gfx::Color(0xFF, 0xFF, 0xFF));
 		_mouseText->setFont(FontProvider::kSmallFont);
 		_mouseText->setTargetWidth(96);
 	}

diff --git a/engines/stark/ui/world/clicktext.cpp b/engines/stark/ui/world/clicktext.cpp
@@ -25,7 +25,7 @@
 
 namespace Stark {
 
-ClickText::ClickText(const Common::String &text, const Color &color) :
+ClickText::ClickText(const Common::String &text, const Gfx::Color &color) :
 		_text(text),
 		_color(color) {
 	_visualPassive = new VisualText(StarkGfx);
@@ -36,7 +36,7 @@ ClickText::ClickText(const Common::String &text, const Color &color) :
 
 	_visualActive = new VisualText(StarkGfx);
 	_visualActive->setText(_text);
-	_visualActive->setColor(Color(0x00, 0x00, 0x00));
+	_visualActive->setColor(Gfx::Color(0x00, 0x00, 0x00));
 	_visualActive->setBackgroundColor(_color);
 	_visualActive->setFont(FontProvider::kBigFont);
 	_visualActive->setTargetWidth(600);

diff --git a/engines/stark/ui/world/clicktext.h b/engines/stark/ui/world/clicktext.h
@@ -22,7 +22,7 @@
 #ifndef STARK_UI_CLICK_TEXT_H
 #define STARK_UI_CLICK_TEXT_H
 
-#include "engines/stark/visual/text.h"
+#include "engines/stark/gfx/color.h"
 
 #include "common/scummsys.h"
 #include "common/rect.h"
@@ -34,7 +34,7 @@ class VisualText;
 
 class ClickText {
 public:
-	ClickText(const Common::String &text, const Color &color);
+	ClickText(const Common::String &text, const Gfx::Color &color);
 	~ClickText();
 
 	void setPosition(const Common::Point &pos) { _position = pos; }
@@ -52,7 +52,7 @@ class ClickText {
 	Common::Point _position;
 	Common::String _text;
 	Common::Rect _bbox;
-	Color _color;
+	Gfx::Color _color;
 };
 
 } // End of namespace Stark

diff --git a/engines/stark/ui/world/dialogpanel.cpp b/engines/stark/ui/world/dialogpanel.cpp
@@ -159,7 +159,7 @@ void DialogPanel::onRender() {
 void DialogPanel::updateSubtitleVisual() {
 	clearSubtitleVisual();
 
-	Color color = _otherColor;
+	Gfx::Color color = _otherColor;
 	if (_currentSpeech->characterIsApril())
 		color = _aprilColor;
 

diff --git a/engines/stark/ui/world/dialogpanel.h b/engines/stark/ui/world/dialogpanel.h
@@ -23,7 +23,7 @@
 #define STARK_UI_DIALOG_PANEL_H
 
 #include "engines/stark/ui/window.h"
-#include "engines/stark/visual/text.h"
+#include "engines/stark/gfx/color.h"
 
 #include "common/scummsys.h"
 #include "common/str.h"
@@ -34,6 +34,7 @@
 namespace Stark {
 
 class VisualImageXMG;
+class VisualText;
 class ClickText;
 
 namespace Resources {
@@ -103,8 +104,8 @@ class DialogPanel : public Window {
 	Common::Array<ClickText*> _options;
 	bool _acceptIdleMousePos;
 
-	Color _aprilColor = Color(0xFF, 0xC0, 0x00);
-	Color _otherColor = Color(0xFF, 0x40, 0x40);
+	const Gfx::Color _aprilColor = Gfx::Color(0xFF, 0xC0, 0x00);
+	const Gfx::Color _otherColor = Gfx::Color(0xFF, 0x40, 0x40);
 	static const uint32 _optionsTop = 4;
 	static const uint32 _optionsLeft = 30;
 	static const uint32 _optionsHeight = 80;