Add project window icon setting and apply it to runtime + Windows built executable icon (#750)

Author: Gopmyc

Resources/Engine/Textures/WindowIcon.png

@@ -106,8 +106,8 @@ OvEditor::Core::Context::Context(const std::filesystem::path& p_projectFolder) :
 	windowSettings.width = bestFitWindowSizeAndPosition[2];
 	windowSettings.height = bestFitWindowSizeAndPosition[3];
 	window = std::make_unique<OvWindowing::Window>(*device, windowSettings);
-	std::vector<uint64_t> iconRaw = { 0,0,144115188614240000ULL,7500771567664627712ULL,7860776967494637312ULL,0,0,0,0,7212820467466371072ULL,11247766461832697600ULL,14274185407633888512ULL,12905091124788992000ULL,5626708973701824512ULL,514575842263176960,0,0,6564302121125019648ULL,18381468271671515136ULL,18381468271654737920ULL,18237353083595659264ULL,18165295488836311040ULL,6708138037527189504ULL,0,4186681893338480640ULL,7932834557741046016ULL,17876782538917681152ULL,11319824055216379904ULL,15210934132358518784ULL,18381468271520454400ULL,1085667680982603520ULL,0,18093237891929479168ULL,18309410677600032768ULL,11391881649237530624ULL,7932834561381570304ULL,17300321784231761408ULL,15210934132375296000ULL,8293405106311272448ULL,2961143145139082752ULL,16507969723533236736ULL,17516777143216379904ULL,10671305705855129600ULL,7356091234422036224ULL,16580027318695106560ULL,2240567205413984000ULL,18381468271470188544ULL,10959253511276599296ULL,4330520004484136960ULL,10815138323200743424ULL,11607771853338181632ULL,8364614976649238272ULL,17444719546862998784ULL,2669156352,18381468269893064448ULL,6419342512197474304ULL,11103650170688640000ULL,6492244531366860800ULL,14346241902646925312ULL,13841557270159628032ULL,7428148827772098304ULL,3464698581331941120ULL,18381468268953606144ULL,1645680384,18381468271554008832ULL,7140201027266418688ULL,5987558797656659712ULL,17588834734687262208ULL,7284033640602212096ULL,14273902834169157632ULL,18381468269087692288ULL,6852253225049397248ULL,17732667349600245504ULL,16291515470083266560ULL,10022503688432981760ULL,11968059825861367552ULL,9733991836700645376ULL,14850363587428816640ULL,18381468271168132864ULL,16147400282007410688ULL,656430432014827520,18381468270950094848ULL,15715054717226194944ULL,72057596690306560,11823944635485519872ULL,15859169905251653376ULL,17084149004500473856ULL,8581352906816952064ULL,2527949855582584832ULL,18381468271419856896ULL,8581352907253225472ULL,252776704,1376441223417430016ULL,14994761349590357760ULL,10527190521537370112ULL,0,9806614576878321664ULL,18381468271671515136ULL,17156206598538401792ULL,6059619689256392448ULL,10166619973990488064ULL,18381468271403079424ULL,17444719549178451968ULL,420746240,870625192710242304,4906133035823863552ULL,18381468269289150464ULL,18381468271671515136ULL,18381468271671515136ULL,9950729769032620032ULL,14778305994951169792ULL,269422336,0,0,18381468268785833984ULL,8941923452686178304ULL,18381468270950094848ULL,3440842496,1233456333565402880ULL,0,0,0,11823944636091210240ULL,2383877888,16724143605745719296ULL,2316834816,0,0 };
-	window->SetIconFromMemory(reinterpret_cast<uint8_t*>(iconRaw.data()), 16, 16);
+	const auto fallbackWindowIconPath = engineAssetsPath / "Textures" / "WindowIcon.png";
+	window->SetIcon(fallbackWindowIconPath.string());
 	inputManager = std::make_unique<OvWindowing::Inputs::InputManager>(*window);
 	window->MakeCurrentContext();
 	device->SetVsync(true);
@@ -201,6 +201,7 @@ void OvEditor::Core::Context::ResetProjectSettings()
 	projectSettings.Add<bool>("multisampling", false);
 	projectSettings.Add<int>("samples", 4);
 	projectSettings.Add<int>("build_type", 0);
+	projectSettings.Add<std::string>("window_icon", "");
 }
 
 bool OvEditor::Core::Context::IsProjectSettingsIntegrityVerified()
@@ -215,7 +216,8 @@ bool OvEditor::Core::Context::IsProjectSettingsIntegrityVerified()
 		projectSettings.IsKeyExisting("vsync") &&
 		projectSettings.IsKeyExisting("multisampling") &&
 		projectSettings.IsKeyExisting("samples") &&
-		projectSettings.IsKeyExisting("build_type");
+		projectSettings.IsKeyExisting("build_type") &&
+		projectSettings.IsKeyExisting("window_icon");
 }
 
 void OvEditor::Core::Context::ApplyProjectSettings()

Sources/OvEditor/src/OvEditor/Core/Context.cpp

@@ -43,6 +43,7 @@
 #include <OvTools/Utils/PathParser.h>
 #include <OvTools/Utils/String.h>
 #include <OvTools/Utils/SystemCalls.h>
+#include <OvRendering/Data/Image.h>
 #include <OvRendering/Resources/Parsers/EmbeddedAssetPath.h>
 
 #include <OvWindowing/Dialogs/OpenFileDialog.h>
@@ -472,6 +473,60 @@ void OvEditor::Core::EditorActions::BuildAtLocation(
 						{
 							OVLOG_INFO("Game executable renamed to " + executableName);
 
+#if defined(_WIN32)
+							if (const std::string windowIconPath = m_context.projectSettings.GetOrDefault("window_icon", std::string{}); !windowIconPath.empty())
+							{
+								const std::filesystem::path windowIconRealPath{ GetRealPath(windowIconPath) };
+
+								if (!std::filesystem::exists(windowIconRealPath))
+								{
+									OVLOG_WARNING(
+										std::format(
+											"Window icon \"{}\" was not found. Keeping default executable icon.",
+											windowIconRealPath.string()
+										)
+									);
+								}
+								else if (OvRendering::Data::Image iconImage{ windowIconRealPath }; !iconImage)
+								{
+									OVLOG_WARNING(
+										std::format(
+											"Failed to load window icon \"{}\". Keeping default executable icon.",
+											windowIconRealPath.string()
+										)
+									);
+								}
+								else if (iconImage.isHDR)
+								{
+									OVLOG_WARNING(
+										std::format(
+											"Window icon \"{}\" is HDR and cannot be used for executable icons. Keeping default executable icon.",
+											windowIconRealPath.string()
+										)
+									);
+								}
+								else
+								{
+									const size_t iconByteCount = static_cast<size_t>(iconImage.width) * static_cast<size_t>(iconImage.height) * 4u;
+									const auto iconBytes = std::span<const uint8_t>{ static_cast<const uint8_t*>(iconImage.data), iconByteCount };
+									if (!OvTools::Utils::SystemCalls::SetExecutableIcon(
+										p_buildPath / executableName,
+										iconBytes,
+										static_cast<uint32_t>(iconImage.width),
+										static_cast<uint32_t>(iconImage.height)
+									))
+									{
+										OVLOG_WARNING(
+											std::format(
+												"Failed to apply executable icon from \"{}\". Keeping default executable icon.",
+												windowIconRealPath.string()
+											)
+										);
+									}
+								}
+							}
+#endif
+
 							if (p_autoRun)
 							{
 								const auto exePath = p_buildPath / executableName;
@@ -1085,23 +1140,13 @@ bool OvEditor::Core::EditorActions::ImportAssetAtLocation(const std::string& p_d
 	return false;
 }
 
-// Duplicate from AResourceManager.h
 std::string OvEditor::Core::EditorActions::GetRealPath(const std::string& p_path)
 {
-	std::filesystem::path result;
-
-	const std::string normalizedPath = OvTools::Utils::PathParser::MakeNonWindowsStyle(p_path);
-
-	if (normalizedPath.starts_with(':')) // The path is an engine path
-	{
-		result = m_context.engineAssetsPath / normalizedPath.substr(1);
-	}
-	else // The path is a project path
-	{
-		result = m_context.projectAssetsPath / normalizedPath;
-	}
-
-	return result.lexically_normal().string();
+	return OvTools::Utils::PathParser::GetRealPath(
+		std::filesystem::path{ p_path },
+		m_context.engineAssetsPath,
+		m_context.projectAssetsPath
+	).string();
 }
 
 std::string OvEditor::Core::EditorActions::GetResourcePath(const std::string& p_path, bool p_isFromEngine)

Sources/OvEditor/src/OvEditor/Core/EditorActions.cpp

@@ -6,6 +6,7 @@
 
 #include "OvEditor/Panels/ProjectSettings.h"
 #include "OvEditor/Core/EditorActions.h"
+#include "OvTools/Utils/PathParser.h"
 
 #include <OvCore/Resources/Loaders/MaterialLoader.h>
 #include <OvCore/Helpers/GUIDrawer.h>
@@ -80,6 +81,7 @@ OvEditor::Panels::ProjectSettings::ProjectSettings(const std::string & p_title,
 		GUIDrawer::DrawScalar<int>(columns, "Resolution Y", GenerateGatherer<int>("y_resolution"), GenerateProvider<int>("y_resolution"), 1, 0, 10000);
 		GUIDrawer::DrawBoolean(columns, "Fullscreen", GenerateGatherer<bool>("fullscreen"), GenerateProvider<bool>("fullscreen"));
 		GUIDrawer::DrawString(columns, "Executable name", GenerateGatherer<std::string>("executable_name"), GenerateProvider<std::string>("executable_name"));
+		GUIDrawer::DrawAsset(columns, "Window Icon", GenerateGatherer<std::string>("window_icon"), GenerateProvider<std::string>("window_icon"), OvTools::Utils::PathParser::EFileType::TEXTURE);
 	}
 
 	{

Sources/OvEditor/src/OvEditor/Panels/ProjectSettings.cpp

@@ -13,6 +13,7 @@
 #include <OvDebug/Logger.h>
 
 #include <OvGame/Core/Context.h>
+#include <OvTools/Utils/PathParser.h>
 
 using namespace OvCore::Global;
 using namespace OvCore::ResourceManagement;
@@ -93,8 +94,25 @@ OvGame::Core::Context::Context() :
 		windowSettings.height = bestFitWindowSizeAndPosition[3];
 	}
 	window = std::make_unique<OvWindowing::Window>(*device, windowSettings);
-	auto iconRaw = std::to_array<uint64_t>({ 0,0,144115188614240000ULL,7500771567664627712ULL,7860776967494637312ULL,0,0,0,0,7212820467466371072ULL,11247766461832697600ULL,14274185407633888512ULL,12905091124788992000ULL,5626708973701824512ULL,514575842263176960,0,0,6564302121125019648ULL,18381468271671515136ULL,18381468271654737920ULL,18237353083595659264ULL,18165295488836311040ULL,6708138037527189504ULL,0,4186681893338480640ULL,7932834557741046016ULL,17876782538917681152ULL,11319824055216379904ULL,15210934132358518784ULL,18381468271520454400ULL,1085667680982603520ULL,0,18093237891929479168ULL,18309410677600032768ULL,11391881649237530624ULL,7932834561381570304ULL,17300321784231761408ULL,15210934132375296000ULL,8293405106311272448ULL,2961143145139082752ULL,16507969723533236736ULL,17516777143216379904ULL,10671305705855129600ULL,7356091234422036224ULL,16580027318695106560ULL,2240567205413984000ULL,18381468271470188544ULL,10959253511276599296ULL,4330520004484136960ULL,10815138323200743424ULL,11607771853338181632ULL,8364614976649238272ULL,17444719546862998784ULL,2669156352,18381468269893064448ULL,6419342512197474304ULL,11103650170688640000ULL,6492244531366860800ULL,14346241902646925312ULL,13841557270159628032ULL,7428148827772098304ULL,3464698581331941120ULL,18381468268953606144ULL,1645680384,18381468271554008832ULL,7140201027266418688ULL,5987558797656659712ULL,17588834734687262208ULL,7284033640602212096ULL,14273902834169157632ULL,18381468269087692288ULL,6852253225049397248ULL,17732667349600245504ULL,16291515470083266560ULL,10022503688432981760ULL,11968059825861367552ULL,9733991836700645376ULL,14850363587428816640ULL,18381468271168132864ULL,16147400282007410688ULL,656430432014827520,18381468270950094848ULL,15715054717226194944ULL,72057596690306560,11823944635485519872ULL,15859169905251653376ULL,17084149004500473856ULL,8581352906816952064ULL,2527949855582584832ULL,18381468271419856896ULL,8581352907253225472ULL,252776704,1376441223417430016ULL,14994761349590357760ULL,10527190521537370112ULL,0,9806614576878321664ULL,18381468271671515136ULL,17156206598538401792ULL,6059619689256392448ULL,10166619973990488064ULL,18381468271403079424ULL,17444719549178451968ULL,420746240,870625192710242304,4906133035823863552ULL,18381468269289150464ULL,18381468271671515136ULL,18381468271671515136ULL,9950729769032620032ULL,14778305994951169792ULL,269422336,0,0,18381468268785833984ULL,8941923452686178304ULL,18381468270950094848ULL,3440842496,1233456333565402880ULL,0,0,0,11823944636091210240ULL,2383877888,16724143605745719296ULL,2316834816,0,0 });
-	window->SetIconFromMemory(reinterpret_cast<uint8_t*>(iconRaw.data()), 16, 16);
+	bool useFallbackWindowIcon = true;
+	if (const std::string windowIconPath = projectSettings.GetOrDefault("window_icon", std::string{}); !windowIconPath.empty())
+	{
+		const std::filesystem::path realPath = OvTools::Utils::PathParser::GetRealPath(
+			std::filesystem::path{ windowIconPath },
+			engineAssetsPath,
+			projectAssetsPath
+		);
+
+		useFallbackWindowIcon = !std::filesystem::exists(realPath) || !window->SetIcon(realPath.string());
+	}
+	if (useFallbackWindowIcon)
+	{
+		const auto fallbackWindowIconPath = engineAssetsPath / "Textures" / "WindowIcon.png";
+		if (!window->SetIcon(fallbackWindowIconPath.string()))
+		{
+			OVLOG_WARNING("Fallback window icon could not be loaded from: " + fallbackWindowIconPath.string());
+		}
+	}
 	inputManager = std::make_unique<OvWindowing::Inputs::InputManager>(*window);
 	window->MakeCurrentContext();
 

Sources/OvGame/src/OvGame/Core/Context.cpp

@@ -23,13 +23,15 @@ namespace OvRendering::Data
 		/**
 		* Creates an image from a file on disk
 		* @param p_filepath
+		* @param p_flipVertically
 		*/
-		Image(const std::filesystem::path& p_filepath);
+		Image(const std::filesystem::path& p_filepath, bool p_flipVertically = true);
 
 		/**
 		* Creates an image from encoded image data in memory
+		* @param p_flipVertically
 		*/
-		Image(const uint8_t* p_data, const size_t p_size);
+		Image(const uint8_t* p_data, const size_t p_size, bool p_flipVertically = true);
 
 		/**
 		* Destructor of the image

Sources/OvRendering/include/OvRendering/Data/Image.h

@@ -10,9 +10,9 @@
 
 #include <stb_image/stb_image.h>
 
-OvRendering::Data::Image::Image(const std::filesystem::path& p_filepath)
+OvRendering::Data::Image::Image(const std::filesystem::path& p_filepath, const bool p_flipVertically)
 {
-	stbi_set_flip_vertically_on_load(true);
+	stbi_set_flip_vertically_on_load(p_flipVertically ? 1 : 0);
 
 	isHDR = stbi_is_hdr(p_filepath.string().c_str());
 
@@ -21,15 +21,15 @@ OvRendering::Data::Image::Image(const std::filesystem::path& p_filepath)
 		static_cast<void*>(stbi_load(p_filepath.string().c_str(), &width, &height, &bpp, 4));
 }
 
-OvRendering::Data::Image::Image(const uint8_t* p_data, const size_t p_size)
+OvRendering::Data::Image::Image(const uint8_t* p_data, const size_t p_size, const bool p_flipVertically)
 {
 	if (!p_data || p_size == 0 || p_size > static_cast<size_t>(std::numeric_limits<int>::max()))
 	{
 		return;
 	}
 
 	const int encodedSize = static_cast<int>(p_size);
-	stbi_set_flip_vertically_on_load(true);
+	stbi_set_flip_vertically_on_load(p_flipVertically ? 1 : 0);
 	isHDR = stbi_is_hdr_from_memory(p_data, encodedSize) != 0;
 
 	data = isHDR ?

Sources/OvRendering/src/OvRendering/Data/Image.cpp

@@ -6,6 +6,7 @@
 
 #pragma once
 
+#include <filesystem>
 #include <string>
 
 
@@ -91,5 +92,18 @@ namespace OvTools::Utils
 		* @param p_path
 		*/
 		static EFileType GetFileType(const std::string& p_path);
+
+		/**
+		* Returns the real absolute path of an asset path.
+		* Engine paths are prefixed with ':'.
+		* @param p_path
+		* @param p_enginePath
+		* @param p_projectPath
+		*/
+		static std::filesystem::path GetRealPath(
+			const std::filesystem::path& p_path,
+			const std::filesystem::path& p_enginePath,
+			const std::filesystem::path& p_projectPath
+		);
 	};
 }

Sources/OvTools/include/OvTools/Utils/PathParser.h

@@ -6,6 +6,9 @@
 
 #pragma once
 
+#include <cstdint>
+#include <filesystem>
+#include <span>
 #include <string>
 
 
@@ -39,6 +42,21 @@ namespace OvTools::Utils
 		*/
 		static void RunProgram(const std::string& p_file, const std::string& p_workingDir = "");
 
+		/**
+		* Apply the given icon image to an executable icon resource.
+		* @note No-op on Linux, as executable files don't embed icons.
+		* @param p_executablePath
+		* @param p_iconData
+		* @param p_iconWidth
+		* @param p_iconHeight
+		*/
+		static bool SetExecutableIcon(
+			const std::filesystem::path& p_executablePath,
+			std::span<const uint8_t> p_iconData,
+			uint32_t p_iconWidth,
+			uint32_t p_iconHeight
+		);
+
 		/**
 		* Open the given file for edition with the default application
 		* @param p_file
@@ -62,4 +80,4 @@ namespace OvTools::Utils
 		*/
 		static bool ExecuteCommand(const std::string_view p_command);
 	};
-}
+}

Sources/OvTools/include/OvTools/Utils/SystemCalls.h

@@ -135,3 +135,19 @@ OvTools::Utils::PathParser::EFileType OvTools::Utils::PathParser::GetFileType(co
 
 	return EFileType::UNKNOWN;
 }
+
+std::filesystem::path OvTools::Utils::PathParser::GetRealPath(
+	const std::filesystem::path& p_path,
+	const std::filesystem::path& p_enginePath,
+	const std::filesystem::path& p_projectPath
+)
+{
+	const std::string normalizedPath = MakeNonWindowsStyle(p_path.string());
+
+	if (!normalizedPath.empty() && normalizedPath[0] == ':')
+	{
+		return (p_enginePath / normalizedPath.substr(1)).lexically_normal();
+	}
+
+	return (p_projectPath / normalizedPath).lexically_normal();
+}