TextureLODSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Engine/TextureDefines.h"
#include "TextureLODSettings.generated.h"
 
class UTexture;
enum class EVTProducerPriority : uint8;
 
USTRUCT()
struct FTextureLODGroup
{
    GENERATED_USTRUCT_BODY()
 
    FTextureLODGroup()
    {
        SetupGroup();
    }
 
    UPROPERTY()
    TEnumAsByte<TextureGroup> Group = TEXTUREGROUP_World;
    
    ETextureSamplerFilter Filter;
 
    UPROPERTY()
    TEnumAsByte<TextureMipGenSettings> MipGenSettings = TextureMipGenSettings::TMGS_SimpleAverage;
    
    UPROPERTY()
    ETextureMipLoadOptions MipLoadOptions = ETextureMipLoadOptions::AllMips;
 
    int32 MaxLODMipCount = 32;
    
    UPROPERTY()
    int32 LODBias = 0;
 
    UPROPERTY()
    int32 LODBias_Smaller = -1;
 
    UPROPERTY()
    int32 LODBias_Smallest = -1;
    
    UPROPERTY()
    int32 LODBias_VT = 0;
 
    UPROPERTY()
    int32 NumStreamedMips = -1;
 
    UPROPERTY()
    int32 MinLODSize = 1;
 
    UPROPERTY()
    int32 MaxLODSize = 4096;
 
    UPROPERTY()
    int32 MaxLODSize_Smaller = -1;
 
    UPROPERTY()
    int32 MaxLODSize_Smallest = -1;
 
    UPROPERTY()
    int32 MaxLODSize_VT = 0;
 
    UPROPERTY()
    int32 OptionalLODBias = 0;
 
    UPROPERTY()
    int32 OptionalMaxLODSize = 4096;
 
    UPROPERTY()
    FName MinMagFilter = NAME_Aniso;
 
    UPROPERTY()
    FName MipFilter = NAME_Point;
 
    UPROPERTY()
    uint8 HighPriorityLoad : 1 = false;
 
    UPROPERTY()
    uint8 DuplicateNonOptionalMips : 1 = false;
    
    UPROPERTY()
    uint8 CookPlatformTilingDisabled : 1 = false;
 
    UPROPERTY()
    ETextureDownscaleOptions DownscaleOptions = ETextureDownscaleOptions::Default;
    
    UPROPERTY()
    TEnumAsByte<ETextureLossyCompressionAmount> LossyCompressionAmount = TLCA_Default;
    
    UPROPERTY()
    float Downscale = 1.0;
 
    UPROPERTY()
    int32 VirtualTextureTileCountBias = 0;
 
    UPROPERTY()
    int32 VirtualTextureTileSizeBias = 0;
 
    UPROPERTY()
    EVTProducerPriority VirtualTextureStreamingPriority;
 
    UPROPERTY()
    int32 MaxAniso = 0;
 
    ENGINE_API void SetupGroup();
 
    ENGINE_API bool operator==(const FTextureLODGroup& Other) const;
};
 
UCLASS(config=DeviceProfiles, perObjectConfig, MinimalAPI)
class UTextureLODSettings : public UObject
{
    GENERATED_UCLASS_BODY()
 
public:
 
 
    ENGINE_API int32 CalculateLODBias(const UTexture* Texture, bool bIncCinematicMips = true) const;
 
    ENGINE_API int32 CalculateLODBias( int32 Width, int32 Height, int32 MaxSize, int32 LODGroup, int32 LODBias, int32 NumCinematicMipLevels, TextureMipGenSettings MipGenSetting, bool bVirtualTexture ) const;
 
    ENGINE_API int32 CalculateNumOptionalMips(int32 LODGroup, const int32 Width, const int32 Height, const int32 NumMips, const int32 MinMipToInline, TextureMipGenSettings InMipGenSetting) const;
 
#if WITH_EDITORONLY_DATA
    ENGINE_API void GetMipGenSettings( const UTexture& Texture, TextureMipGenSettings& OutMipGenSettings, float& OutSharpen, uint32& OutKernelSize, bool& bOutDownsampleWithAverage, bool& bOutSharpenWithoutColorShift, bool &bOutBorderColorBlack ) const;
    ENGINE_API void GetDownscaleOptions(const UTexture& Texture, const ITargetPlatform& CurrentPlatform, float& Downscale, ETextureDownscaleOptions& DownscaleOptions) const;
#endif // #if WITH_EDITORONLY_DATA
 
    ENGINE_API ETextureSamplerFilter GetSamplerFilter(const UTexture* Texture) const;
 
    ENGINE_API ETextureSamplerFilter GetSamplerFilter(int32 InLODGroup) const;
 
    ENGINE_API ETextureMipLoadOptions GetMipLoadOptions(const UTexture* Texture) const;
 
    ENGINE_API const TextureMipGenSettings GetTextureMipGenSettings( int32 InLODGroup ) const; 
 
 
    static ENGINE_API TArray<FString> GetTextureGroupNames();
 
    ENGINE_API FTextureLODGroup& GetTextureLODGroup(TextureGroup GroupIndex);
 
    ENGINE_API const FTextureLODGroup& GetTextureLODGroup(TextureGroup GroupIndex) const;
 
protected:
    ENGINE_API void SetupLODGroup(int32 GroupId);
 
public:
 
    UPROPERTY(EditAnywhere, config, Category="Texture LOD Settings")
    TArray<FTextureLODGroup> TextureLODGroups;
 
#if ALLOW_OTHER_PLATFORM_CONFIG
public:
    ENGINE_API void SetPreviewTextureGroupRedirect(UTextureLODSettings* InPreviewTextureGroupRedirect);
 
    UTextureLODSettings* GetPreviewTextureGroupRedirect() const
    {
        return PreviewTextureGroupRedirect;
    }
 
private:
    UTextureLODSettings* PreviewTextureGroupRedirect;
#endif
};