TextureCompiler.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "UObject/WeakObjectPtr.h"
#include "Containers/ConsumeAllMpmcQueue.h"
#include "Containers/Set.h"
#include "IAssetCompilingManager.h"
 
#if WITH_EDITOR
 
class FAsyncCompilationNotification;
class UTexture;
class FQueuedThreadPool;
enum class EQueuedWorkPriority : uint8;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FTexturePostCompileEvent, const TArrayView<UTexture* const>&);
 
class FTextureCompilingManager : IAssetCompilingManager
{
public:
    ENGINE_API static FTextureCompilingManager& Get();
 
    ENGINE_API bool IsAsyncTextureCompilationEnabled() const;
 
    ENGINE_API bool IsAsyncCompilationCancelable() const;
 
    ENGINE_API int32 GetNumRemainingTextures() const;
 
    ENGINE_API void AddTextures(TArrayView<UTexture* const> InTextures);
 
    ENGINE_API void ForceDeferredTextureRebuildAnyThread(TArrayView<const TWeakObjectPtr<UTexture>> InTextures);
 
    ENGINE_API void FinishCompilation(TArrayView<UTexture* const> InTextures);
 
    ENGINE_API void FinishAllCompilation() override;
 
    ENGINE_API bool IsAsyncCompilationAllowed(UTexture* InTexture) const;
 
    ENGINE_API bool RequestPriorityChange(UTexture* InTexture, EQueuedWorkPriority Priority);
 
    ENGINE_API EQueuedWorkPriority GetBasePriority(UTexture* InTexture) const;
 
    ENGINE_API FQueuedThreadPool* GetThreadPool() const;
 
    ENGINE_API void Shutdown() override;
 
    ENGINE_API static FName GetStaticAssetTypeName();
 
    ENGINE_API bool IsCompilingTexture(UTexture* InTexture) const;
 
    FTexturePostCompileEvent& OnTexturePostCompileEvent() {return TexturePostCompileEvent;}
 
private:
    friend class FAssetCompilingManager;
 
    FTextureCompilingManager();
 
    void FinishCompilationForObjects(TArrayView<UObject* const> InObjects) override;
    
    void MarkCompilationAsCanceled(TArrayView<UObject* const> InObjects) override;
 
    FName GetAssetTypeName() const override;
    FTextFormat GetAssetNameFormat() const override;
    TArrayView<FName> GetDependentTypeNames() const override;
    int32 GetNumRemainingAssets() const override;
    void ProcessAsyncTasks(bool bLimitExecutionTime = false) override;
    void ProcessAsyncTasks(const AssetCompilation::FProcessAsyncTaskParams& Params) override;
 
    void FinishCompilationsForGame();
    void ProcessTextures(bool bLimitExecutionTime, int32 MaximumPriority = -1);
    void UpdateCompilationNotification();
 
    bool GetCurrentPriority(UTexture* InTexture, EQueuedWorkPriority& OutPriority);
    void PostCompilation(UTexture* Texture);
    void PostCompilation(TArrayView<UTexture* const> InCompiledTextures);
 
    void ProcessDeferredRequests();
 
 
    FString CurrentPostCompilationDDCKey;
    UTexture* CurrentPostCompilationTexture = nullptr;
    double LastReschedule = 0.0f;
    bool bHasShutdown = false;
    bool bIsRoutingPostCompilation = false;
    UE::TConsumeAllMpmcQueue<TWeakObjectPtr<UTexture>> DeferredRebuildRequestQueue;
    TArray<TSet<TWeakObjectPtr<UTexture>>> RegisteredTextureBuckets;
    TUniquePtr<FAsyncCompilationNotification> Notification;
 
    FTexturePostCompileEvent TexturePostCompileEvent;
};
 
#endif
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_4
#include "CoreMinimal.h"
#include "AssetCompilingManager.h"
#include "AsyncCompilationHelpers.h"
#endif