Adds everything
This commit is contained in:
409
Plugins/DLSS/Source/NGXRHI/Public/NGXRHI.h
Normal file
409
Plugins/DLSS/Source/NGXRHI/Public/NGXRHI.h
Normal file
@@ -0,0 +1,409 @@
|
||||
/*
|
||||
* Copyright (c) 2020 NVIDIA CORPORATION. All rights reserved.
|
||||
*
|
||||
* NVIDIA Corporation and its licensors retain all intellectual property and proprietary
|
||||
* rights in and to this software, related documentation and any modifications thereto.
|
||||
* Any use, reproduction, disclosure or distribution of this software and related
|
||||
* documentation without an express license agreement from NVIDIA Corporation is strictly
|
||||
* prohibited.
|
||||
*
|
||||
* TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THIS SOFTWARE IS PROVIDED *AS IS*
|
||||
* AND NVIDIA AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES, EITHER EXPRESS OR IMPLIED,
|
||||
* INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
||||
* PARTICULAR PURPOSE. IN NO EVENT SHALL NVIDIA OR ITS SUPPLIERS BE LIABLE FOR ANY
|
||||
* SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT
|
||||
* LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF
|
||||
* BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
|
||||
* INABILITY TO USE THIS SOFTWARE, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
* SUCH DAMAGES.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Modules/ModuleManager.h"
|
||||
|
||||
#include "CoreMinimal.h"
|
||||
#include "RendererInterface.h"
|
||||
#include "Runtime/Launch/Resources/Version.h"
|
||||
|
||||
#include "nvsdk_ngx_params.h"
|
||||
|
||||
#define NVSDK_NGX_VERSION_API_MACRO_BASE_LINE (0x0000013)
|
||||
#define NVSDK_NGX_VERSION_API_MACRO_WITH_LOGGING (0x0000014)
|
||||
|
||||
struct FDLSSState;
|
||||
|
||||
struct FDLSSFeatureDesc
|
||||
{
|
||||
bool operator != (const FDLSSFeatureDesc& Other) const
|
||||
{
|
||||
return DestRect.Size() != Other.DestRect.Size()
|
||||
|| PerfQuality != Other.PerfQuality
|
||||
|| bHighResolutionMotionVectors != Other.bHighResolutionMotionVectors
|
||||
|| bNonZeroSharpness != Other.bNonZeroSharpness
|
||||
|| bUseAutoExposure != Other.bUseAutoExposure
|
||||
|| bReleaseMemoryOnDelete != Other.bReleaseMemoryOnDelete
|
||||
|| GPUNode != Other.GPUNode
|
||||
|| GPUVisibility != Other.GPUVisibility;
|
||||
}
|
||||
|
||||
bool operator == (const FDLSSFeatureDesc& Other) const
|
||||
{
|
||||
return !operator !=(Other);
|
||||
}
|
||||
|
||||
FIntRect SrcRect = FIntRect(FIntPoint::NoneValue, FIntPoint::NoneValue);
|
||||
FIntRect DestRect = FIntRect(FIntPoint::NoneValue, FIntPoint::NoneValue);
|
||||
int32 PerfQuality = -1;
|
||||
bool bHighResolutionMotionVectors = false;
|
||||
bool bNonZeroSharpness = false;
|
||||
bool bUseAutoExposure = false;
|
||||
bool bReleaseMemoryOnDelete = false;
|
||||
uint32 GPUNode = 0;
|
||||
uint32 GPUVisibility = 0;
|
||||
FString GetDebugDescription() const
|
||||
{
|
||||
auto NGXPerfQualityString = [] (int NGXPerfQuality)
|
||||
{
|
||||
switch (NGXPerfQuality)
|
||||
{
|
||||
case NVSDK_NGX_PerfQuality_Value_MaxPerf:return TEXT("MaxPerf");
|
||||
case NVSDK_NGX_PerfQuality_Value_Balanced:return TEXT("Balanced");
|
||||
case NVSDK_NGX_PerfQuality_Value_MaxQuality:return TEXT("MaxQuality");
|
||||
case NVSDK_NGX_PerfQuality_Value_UltraPerformance:return TEXT("UltraPerformance");
|
||||
case NVSDK_NGX_PerfQuality_Value_UltraQuality:return TEXT("UltraQuality");
|
||||
default:return TEXT("Invalid NVSDK_NGX_PerfQuality_Value");
|
||||
}
|
||||
};
|
||||
return FString::Printf(TEXT("SrcRect=[%dx%d->%dx%d], DestRect=[%dx%d->%dx%d], ScaleX=%f, ScaleY=%f, NGXPerfQuality=%s(%d), bHighResolutionMotionVectors=%d, bNonZeroSharpness=%d, bUseAutoExposure=%d, bReleaseMemoryOnDelete=%d, GPUNode=%u, GPUVisibility=0x%x"),
|
||||
SrcRect.Min.X, SrcRect.Min.Y, SrcRect.Max.X, SrcRect.Max.Y,
|
||||
DestRect.Min.X, DestRect.Min.Y, DestRect.Max.X, DestRect.Max.Y,
|
||||
float(SrcRect.Width()) / float(DestRect.Width()),
|
||||
float(SrcRect.Height()) / float(DestRect.Height()),
|
||||
NGXPerfQualityString(PerfQuality),
|
||||
PerfQuality,
|
||||
bHighResolutionMotionVectors,
|
||||
bNonZeroSharpness,
|
||||
bUseAutoExposure,
|
||||
bReleaseMemoryOnDelete,
|
||||
GPUNode,
|
||||
GPUVisibility);
|
||||
|
||||
}
|
||||
};
|
||||
|
||||
struct NGXRHI_API FRHIDLSSArguments
|
||||
{
|
||||
FRHITexture* InputColor = nullptr;
|
||||
FRHITexture* InputDepth = nullptr;
|
||||
FRHITexture* InputMotionVectors = nullptr;
|
||||
FRHITexture* InputExposure = nullptr;
|
||||
|
||||
FRHITexture* OutputColor = nullptr;
|
||||
|
||||
FIntRect SrcRect = FIntRect(FIntPoint::ZeroValue, FIntPoint::ZeroValue);
|
||||
FIntRect DestRect = FIntRect(FIntPoint::ZeroValue, FIntPoint::ZeroValue);
|
||||
#if ENGINE_MAJOR_VERSION < 5
|
||||
FVector2D JitterOffset= FVector2D::ZeroVector;
|
||||
FVector2D MotionVectorScale{ 1.0f,1.0f };
|
||||
#else
|
||||
FVector2f JitterOffset = FVector2f::ZeroVector;
|
||||
FVector2f MotionVectorScale = FVector2f::UnitVector;
|
||||
#endif
|
||||
bool bHighResolutionMotionVectors = false;
|
||||
|
||||
float Sharpness = 0.0f;
|
||||
bool bReset = false;
|
||||
|
||||
int32 PerfQuality = 0;
|
||||
float DeltaTime = 0.0f;
|
||||
|
||||
float PreExposure = 1.0f;
|
||||
bool bUseAutoExposure = false;
|
||||
|
||||
|
||||
bool bReleaseMemoryOnDelete = false;
|
||||
uint32 GPUNode = 0;
|
||||
uint32 GPUVisibility = 0;
|
||||
void Validate() const;
|
||||
|
||||
inline FDLSSFeatureDesc GetFeatureDesc() const
|
||||
{
|
||||
return FDLSSFeatureDesc{ SrcRect, DestRect, PerfQuality, bHighResolutionMotionVectors, Sharpness != 0.0f, bUseAutoExposure, bReleaseMemoryOnDelete, GPUNode, GPUVisibility};
|
||||
}
|
||||
|
||||
uint32 GetNGXCommonDLSSFeatureFlags() const;
|
||||
NVSDK_NGX_DLSS_Create_Params GetNGXDLSSCreateParams() const;
|
||||
};
|
||||
|
||||
struct FNGXDriverRequirements
|
||||
{
|
||||
bool DriverUpdateRequired = false;
|
||||
int32 MinDriverVersionMajor = 470;
|
||||
int32 MinDriverVersionMinor = 0;
|
||||
};
|
||||
|
||||
// the API specic RHI extensions derive from this to handle the lifetime
|
||||
class NGXRHI_API NGXDLSSFeature
|
||||
{
|
||||
public:
|
||||
virtual ~NGXDLSSFeature() = 0;
|
||||
|
||||
FDLSSFeatureDesc Desc;
|
||||
NVSDK_NGX_Handle* Feature = nullptr;
|
||||
NVSDK_NGX_Parameter* Parameter = nullptr;
|
||||
uint32 LastUsedFrame = 0;
|
||||
|
||||
void Tick(uint32 InFrameNumber)
|
||||
{
|
||||
check(Feature);
|
||||
check(Parameter);
|
||||
LastUsedFrame = InFrameNumber;
|
||||
}
|
||||
|
||||
NGXDLSSFeature(NVSDK_NGX_Handle* InFeature, NVSDK_NGX_Parameter* InParameter, const FDLSSFeatureDesc& InFeatureDesc, uint32 InLastUsedEvaluation)
|
||||
: Desc(InFeatureDesc)
|
||||
, Feature(InFeature)
|
||||
, Parameter(InParameter)
|
||||
, LastUsedFrame(InLastUsedEvaluation)
|
||||
{
|
||||
check(!IsRunningRHIInSeparateThread() || IsInRHIThread());
|
||||
check(Feature);
|
||||
check(Parameter);
|
||||
}
|
||||
bool IsValid() const
|
||||
{
|
||||
return Feature && Parameter;
|
||||
}
|
||||
};
|
||||
|
||||
struct NGXRHI_API FDLSSState
|
||||
{
|
||||
// this is used by the RHIs to see whether they need to recreate the NGX feature
|
||||
|
||||
bool RequiresFeatureRecreation(const FRHIDLSSArguments& InArguments);
|
||||
|
||||
bool HasValidFeature() const
|
||||
{
|
||||
return DLSSFeature && DLSSFeature->IsValid();
|
||||
}
|
||||
|
||||
// this is stored via pointer to allow the NGXRHIs use the API specific functions to create & release
|
||||
TSharedPtr<NGXDLSSFeature> DLSSFeature;
|
||||
};
|
||||
|
||||
using FDLSSStateRef = TSharedPtr<FDLSSState, ESPMode::ThreadSafe>;
|
||||
|
||||
enum class ENGXBinariesSearchOrder
|
||||
{
|
||||
MinValue = 0,
|
||||
CustomThenGeneric = 0,
|
||||
ForceGeneric = 1,
|
||||
ForceCustom = 2,
|
||||
ForceDevelopmentGeneric = 3,
|
||||
MaxValue = ForceDevelopmentGeneric
|
||||
};
|
||||
|
||||
enum class ENGXProjectIdentifier
|
||||
{
|
||||
MinValue = 0,
|
||||
NGXApplicationIDThenUEProjectID = 0,
|
||||
ForceUEProjectID = 1,
|
||||
ForceNGXApplicationID = 2,
|
||||
MaxValue = ForceNGXApplicationID
|
||||
};
|
||||
|
||||
struct FNGXRHICreateArguments
|
||||
{
|
||||
FString PluginBaseDir;
|
||||
FDynamicRHI* DynamicRHI = nullptr;
|
||||
ENGXBinariesSearchOrder NGXBinariesSearchOrder = ENGXBinariesSearchOrder::CustomThenGeneric;
|
||||
|
||||
ENGXProjectIdentifier ProjectIdentifier = ENGXProjectIdentifier::NGXApplicationIDThenUEProjectID;
|
||||
uint32 NGXAppId = 0;
|
||||
FString UnrealEngineVersion;
|
||||
FString UnrealProjectID;
|
||||
|
||||
// centralize that logic here for the derived NGXRHIs
|
||||
bool InitializeNGXWithNGXApplicationID() const
|
||||
{
|
||||
if ((ProjectIdentifier == ENGXProjectIdentifier::NGXApplicationIDThenUEProjectID) && (NGXAppId != 0))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
else if (ProjectIdentifier == ENGXProjectIdentifier::ForceNGXApplicationID)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
else
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
struct FDLSSOptimalSettings
|
||||
{
|
||||
FIntPoint RenderSize;
|
||||
|
||||
FIntPoint RenderSizeMin;
|
||||
FIntPoint RenderSizeMax;
|
||||
float Sharpness;
|
||||
|
||||
bool bIsSupported;
|
||||
float OptimalResolutionFraction;
|
||||
|
||||
float MinResolutionFraction;
|
||||
float MaxResolutionFraction;
|
||||
|
||||
bool IsFixedResolution() const
|
||||
{
|
||||
return MinResolutionFraction == MaxResolutionFraction;
|
||||
}
|
||||
};
|
||||
|
||||
class NGXRHI_API NGXRHI
|
||||
{
|
||||
struct NGXRHI_API FDLSSQueryFeature
|
||||
{
|
||||
struct FDLSSResolutionParameters
|
||||
{
|
||||
uint32 Width = 0;
|
||||
uint32 Height = 0;
|
||||
NVSDK_NGX_PerfQuality_Value PerfQuality = NVSDK_NGX_PerfQuality_Value_MaxPerf;
|
||||
|
||||
|
||||
FDLSSResolutionParameters(uint32 InWidth, uint32 InHeight, NVSDK_NGX_PerfQuality_Value InPerfQuality)
|
||||
: Width(InWidth)
|
||||
, Height(InHeight)
|
||||
, PerfQuality(InPerfQuality)
|
||||
{}
|
||||
};
|
||||
|
||||
void QueryDLSSSupport();
|
||||
FDLSSOptimalSettings GetDLSSOptimalSettings(const FDLSSResolutionParameters& InResolution) const;
|
||||
|
||||
// the lifetime of this is managed directly by the encompassing derived RHI
|
||||
NVSDK_NGX_Parameter* CapabilityParameters = nullptr;
|
||||
|
||||
bool bIsAvailable = false;
|
||||
FNGXDriverRequirements DriverRequirements;
|
||||
|
||||
NVSDK_NGX_Result DLSSInitResult = NVSDK_NGX_Result_Fail;
|
||||
};
|
||||
|
||||
|
||||
public:
|
||||
|
||||
|
||||
virtual ~NGXRHI();
|
||||
|
||||
virtual void ExecuteDLSS(FRHICommandList& CmdList, const FRHIDLSSArguments& InArguments, FDLSSStateRef InDLSSState) = 0;
|
||||
|
||||
bool IsDLSSAvailable() const
|
||||
{
|
||||
return DLSSQueryFeature.bIsAvailable;
|
||||
}
|
||||
|
||||
NVSDK_NGX_Result GetDLSSInitResult() const
|
||||
{
|
||||
return DLSSQueryFeature.DLSSInitResult;
|
||||
}
|
||||
|
||||
const FNGXDriverRequirements& GetDLSSDriverRequirements() const
|
||||
{
|
||||
return DLSSQueryFeature.DriverRequirements;
|
||||
}
|
||||
|
||||
FDLSSOptimalSettings GetDLSSOptimalSettings(const FDLSSQueryFeature::FDLSSResolutionParameters& InResolution) const
|
||||
{
|
||||
return DLSSQueryFeature.GetDLSSOptimalSettings(InResolution);
|
||||
}
|
||||
|
||||
FDLSSOptimalSettings GetDLSSOptimalSettings(NVSDK_NGX_PerfQuality_Value QualityLevel) const
|
||||
{
|
||||
return DLSSQueryFeature.GetDLSSOptimalSettings(FDLSSQueryFeature::FDLSSResolutionParameters(1000, 1000, QualityLevel));
|
||||
}
|
||||
|
||||
float GetDLSSResolutionFraction(NVSDK_NGX_PerfQuality_Value QualityLevel) const
|
||||
{
|
||||
return GetDLSSOptimalSettings(QualityLevel).OptimalResolutionFraction;
|
||||
}
|
||||
|
||||
TPair<FString, bool> GetDLSSGenericBinaryInfo() const;
|
||||
TPair<FString, bool> GetDLSSCustomBinaryInfo() const;
|
||||
|
||||
void TickPoolElements();
|
||||
|
||||
static bool SupportsAllocateParameters()
|
||||
{
|
||||
return bSupportsAllocateParameters;
|
||||
}
|
||||
|
||||
static bool NGXInitialized()
|
||||
{
|
||||
return bNGXInitialized;
|
||||
}
|
||||
|
||||
static bool IsIncompatibleAPICaptureToolActive()
|
||||
{
|
||||
return bIsIncompatibleAPICaptureToolActive;
|
||||
}
|
||||
|
||||
|
||||
protected:
|
||||
|
||||
NGXRHI(const FNGXRHICreateArguments& Arguments);
|
||||
|
||||
const NVSDK_NGX_FeatureCommonInfo* CommonFeatureInfo() const
|
||||
{
|
||||
return &FeatureInfo;
|
||||
}
|
||||
|
||||
void RegisterFeature(TSharedPtr<NGXDLSSFeature> InFeature);
|
||||
TSharedPtr<NGXDLSSFeature> FindFreeFeature(const FRHIDLSSArguments& InArguments);
|
||||
|
||||
void ReleaseAllocatedFeatures();
|
||||
void ApplyCommonNGXParameterSettings(NVSDK_NGX_Parameter* Parameter, const FRHIDLSSArguments& InArguments);
|
||||
static FString GetNGXLogDirectory();
|
||||
|
||||
|
||||
|
||||
|
||||
FDynamicRHI* DynamicRHI = nullptr;
|
||||
|
||||
FDLSSQueryFeature DLSSQueryFeature;
|
||||
|
||||
uint32 FrameCounter = 1;
|
||||
|
||||
static bool bNGXInitialized;
|
||||
static bool bSupportsAllocateParameters;
|
||||
static bool bIsIncompatibleAPICaptureToolActive;
|
||||
private:
|
||||
TArray< TSharedPtr<NGXDLSSFeature>> AllocatedDLSSFeatures;
|
||||
|
||||
TTuple<FString, bool> DLSSGenericBinaryInfo;
|
||||
TTuple<FString, bool> DLSSCustomBinaryInfo;
|
||||
|
||||
TArray<FString> NGXDLLSearchPaths;
|
||||
TArray<const wchar_t*> NGXDLLSearchPathRawStrings;
|
||||
|
||||
NVSDK_NGX_FeatureCommonInfo FeatureInfo = {{0}};
|
||||
};
|
||||
|
||||
|
||||
// Implemented by the API specific modules
|
||||
class INGXRHIModule : public IModuleInterface
|
||||
{
|
||||
public:
|
||||
virtual TUniquePtr<NGXRHI> CreateNGXRHI(const FNGXRHICreateArguments& Arguments) = 0;
|
||||
};
|
||||
|
||||
class FNGXRHIModule final : public IModuleInterface
|
||||
{
|
||||
public:
|
||||
|
||||
/** IModuleInterface implementation */
|
||||
virtual void StartupModule();
|
||||
virtual void ShutdownModule();
|
||||
};
|
||||
Reference in New Issue
Block a user