FXSystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    FXSystem.h: Interface to the effects system.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/IConsoleManager.h"
#include "RenderUtils.h"
#include "RenderGraphDefinitions.h"
 
class FCanvas;
class FGPUSortManager;
struct FGPUSpriteEmitterInfo;
struct FGPUSpriteResourceData;
class FGPUSpriteResources;
struct FParticleEmitterInstance;
class FRHIUniformBuffer;
class FScene;
class FSceneInterface;
class UVectorFieldComponent;
class FGlobalDistanceFieldParameterData;
class FSceneUniformBuffer;
class FSceneViewFamily;
class FSceneTextureUniformParameters;
class FViewInfo;
template<typename TBufferStruct> class TUniformBufferRef;
 
/*-----------------------------------------------------------------------------
    Forward declarations.
-----------------------------------------------------------------------------*/
 
struct FParticleEmitterInstance;
struct FGPUSpriteEmitterInfo;
struct FGPUSpriteResourceData;
class FGPUSpriteResources;
class UVectorField;
class UVectorFieldComponent;
class FVectorFieldResource;
class FVectorFieldInstance;
class FPrimitiveDrawInterface;
class FSceneView;
class FCanvas;
 
/*------------------------------------------------------------------------------
    FX Console variables.
------------------------------------------------------------------------------*/
 
namespace FXConsoleVariables
{
    extern int32 VisualizeGPUSimulation;
    ENGINE_API extern int32 bAllowGPUSorting;
    extern int32 bAllowCulling;
    extern int32 bFreezeGPUSimulation;
    extern int32 bFreezeParticleSimulation;
    extern int32 bAllowAsyncTick;
    extern float ParticleSlackGPU;
    extern int32 MaxParticleTilePreAllocation;
    extern int32 MaxCPUParticlesPerEmitter;
    extern int32 MaxGPUParticlesSpawnedPerFrame;
    extern int32 GPUSpawnWarningThreshold;
    extern float GPUCollisionDepthBounds;
    extern TAutoConsoleVariable<int32> TestGPUSort;
    extern int32 bAllowGPUParticles;
}
 
inline bool SupportsGPUParticles(EShaderPlatform Platform)
{
    return true; // For editor mobile preview 
}
 
/*
 * Returns true if the current RHI supports GPU particles 
 */
//@todo rename this function. 
// Unlike other RHI* functions which are static, it actually returns true if the
// RHI on the current hardware is able to support GPU particles.
inline bool RHISupportsGPUParticles()
{
    return FXConsoleVariables::bAllowGPUParticles
        && GSupportsWideMRT
        && GPixelFormats[PF_G32R32F].Supported 
        && GSupportsTexture3D;
}
 
class FFXSystemInterface;
class FGPUSortManager;
DECLARE_DELEGATE_RetVal_ThreeParams(FFXSystemInterface*, FCreateCustomFXSystemDelegate, ERHIFeatureLevel::Type, EShaderPlatform, FGPUSortManager*);
 
/*-----------------------------------------------------------------------------
    The interface to the FX system runtime.
-----------------------------------------------------------------------------*/
 
class FFXSystemInterface : public TSharedFromThis<FFXSystemInterface>
{
    struct FFXInterfaceDeletor
    {
        void operator()(FFXSystemInterface* ObjectToDelete) const;
    };
 
public:
    ENGINE_API static FFXSystemInterface* Create(ERHIFeatureLevel::Type InFeatureLevel, FSceneInterface* Scene);
 
    ENGINE_API static void MarkPendingKill(FFXSystemInterface* FXSystem);
 
    ENGINE_API static void QueueDestroyGPUSimulation(FFXSystemInterface* FXSystem);
 
    ENGINE_API static void RegisterCustomFXSystem(const FName& InterfaceName, const FCreateCustomFXSystemDelegate& InCreateDelegate);
 
    ENGINE_API static void UnregisterCustomFXSystem(const FName& InterfaceName);
 
    virtual FFXSystemInterface* GetInterface(const FName& InName) { return nullptr; };
 
    virtual void OnMarkPendingKill() { bIsPendingKill = true; }
 
    virtual void DestroyGPUSimulation() { }
 
    virtual void Tick(UWorld* World, float DeltaSeconds) = 0;
 
    UE_DEPRECATED(5.7, "Destroy is no longer supported, please update your code call MarkPendingKill")
    ENGINE_API static void Destroy(FFXSystemInterface* FXSystem);
 
protected:
    UE_DEPRECATED(5.7, "OnDestroy is no longer supported, please update your code call/implement OnMarkPendingKill")
    virtual void OnDestroy() final {}
public:
 
#if WITH_EDITOR
    virtual void Suspend() = 0;
 
    virtual void Resume() = 0;
#endif // #if WITH_EDITOR
 
    virtual void DrawDebug(FCanvas* Canvas) = 0;
 
    virtual bool ShouldDebugDraw_RenderThread() const { return false; }
 
    virtual void DrawDebug_RenderThread(FRDGBuilder& GraphBuilder, const FSceneView& View, const struct FScreenPassRenderTarget& Output) {}
    
    UE_DEPRECATED(5.3, "Passing FViewInfo is deprecated in favor of FSceneView. This function will do nothing.")
    inline void DrawDebug_RenderThread(FRDGBuilder& GraphBuilder, const FViewInfo& View, const struct FScreenPassRenderTarget& Output) {}
 
    virtual void DrawSceneDebug_RenderThread(FRDGBuilder& GraphBuilder, const FSceneView& View, FRDGTextureRef SceneColor, FRDGTextureRef SceneDepth) {}
 
    UE_DEPRECATED(5.3, "Passing FViewInfo is deprecated in favor of FSceneView. This function will do nothing.")
    inline void DrawSceneDebug_RenderThread(FRDGBuilder& GraphBuilder, const FViewInfo& View, FRDGTextureRef SceneColor, FRDGTextureRef SceneDepth) {}
 
    virtual void AddVectorField(UVectorFieldComponent* VectorFieldComponent) = 0;
 
    virtual void RemoveVectorField(UVectorFieldComponent* VectorFieldComponent) = 0;
 
    virtual void UpdateVectorField(UVectorFieldComponent* VectorFieldComponent) = 0;
 
    virtual void PreInitViews(FRDGBuilder& GraphBuilder, bool bAllowGPUParticleUpdate, const TArrayView<const FSceneViewFamily*>& ViewFamilies, const FSceneViewFamily* CurrentFamily) = 0;
 
    virtual void PostInitViews(FRDGBuilder& GraphBuilder, TConstStridedView<FSceneView> Views, bool bAllowGPUParticleUpdate) = 0;
 
    UE_DEPRECATED(5.3, "Passing an array of FViewInfo is deprecated in favor of FSceneView. This function will do nothing.")
    inline void PostInitViews(FRDGBuilder& GraphBuilder, TConstArrayView<FViewInfo> Views, bool bAllowGPUParticleUpdate) {}
 
    virtual bool UsesGlobalDistanceField() const = 0;
 
    virtual bool UsesDepthBuffer() const = 0;
 
    virtual bool RequiresEarlyViewUniformBuffer() const = 0;
 
    virtual bool RequiresRayTracingScene() const = 0;
 
    virtual void PreRender(FRDGBuilder& GraphBuilder, TConstStridedView<FSceneView> Views, FSceneUniformBuffer &SceneUniformBuffer, bool bAllowGPUParticleUpdate) = 0;
 
    UE_DEPRECATED(5.3, "Passing an array of FViewInfo is deprecated in favor of FSceneView. This function will do nothing.")
    inline void PreRender(FRDGBuilder& GraphBuilder, TConstArrayView<FViewInfo> Views, bool bAllowGPUParticleUpdate) {}
 
    virtual void PostRenderOpaque(FRDGBuilder& GraphBuilder, TConstStridedView<FSceneView> Views, FSceneUniformBuffer &SceneUniformBuffer, bool bAllowGPUParticleUpdate) = 0;
 
    UE_DEPRECATED(5.3, "Passing an array of FViewInfo is deprecated in favor of FSceneView. This function will do nothing.")
    inline void PostRenderOpaque(FRDGBuilder& GraphBuilder, TConstArrayView<FViewInfo> Views, bool bAllowGPUParticleUpdate) {}
 
    bool IsPendingKill() const { return bIsPendingKill; }
 
    virtual FGPUSortManager* GetGPUSortManager() const = 0;
 
    virtual void SetSceneTexturesUniformBuffer(const TUniformBufferRef<FSceneTextureUniformParameters>& InSceneTexturesUniformParams) {}
 
    inline FSceneInterface* GetSceneInterface() const { return SceneInterface; }
    inline void SetSceneInterface(FSceneInterface* InSceneInterface) { SceneInterface = InSceneInterface; }
 
    inline FScene* GetScene()const { return Scene; }
    inline void SetScene(FScene* InScene) { Scene = InScene; }
 
protected:
    
    friend class FFXSystemSet;
 
    virtual ~FFXSystemInterface() {}
 
private:
 
    bool bIsPendingKill = false;
 
    FSceneInterface* SceneInterface = nullptr;
    FScene* Scene = nullptr;
 
    static TMap<FName, FCreateCustomFXSystemDelegate> CreateCustomFXDelegates;
};
 
/*-----------------------------------------------------------------------------
    FX resource management.
-----------------------------------------------------------------------------*/
 
FGPUSpriteResources* BeginCreateGPUSpriteResources(const FGPUSpriteResourceData& InResourceData);
 
void BeginUpdateGPUSpriteResources(FGPUSpriteResources* Resources, const FGPUSpriteResourceData& InResourceData);
 
void BeginReleaseGPUSpriteResources(FGPUSpriteResources* Resources);
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_6
#include "SceneView.h"
#endif