Enforced IWYU-style PCH model:

- Removed explicit PCH.
- Fixed includes to compile for all supported engine versions, including non-unity builds.
- Configured build.cs to treat ImGui as an engine module and added stricter compilation rules.

README.md

@@ -13,7 +13,7 @@ Version: 1.20
 
 ImGui version: 1.74
 
-Supported engine version: 4.24*
+Supported engine version: 4.25*
 
 \* *Plugin has been tested and if necessary updated to compile and work with this engine version. As long as possible I will try to maintain backward compatibility of existing features and possibly but not necessarily when adding new features. Right now it should be at least backward compatible with the engine version 4.15.*
 

Source/ImGui/ImGui.Build.cs

@@ -23,10 +23,12 @@ public class ImGui : ModuleRules
 		// Enable runtime loader, if you want this module to be automatically loaded in runtime builds (monolithic).
 		bool bEnableRuntimeLoader = true;
 
-		PCHUsage = PCHUsageMode.UseSharedPCHs;
+		PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
 
-#if UE_4_21_OR_LATER
+#if UE_4_24_OR_LATER
-		PrivatePCHHeaderFile = "Private/ImGuiPrivatePCH.h";
+		bLegacyPublicIncludePaths = false;
+		ShadowVariableWarningLevel = WarningLevel.Error;
+		bTreatAsEngineModule = true;
 #endif
 
 		PublicIncludePaths.AddRange(

Source/ImGui/Private/Editor/ImGuiCanvasSizeInfoCustomization.cpp

@@ -1,11 +1,9 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
+#include "ImGuiCanvasSizeInfoCustomization.h"
 
 #if WITH_EDITOR
 
-#include "ImGuiCanvasSizeInfoCustomization.h"
-
 #include "ImGuiModuleSettings.h"
 
 #include <PropertyCustomizationHelpers.h>

Source/ImGui/Private/Editor/ImGuiEditor.cpp

@@ -1,11 +1,9 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
+#include "ImGuiEditor.h"
 
 #if WITH_EDITOR
 
-#include "ImGuiEditor.h"
-
 #include "ImGuiCanvasSizeInfoCustomization.h"
 #include "ImGuiKeyInfoCustomization.h"
 #include "ImGuiModuleSettings.h"

Source/ImGui/Private/Editor/ImGuiKeyInfoCustomization.cpp

@@ -1,11 +1,9 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
+#include "ImGuiKeyInfoCustomization.h"
 
 #if WITH_EDITOR
 
-#include "ImGuiKeyInfoCustomization.h"
-
 #include "ImGuiModuleSettings.h"
 
 #include <PropertyCustomizationHelpers.h>

Source/ImGui/Private/ImGuiContextManager.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiContextManager.h"
 
 #include "ImGuiDelegatesContainer.h"

Source/ImGui/Private/ImGuiContextManager.h

@@ -3,6 +3,7 @@
 #pragma once
 
 #include "ImGuiContextProxy.h"
+#include "VersionCompatibility.h"
 
 
 class FImGuiModuleSettings;

Source/ImGui/Private/ImGuiContextProxy.cpp

@@ -1,13 +1,12 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiContextProxy.h"
 
 #include "ImGuiDelegatesContainer.h"
 #include "ImGuiImplementation.h"
 #include "ImGuiInteroperability.h"
 #include "Utilities/Arrays.h"
+#include "VersionCompatibility.h"
 
 #include <GenericPlatform/GenericPlatformFile.h>
 #include <Misc/Paths.h>

Source/ImGui/Private/ImGuiDelegates.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiDelegates.h"
 #include "ImGuiDelegatesContainer.h"
 

Source/ImGui/Private/ImGuiDelegatesContainer.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiDelegatesContainer.h"
 
 #include "Utilities/WorldContextIndex.h"

Source/ImGui/Private/ImGuiDemo.cpp

@@ -1,8 +1,7 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiDemo.h"
+
 #include "ImGuiModuleProperties.h"
 
 #include <CoreGlobals.h>

Source/ImGui/Private/ImGuiDemo.h

@@ -2,6 +2,8 @@
 
 #pragma once
 
+#include <CoreMinimal.h>
+
 #include <imgui.h>
 
 class FImGuiModuleProperties;

Source/ImGui/Private/ImGuiDrawData.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiDrawData.h"
 
 

Source/ImGui/Private/ImGuiDrawData.h

@@ -3,6 +3,7 @@
 #pragma once
 
 #include "ImGuiInteroperability.h"
+#include "VersionCompatibility.h"
 
 #include <Rendering/RenderingCommon.h>
 

Source/ImGui/Private/ImGuiImplementation.cpp

@@ -1,12 +1,10 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
+#include "ImGuiImplementation.h"
 
-// We build ImGui source code as part of this module. This is for convenience (no need to manually build libraries for
+#include <CoreMinimal.h>
-// different target platforms) but it also exposes the whole ImGui source for inspection, which can be pretty handy.
+
-// Source files are included from Third Party directory, so we can wrap them in required by Unreal Build System headers
+// For convenience and easy access to the ImGui source code, we build it as part of this module.
-// without modifications in ImGui source code.
-//
 // We don't need to define IMGUI_API manually because it is already done for this module.
 
 #if PLATFORM_XBOXONE
@@ -20,8 +18,6 @@
 #endif // PLATFORM_WINDOWS
 
 #if WITH_EDITOR
-#include "imgui.h"
-
 // Global ImGui context pointer.
 ImGuiContext* GImGuiContextPtr = nullptr;
 // Handle to the global ImGui context pointer.

Source/ImGui/Private/ImGuiImplementation.h

@@ -2,8 +2,7 @@
 
 #pragma once
 
-#include <imgui.h>
+struct ImGuiContext;
-
 
 // Gives access to selected ImGui implementation features.
 namespace ImGuiImplementation

Source/ImGui/Private/ImGuiInputHandler.cpp

@@ -1,17 +1,18 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiInputHandler.h"
 
 #include "ImGuiContextProxy.h"
 #include "ImGuiInputState.h"
+#include "ImGuiModuleDebug.h"
 #include "ImGuiModuleManager.h"
 #include "ImGuiModuleSettings.h"
+#include "VersionCompatibility.h"
 
 #include <Engine/Console.h>
 #include <Framework/Application/SlateApplication.h>
 #include <GameFramework/InputSettings.h>
+#include <InputCoreTypes.h>
 #include <Input/Events.h>
 
 #if WITH_EDITOR

Source/ImGui/Private/ImGuiInputHandlerFactory.cpp

@@ -1,11 +1,12 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiInputHandlerFactory.h"
 #include "ImGuiInputHandler.h"
 
+#include "ImGuiModuleDebug.h"
+
 #include <Engine/GameViewportClient.h>
+#include <InputCoreTypes.h>
 
 
 UImGuiInputHandler* FImGuiInputHandlerFactory::NewHandler(const FStringClassReference& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex)

Source/ImGui/Private/ImGuiInputState.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiInputState.h"
 
 #include <algorithm>

Source/ImGui/Private/ImGuiInteroperability.cpp

@@ -1,8 +1,7 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiInteroperability.h"
+
 #include "ImGuiInputState.h"
 #include "Utilities/Arrays.h"
 

Source/ImGui/Private/ImGuiModule.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiModule.h"
 
 #include "ImGuiDelegatesContainer.h"

Source/ImGui/Private/ImGuiModuleCommands.cpp

@@ -1,10 +1,8 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiModuleCommands.h"
-#include "ImGuiModuleProperties.h"
 
+#include "ImGuiModuleProperties.h"
 #include "Utilities/DebugExecBindings.h"
 
 

Source/ImGui/Private/ImGuiModuleManager.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiModuleManager.h"
 
 #include "ImGuiInteroperability.h"

Source/ImGui/Private/ImGuiModuleSettings.cpp

@@ -1,15 +1,13 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiModuleSettings.h"
 
 #include "ImGuiModuleCommands.h"
 #include "ImGuiModuleProperties.h"
 
-#include <ConfigCacheIni.h>
 #include <Engine/Engine.h>
 #include <GameFramework/GameUserSettings.h>
+#include <Misc/ConfigCacheIni.h>
 
 
 //====================================================================================================

Source/ImGui/Private/ImGuiModuleSettings.h

@@ -4,9 +4,10 @@
 
 #include "VersionCompatibility.h"
 
-#include <SlateTypes.h>
 #include <Curves/CurveFloat.h>
 #include <Delegates/Delegate.h>
+#include <InputCoreTypes.h>
+#include <Styling/SlateTypes.h>
 #include <UObject/Object.h>
 
 // We use FStringClassReference, which is supported by older and newer engine versions. Starting from 4.18, it is

Source/ImGui/Private/ImGuiPrivatePCH.h

@@ -1,15 +0,0 @@
-// Distributed under the MIT License (MIT) (see accompanying LICENSE file)
-
-// Module-wide macros
-#include "VersionCompatibility.h"
-#include "ImGuiModuleDebug.h"
-
-// Module
-#include "ImGuiModule.h"
-
-// Engine
-#include <CoreMinimal.h>
-#include <Engine/Engine.h>
-
-// You should place include statements to your module's private header files here.  You only need to
-// add includes for headers that are used in most of your module's source files though.

Source/ImGui/Private/ImGuiTextureHandle.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "ImGuiTextureHandle.h"
 
 #include "ImGuiInteroperability.h"

Source/ImGui/Private/TextureManager.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "TextureManager.h"
 
 #include <Engine/Texture2D.h>

Source/ImGui/Private/TextureManager.h

@@ -4,6 +4,7 @@
 
 #include <Styling/SlateBrush.h>
 #include <Textures/SlateShaderResource.h>
+#include <UObject/WeakObjectPtr.h>
 
 
 class UTexture2D;

Source/ImGui/Private/Utilities/DebugExecBindings.cpp

@@ -1,8 +1,7 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "DebugExecBindings.h"
+
 #include "ImGuiModuleSettings.h"
 
 #include <GameFramework/PlayerInput.h>

Source/ImGui/Private/Utilities/DebugExecBindings.h

@@ -2,6 +2,7 @@
 
 #pragma once
 
+class FString;
 struct FImGuiKeyInfo;
 
 namespace DebugExecBindings

Source/ImGui/Private/Utilities/WorldContext.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "WorldContext.h"
 
 

Source/ImGui/Private/Utilities/WorldContext.h

@@ -2,10 +2,10 @@
 
 #pragma once
 
-#include <CoreMinimal.h>
 #include <Engine/Engine.h>
 #include <Engine/GameInstance.h>
 #include <Engine/GameViewportClient.h>
+#include <UObject/WeakObjectPtr.h>
 
 
 // Utilities helping to get a World Context.

Source/ImGui/Private/Widgets/SImGuiCanvasControl.cpp

@@ -1,9 +1,9 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "SImGuiCanvasControl.h"
 
+#include "VersionCompatibility.h"
+
 #include <Rendering/DrawElements.h>
 #include <SlateOptMacros.h>
 

Source/ImGui/Private/Widgets/SImGuiCanvasControl.h

@@ -3,7 +3,6 @@
 #pragma once
 
 #include "ImGuiInputState.h"
-#include "ImGuiModuleDebug.h"
 #include "ImGuiModuleSettings.h"
 
 #include <Brushes/SlateBorderBrush.h>

Source/ImGui/Private/Widgets/SImGuiLayout.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "SImGuiLayout.h"
 #include "SImGuiWidget.h"
 

Source/ImGui/Private/Widgets/SImGuiLayout.h

@@ -2,6 +2,7 @@
 
 #pragma once
 
+#include <UObject/WeakObjectPtr.h>
 #include <Widgets/DeclarativeSyntaxSupport.h>
 #include <Widgets/SCompoundWidget.h>
 

Source/ImGui/Private/Widgets/SImGuiWidget.cpp

@@ -1,7 +1,5 @@
 // Distributed under the MIT License (MIT) (see accompanying LICENSE file)
 
-#include "ImGuiPrivatePCH.h"
-
 #include "SImGuiWidget.h"
 #include "SImGuiCanvasControl.h"
 
@@ -15,6 +13,7 @@
 #include "TextureManager.h"
 #include "Utilities/Arrays.h"
 #include "Utilities/ScopeGuards.h"
+#include "VersionCompatibility.h"
 
 #include <Engine/Console.h>
 #include <Engine/GameViewportClient.h>

Source/ImGui/Private/Widgets/SImGuiWidget.h

@@ -6,6 +6,7 @@
 #include "ImGuiModuleSettings.h"
 
 #include <Rendering/RenderingCommon.h>
+#include <UObject/WeakObjectPtr.h>
 #include <Widgets/DeclarativeSyntaxSupport.h>
 #include <Widgets/SCompoundWidget.h>