RuntimeVirtualTextureComponent.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 "UObject/PerPlatformProperties.h"
#include "RenderCommandFence.h"
#include "SceneComponent.h"
#include "SceneTypes.h"
#include "VT/RuntimeVirtualTextureEnum.h"
#include "VirtualTextureEnum.h"
#include "RuntimeVirtualTextureComponent.generated.h"
 
class URuntimeVirtualTexture;
class UTexture2D;
class UVirtualTextureBuilder;
enum class EShadingPath;
 
UENUM()
enum class ERuntimeVirtualTextureMaterialQuality : uint8
{
    Low = 0,
    Medium = 1,
    High = 2,
    Epic = 3,
};
 
UENUM()
enum class ERuntimeVirtualTextureUseStreamingMipsInEditorMode : uint8
{
    Never UMETA(ToolTip = "Never show the streaming low mips in the editor"),
    PIEOnly UMETA(ToolTip = "Only show the streaming low mips when Play In Editor is active"),
    Always UMETA(ToolTip = "Always show the streaming low mips in the editor"),
};
 
UCLASS(Blueprintable, ClassGroup = Rendering, HideCategories = (Activation, Collision, Cooking, HLOD, Mobility, LOD, Navigation, Object, Physics), MinimalAPI)
class URuntimeVirtualTextureComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    friend class FRuntimeVirtualTextureComponentDetailsCustomization;
 
protected:
    UPROPERTY(EditAnywhere, Category = VolumeBounds)
    TSoftObjectPtr<AActor> BoundsAlignActor = nullptr;
 
    UPROPERTY(VisibleAnywhere, Transient, Category = VolumeBounds)
    bool bSetBoundsButton;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = VolumeBounds, meta = (DisplayName = "Snap To Landscape"))
    bool bSnapBoundsToLandscape;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = VolumeBounds, meta = (UIMin = "0", ClampMin = "0"))
    float ExpandBounds = 0;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, TextExportTransient, Category = RuntimeVirtualTexture)
    TObjectPtr<URuntimeVirtualTexture> VirtualTexture = nullptr;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = RuntimeVirtualTexture)
    FPerPlatformBool EnableInGamePerPlatform;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = RuntimeVirtualTexture)
    bool bEnableForNaniteOnly = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = RuntimeVirtualTexture, Meta = (InlineEditConditionToggle))
    bool bUseMinMaterialQuality = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = RuntimeVirtualTexture, Meta = (EditCondition = "bUseMinMaterialQuality"))
    ERuntimeVirtualTextureMaterialQuality MinInGameMaterialQuality = ERuntimeVirtualTextureMaterialQuality::Low;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = RuntimeVirtualTexture, meta = (InlineEditConditionToggle))
    bool bEnableScalability = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = RuntimeVirtualTexture, meta = (UIMin = "0", UIMax = "2", EditCondition = bEnableScalability))
    uint32 ScalabilityGroup = 0;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = RuntimeVirtualTexture)
    bool bHidePrimitives = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, TextExportTransient, NonPIEDuplicateTransient, Category = StreamingVirtualTexture)
    TObjectPtr<UVirtualTextureBuilder> StreamingTexture = nullptr;
 
    UPROPERTY(EditAnywhere, Category = StreamingVirtualTexture, meta = (UIMin = "0", UIMax = "12", DisplayName = "Build Levels"))
    int32 StreamLowMips = 0;
 
    UPROPERTY(VisibleAnywhere, Transient, Category = StreamingVirtualTexture)
    bool bBuildStreamingMipsButton;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category = StreamingVirtualTexture)
    TEnumAsByte<ETextureLossyCompressionAmount> LossyCompressionAmount = TLCA_Default;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = StreamingVirtualTexture, meta = (InlineEditConditionToggle))
    bool bUseStreamingMipsFixedColor = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = StreamingVirtualTexture, meta = (DisplayName = "Fixed Color", HideAlphaChannel, EditCondition = bUseStreamingMipsFixedColor))
    FLinearColor StreamingMipsFixedColor;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = StreamingVirtualTexture, meta = (DisplayName = "Use Only Streaming Texture"))
    bool bUseStreamingMipsOnly = false;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = StreamingVirtualTexture, meta = (DisplayName = "View in Editor"))
    ERuntimeVirtualTextureUseStreamingMipsInEditorMode UseStreamingMipsInEditorMode = ERuntimeVirtualTextureUseStreamingMipsInEditorMode::Never;
 
    UPROPERTY()
    bool bUseStreamingMipsInEditor_DEPRECATED = false;
 
#if WITH_EDITOR
    FDelegateHandle PieEndDelegateHandle;
#endif
 
    DECLARE_MULTICAST_DELEGATE_TwoParams(FGetHidePrimitivesDelegate, bool&, bool&);
    FGetHidePrimitivesDelegate HidePrimitivesDelegate;
 
    FRenderCommandFence DestroyFence;
 
public:
    UFUNCTION(BlueprintCallable, Category = VirtualTexture)
    ENGINE_API void Invalidate(FBoxSphereBounds const& WorldBounds, EVTInvalidatePriority InvalidatePriority = EVTInvalidatePriority::High);
 
    UFUNCTION(BlueprintCallable, Category = VirtualTexture)
    ENGINE_API void RequestPreload(FBoxSphereBounds const& WorldBounds, int32 Level);
 
    ENGINE_API void SetVirtualTexture(URuntimeVirtualTexture* InVirtualTexture);
 
    URuntimeVirtualTexture* GetVirtualTexture() const { return VirtualTexture; }
 
    ENGINE_API bool IsEnabledInScene() const;
 
    ENGINE_API FVector4f GetCustomMaterialData() const;
 
    bool IsScalable() const { return bEnableScalability; }
 
    uint32 GetScalabilityGroup() const { return ScalabilityGroup; }
 
    FGetHidePrimitivesDelegate& GetHidePrimitivesDelegate() { return HidePrimitivesDelegate; }
 
    ENGINE_API void GetHidePrimitiveSettings(bool& OutHidePrimitiveEditor, bool& OutHidePrimitiveGame) const;
 
    UVirtualTextureBuilder* GetStreamingTexture() const { return StreamingTexture; }
 
    int32 NumStreamingMips() const { return FMath::Clamp(StreamLowMips, 0, 12); }
 
    ENGINE_API bool IsStreamingLowMips(EShadingPath ShadingPath) const;
 
    ENGINE_API bool IsStreamingLowMipsOnly();
 
    ENGINE_API FLinearColor GetStreamingMipsFixedColor() const;
 
    TEnumAsByte<ETextureLossyCompressionAmount> GetLossyCompressionAmount() const { return LossyCompressionAmount; }
 
    ENGINE_API bool IsStreamingTextureInvalid(EShadingPath ShadingPath) const;
 
    ENGINE_API EVTProducerPriority GetPriority() const;
 
    enum class EStreamingTextureStatusFlags : uint8
    {
        None = 0,
        HasVirtualTexture = (1 << 0),
        HasStreamingTexture = (1 << 1),
        InvalidStreamingTexture = (1 << 2),
        NonMatchingStreamingTextureSettings = (1 << 3),
    };
    ENGINE_API EStreamingTextureStatusFlags GetStreamingTextureStatus(EShadingPath ShadingPath) const;
 
#if WITH_EDITOR
    ENGINE_API bool IsStreamingTextureInvalid() const;
    ENGINE_API EStreamingTextureStatusFlags GetStreamingTextureStatus() const;
    void SetStreamingTexture(UVirtualTextureBuilder* InTexture) { StreamingTexture = InTexture; }
    ENGINE_API void InitializeStreamingTexture(EShadingPath ShadingPath, uint32 InSizeX, uint32 InSizeY, uint8* InData);
#endif
 
#if WITH_EDITOR
    ENGINE_API void SetBoundsAlignActor(AActor* InActor);
    TSoftObjectPtr<AActor>& GetBoundsAlignActor() { return BoundsAlignActor; }
    bool GetSnapBoundsToLandscape() const { return bSnapBoundsToLandscape; }
    float GetExpandBounds() const { return ExpandBounds; }
#endif
    ENGINE_API FTransform GetTexelSnapTransform() const;
 
protected:
    //~ Begin UObject Interface
    ENGINE_API virtual void BeginDestroy() override;
    ENGINE_API virtual bool IsReadyForFinishDestroy() override;
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
#if WITH_EDITOR
    ENGINE_API virtual bool CanEditChange(const FProperty* InProperty) const override;
#endif
    ENGINE_API virtual void ApplyWorldOffset(const FVector& InOffset, bool bWorldShift) override;
    //~ End UObject Interface
 
    //~ Begin UActorComponent Interface
    ENGINE_API virtual bool ShouldCreateRenderState() const override;
    ENGINE_API virtual void CreateRenderState_Concurrent(FRegisterComponentContext* Context) override;
    ENGINE_API virtual void SendRenderTransform_Concurrent() override;
    ENGINE_API virtual void DestroyRenderState_Concurrent() override;
#if WITH_EDITOR
    ENGINE_API virtual void CheckForErrors() override;
#endif
    //~ End UActorComponent Interface
 
    //~ Begin USceneComponent Interface
#if WITH_EDITOR
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void OnUnregister() override;
#endif
    ENGINE_API virtual FBoxSphereBounds CalcBounds(const FTransform& LocalToWorld) const override;
    //~ End USceneComponent Interface
 
protected:
    ENGINE_API uint64 CalculateStreamingTextureSettingsHash() const;
 
    ENGINE_API bool IsActiveInWorld() const;
 
public:
    class FRuntimeVirtualTextureSceneProxy* SceneProxy;
};
 
ENUM_CLASS_FLAGS(URuntimeVirtualTextureComponent::EStreamingTextureStatusFlags);