RuntimeVirtualTexture.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/TextureDefines.h"
#include "VirtualTexturing.h"
#include "VT/RuntimeVirtualTextureEnum.h"
#include "VirtualTextureEnum.h"
#include "RuntimeVirtualTexture.generated.h"
 
enum EShaderPlatform : uint16;
namespace UE { namespace Shader { enum class EValueType : uint8; } }
 
UCLASS(ClassGroup = Rendering, BlueprintType, MinimalAPI)
class URuntimeVirtualTexture : public UObject
{
    GENERATED_UCLASS_BODY()
    ENGINE_API ~URuntimeVirtualTexture();
 
    friend class FRuntimeVirtualTextureDetailsCustomization;
 
protected:
    UPROPERTY(EditAnywhere, BluePrintGetter = GetTileCount, Category = Size, meta = (UIMin = "0", UIMax = "12", DisplayName = "Size of the virtual texture in tiles"))
    int32 TileCount = 8; // 256
 
    UPROPERTY(EditAnywhere, BluePrintGetter = GetTileSize, Category = Size, meta = (UIMin = "0", UIMax = "4", DisplayName = "Size of each virtual texture tile"))
    int32 TileSize = 2; // 256
 
    UPROPERTY(EditAnywhere, BluePrintGetter = GetTileBorderSize, Category = Size, meta = (UIMin = "0", UIMax = "4", DisplayName = "Border padding for each virtual texture tile"))
    int32 TileBorderSize = 2; // 4
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Layout, meta = (DisplayName = "Virtual texture content"), AssetRegistrySearchable)
    ERuntimeVirtualTextureMaterialType MaterialType = ERuntimeVirtualTextureMaterialType::BaseColor_Normal_Specular;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Layout, meta = (DisplayName = "Enable texture compression"))
    bool bCompressTextures = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Performance, meta = (DisplayName = "Use Low Quality Compression", editcondition = "MaterialType == ERuntimeVirtualTextureMaterialType::BaseColor_Normal_Roughness && bCompressTextures == true"))
    bool bUseLowQualityCompression = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Performance, meta = (EditCondition = bUseCustomPriority))
    EVTProducerPriority CustomPriority;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Performance, meta = (InlineEditConditionToggle)) 
    bool bUseCustomPriority = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Layout, meta = (DisplayName = "Enable clear before render"))
    bool bClearTextures = true;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Layout, meta = (DisplayName = "Enable packed page table"))
    bool bSinglePhysicalSpace = true;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Layout, meta = (DisplayName = "Enable private page table"))
    bool bPrivateSpace = true;
 
    UPROPERTY(EditAnywhere, Category = Layout, meta = (DisplayName = "Enable adaptive page table"))
    bool bAdaptive = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Layout, meta = (DisplayName = "Enable continuous page updates"))
    bool bContinuousUpdate = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Layout, meta = (UIMin = "0", UIMax = "5", DisplayName = "Number of low mips to remove from the virtual texture"))
    int32 RemoveLowMips = 0;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Settings)
    FVector4f CustomMaterialData;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Settings, meta = (DisplayName = "Texture Group"), AssetRegistrySearchable)
    TEnumAsByte<enum TextureGroup> LODGroup = TEXTUREGROUP_World;
    
    UPROPERTY()
    int32 Size_DEPRECATED = -1;
 
    UPROPERTY()
    TObjectPtr<class URuntimeVirtualTextureStreamingProxy> StreamingTexture_DEPRECATED = nullptr;
 
public:
    ERuntimeVirtualTextureMaterialType GetMaterialType() const { return MaterialType; }
    
    UFUNCTION(BlueprintGetter)
    int32 GetTileCount() const { return GetClampedTileCount(TileCount, bAdaptive); }
    static int32 GetClampedTileCount(int32 InTileCount, bool InAdaptive) { return 1 << FMath::Clamp(InTileCount, 0, GetMaxTileCountLog2(InAdaptive)); }
    static ENGINE_API int32 GetMaxTileCountLog2(bool InAdaptive);
    UFUNCTION(BlueprintGetter)
    int32 GetTileSize() const { return GetClampedTileSize(TileSize); }
    static int32 GetClampedTileSize(int32 InTileSize) { return 1 << FMath::Clamp(InTileSize + 6, 6, 10); }
    UFUNCTION(BlueprintGetter)
    int32 GetTileBorderSize() const { return 2 * FMath::Clamp(TileBorderSize, 0, 4); }
 
    UFUNCTION(BlueprintPure, Category = Size)
    int32 GetSize() const { return GetTileCount() * GetTileSize(); }
    UFUNCTION(BlueprintPure, Category = Size)
    ENGINE_API int32 GetPageTableSize() const;
 
    bool GetCompressTextures() const { return bCompressTextures; }
    bool GetClearTextures() const { return bClearTextures; }
    bool GetSinglePhysicalSpace() const { return bSinglePhysicalSpace; }
    bool GetPrivateSpace() const { return bPrivateSpace; }
    bool GetAdaptivePageTable() const { return bAdaptive; }
    bool GetContinuousUpdate() const { return bContinuousUpdate; }
    int32 GetRemoveLowMips() const { return FMath::Clamp(RemoveLowMips, 0, 5); }
    bool GetLQCompression() const { return bUseLowQualityCompression; }
    FVector4f GetCustomMaterialData() const { return CustomMaterialData; }
    TEnumAsByte<enum TextureGroup> GetLODGroup() const { return LODGroup; }
 
    struct FInitSettings
    {
        int32 TileCountBias = 0;
    };
 
    ENGINE_API void GetProducerDescription(FVTProducerDescription& OutDesc, FInitSettings const& InitSettings, FTransform const& VolumeToWorld) const;
 
    ENGINE_API int32 GetLayerCount() const;
    static ENGINE_API int32 GetLayerCount(ERuntimeVirtualTextureMaterialType InMaterialType);
    ENGINE_API EPixelFormat GetLayerFormat(int32 LayerIndex) const;
    ENGINE_API bool IsLayerSRGB(int32 LayerIndex) const;
    ENGINE_API bool IsLayerYCoCg(int32 LayerIndex) const;
 
    DECLARE_DELEGATE(FOnReInitDelegate);
 
    ENGINE_API void Initialize(IVirtualTexture* InProducer, FVTProducerDescription const& InProducerDesc, FTransform const& InVolumeToWorld, FBox const& InWorldBounds, FOnReInitDelegate InDelegate);
    UE_DEPRECATED(5.6, "Use the version that takes a FOnReInitDelegate instead.")
    ENGINE_API void Initialize(IVirtualTexture* InProducer, FVTProducerDescription const& InProducerDesc, FTransform const& InVolumeToWorld, FBox const& InWorldBounds);
 
    ENGINE_API void Release();
 
    ENGINE_API FVirtualTextureProducerHandle GetProducerHandle() const;
    ENGINE_API IAllocatedVirtualTexture* GetAllocatedVirtualTexture() const;
 
    ENGINE_API FVector4 GetUniformParameter(int32 Index) const;
    static ENGINE_API UE::Shader::EValueType GetUniformParameterType(int32 Index);
 
    ENGINE_API EVTProducerPriority GetPriority() const;
    ENGINE_API EVTProducerPriority GetDefaultPriority() const;
    bool GetUseCustomPriority() const
    {
        return bUseCustomPriority;
    }
 
protected:
    ENGINE_API void InitResource(IVirtualTexture* InProducer, FVTProducerDescription const& InProducerDesc);
    ENGINE_API void InitNullResource();
 
    //~ Begin UObject Interface.
    ENGINE_API virtual void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const override;
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    ENGINE_API virtual void GetAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) const override;
    ENGINE_API virtual void PostLoad() override;
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
    //~ End UObject Interface.
 
private:
    class FRuntimeVirtualTextureRenderResource* Resource;
 
    FVector4 WorldToUVTransformParameters[3];
    FVector4 WorldHeightUnpackParameter;
 
    FOnReInitDelegate OnReInitDelegate; 
};
 
class UVirtualTexture2D;
 
namespace RuntimeVirtualTexture
{
    ENGINE_API IVirtualTexture* CreateStreamingTextureProducer(
        UVirtualTexture2D* InStreamingTexture,
        FVTProducerDescription const& InOwnerProducerDesc,
        FVTProducerDescription& OutStreamingProducerDesc);
 
    ENGINE_API IVirtualTexture* BindStreamingTextureProducer(
        IVirtualTexture* InProducer,
        IVirtualTexture* InStreamingProducer,
        int32 InTransitionLevel);
 
    ENGINE_API bool IsMaterialTypeSupported(ERuntimeVirtualTextureMaterialType MaterialType);
    ENGINE_API bool IsMaterialTypeSupported(ERuntimeVirtualTextureMaterialType MaterialType, EShaderPlatform InPlatform);
}