Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > TraceInsights > Insights > IUnrealInsightsModule

Light Theme

Dark Theme

IUnrealInsightsModule

Interface for an Unreal Insights module.

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

IUnrealInsightsModule

References

Module	TraceInsights
Header	/Engine/Source/Developer/TraceInsights/Public/Insights/IUnrealInsightsModule.h
Include	#include "Insights/IUnrealInsightsModule.h"

Syntax

class IUnrealInsightsModule : public IModuleInterface

Remarks

Interface for an Unreal Insights module.

Functions

	Name	Description
bool	ConnectToStore ( const TCHAR* InStoreHost, uint32 InStorePort )	Connects to a specified store.
void	CreateDefaultStore()	Creates the default trace store (for "Browser" mode).
void	CreateSessionBrowser ( bool bAllowDebugTools, bool bSingleProcess )	Called when the application starts in "Browser" mode.
void	CreateSessionViewer ( bool bAllowDebugTools )	Called when the application starts in "Viewer" mode.
TSharedPtr< ...	GetAnalysisSession()	Gets the current analysis session.
Trace::FStor...	GetStoreClient()	Gets the store client.
FOnInsightsM...	OnMajorTabCreated()	Callback invoked when a major tab is created
FOnRegisterM...	OnRegisterMajorTabExtension ( const FName& InMajorTabId )	Allows for registering a delegate callback for populating a FInsightsMajorTabExtender structure.
void	RegisterMajorTabConfig ( const FName& InMajorTabId, const FInsightsMajorTabConfig& InC... )	Registers a major tab layout.
void	SetUnrealInsightsLayoutIni ( const FString& InIniPath )	Set the ini path for saving persistent layout data.
void	ShutdownUserInterface()	Called when the application shutsdown.
void	StartAnalysisForLastLiveSession()	Starts analysis of the last live session. Called when the application starts in "Viewer" mode.
void	StartAnalysisForTrace ( uint32 InTraceId )	Starts analysis of the specified trace. Called when the application starts in "Viewer" mode.
void	StartAnalysisForTraceFile ( const TCHAR* InTraceFile )	Starts analysis of the specified *.utrace file.
void	UnregisterMajorTabConfig ( const FName& InMajorTabId )	Unregisters a major tab layout. This will revert the major tab to spawning with its default layout

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss