DeviceProfile.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    DeviceProfile.h: Declares the UDeviceProfile class.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Engine/TextureLODSettings.h"
#include "DeviceProfiles/DeviceProfileMatching.h"
#include "DeviceProfile.generated.h"
 
struct FPropertyChangedEvent;
 
DECLARE_DELEGATE(FOnCVarsUpdated);
 
 
UCLASS(config=DeviceProfiles, perObjectConfig, MinimalAPI)
class UDeviceProfile : public UTextureLODSettings
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(VisibleAnywhere, config, Category=DeviceSettings)
    FString DeviceType;
 
    UPROPERTY(EditAnywhere, config, Category=DeviceSettings)
    FString BaseProfileName;
 
    UPROPERTY(EditAnywhere, config, Category = DeviceSettings)
    uint32 bIsVisibleForAssets : 1;
 
    UPROPERTY()
    TObjectPtr<UDeviceProfile> Parent;
 
    bool bVisible;
 
    FString ConfigPlatform;
 
    TArray<FString> FragmentIncludes;
 
public:
 
    /* Need to add missing entries in TextureLODGroups to match enum TextureGroup when the device profile is reloaded*/
    virtual void PostReloadConfig(class FProperty* PropertyThatWasLoaded) override
    {
        Super::PostReloadConfig(PropertyThatWasLoaded);
 
        ValidateTextureLODGroups();
    }
 
    UPROPERTY(EditAnywhere, config, Category=ConsoleVariables)
    TArray<FString> CVars;
 
    UPROPERTY(EditAnywhere, config, Category = "DeviceProfile Matching Rules")
    TArray<FDPMatchingRulestruct> MatchingRules;
 
    virtual const TCHAR* GetConfigOverridePlatform() const override
    {
        return ConfigPlatform.Len() ? *ConfigPlatform : Super::GetConfigOverridePlatform();
    }
 
    ENGINE_API void GatherParentCVarInformationRecursively(OUT TMap<FString, FString>& CVarInformation) const;
 
    FOnCVarsUpdated& OnCVarsUpdated()
    {
        return CVarsUpdatedDelegate;
    }
 
    ENGINE_API const FSelectedFragmentProperties* GetFragmentByTag(FName& FragmentTag) const;
 
    bool IsVisibleForAssets()const { return bIsVisibleForAssets; }
public:
    ENGINE_API UTextureLODSettings* GetTextureLODSettings() const;
 
    ENGINE_API UDeviceProfile* GetParentProfile(bool bIncludeDefaultObject = false) const;
    
private:
    // Make sure our TextureLODGroups array is sorted correctly and complete
    ENGINE_API void ValidateTextureLODGroups();
    FOnCVarsUpdated CVarsUpdatedDelegate;
 
public:
    // The selected result after running the MatchingRules process.
    TArray<FSelectedFragmentProperties> SelectedFragments;
 
    /* ValidateProfile()
    * Validate the Profile after changes by loading it's config (.ini)
    */
    ENGINE_API void ValidateProfile();
 
    //~ Begin UObject Interface
    ENGINE_API virtual void BeginDestroy() override;
    //~ End UObject Interface
 
#if WITH_EDITOR
    //~ Begin UObject Interface
    ENGINE_API virtual void PostEditChangeProperty( FPropertyChangedEvent& PropertyChangedEvent ) override;
    //~ End UObject Interface
 
    ENGINE_API bool ModifyCVarValue(const FString& CVarName, const FString& CVarValue, bool bAddIfNonExistant = false);
    ENGINE_API FString GetCVarValue(const FString& CVarName) const;
 
    UE_DEPRECATED(5.6, "GetConsolidatedCVars is no longer supported due to being non-thread safe, use ForEachConsolidatedCvar or GetConsolidatedCVarValue instead")
    ENGINE_API const TMap<FString, FString>& GetConsolidatedCVars() const;
 
    ENGINE_API void ForEachConsolidatedCVar(const TFunctionRef<bool(const FString&, const FString&)>& FuncRef) const;
 
    ENGINE_API bool GetConsolidatedCVarValue(const TCHAR* CVarName, FString& OutString, bool bCheckDefaults = false) const;
 
    ENGINE_API bool GetConsolidatedCVarValue(const TCHAR* CVarName, int32& OutValue, bool bCheckDefaults = false) const;
 
    ENGINE_API bool GetConsolidatedCVarValue(const TCHAR* CVarName, float& OutValue, bool bCheckDefaults = false) const;
 
private:
    ENGINE_API void HandleCVarsChanged();
 
private:
    mutable TMap<FString, FString> ConsolidatedCVars;
    mutable FCriticalSection CVarsLock;
 
#endif
 
#if ALLOW_OTHER_PLATFORM_CONFIG
public:
    ENGINE_API const TMap<FString, FString>& GetAllExpandedCVars();
    ENGINE_API const TMap<FString, FString>& GetAllPreviewCVars();
    ENGINE_API void ClearAllExpandedCVars();
    ENGINE_API void SetPreviewMemorySizeBucket(EPlatformMemorySizeBucket PreviewMemorySizeBucketIn);
    ENGINE_API EPlatformMemorySizeBucket GetPreviewMemorySizeBucket() const;
 
private:
    
    // calculate the cvars for another platform's deviceprofile
    ENGINE_API void ExpandDeviceProfileCVars();
        
    TMap<FString, FString> AllExpandedCVars;
 
    TMap<FString, FString> AllPreviewCVars;
 
    EPlatformMemorySizeBucket PreviewMemorySizeBucket = EPlatformMemorySizeBucket::Default;
#endif
};