UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ISynthBenchmark Class Referenceabstract

#include <SynthBenchmark.h>

+ Inheritance diagram for ISynthBenchmark:

Public Member Functions

virtual void Run (FSynthBenchmarkResults &Out, bool bGPUBenchmark=true, float WorkScale=10.0f) const =0
 
virtual void GetRHIDisplay (FGPUAdpater &Out) const =0
 
virtual void GetRHIInfo (FGPUAdpater &Out, FString &RHIName) const =0
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void StartupModule ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual void ShutdownModule ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Static Public Member Functions

static ISynthBenchmarkGet ()
 
static bool IsAvailable ()
 

Detailed Description

The public interface to this module

Member Function Documentation

◆ Get()

static ISynthBenchmark & ISynthBenchmark::Get ( )
inlinestatic

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns
Returns singleton instance, loading the module on demand if needed

◆ GetRHIDisplay()

virtual void ISynthBenchmark::GetRHIDisplay ( FGPUAdpater Out) const
pure virtual

◆ GetRHIInfo()

virtual void ISynthBenchmark::GetRHIInfo ( FGPUAdpater Out,
FString &  RHIName 
) const
pure virtual

◆ IsAvailable()

static bool ISynthBenchmark::IsAvailable ( )
inlinestatic

Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.

Returns
True if the module is loaded and ready to use

◆ Run()

virtual void ISynthBenchmark::Run ( FSynthBenchmarkResults Out,
bool  bGPUBenchmark = true,
float  WorkScale = 10.0f 
) const
pure virtual

The documentation for this class was generated from the following file: