SynthBenchmark.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
 
struct FGPUAdpater;
struct FSynthBenchmarkResults;
 
class ISynthBenchmark : public IModuleInterface
{
 
public:
 
    // @param >0, WorkScale 10 for normal precision and runtime of less than a second
    virtual void Run(FSynthBenchmarkResults& Out, bool bGPUBenchmark = true, float WorkScale = 10.0f) const = 0;
 
    // could be moved out of SynthBenchmark, it only requires the RHI, only returns valid data after the RHI started up
    virtual void GetRHIDisplay(FGPUAdpater& Out) const = 0;
    virtual void GetRHIInfo(FGPUAdpater& Out, FString& RHIName) const = 0;
 
    static inline ISynthBenchmark& Get()
    {
        return FModuleManager::LoadModuleChecked< ISynthBenchmark >( "SynthBenchmark" );
    }
 
    static inline bool IsAvailable()
    {
        return FModuleManager::Get().IsModuleLoaded( "SynthBenchmark" );
    }
};