SceneCore.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    SceneCore.h: Core scene definitions.
=============================================================================*/
 
#pragma once
 
#include "HAL/Platform.h"
#include "Math/Color.h"
#include "RHIFwd.h"
 
class FLightSceneInfo;
class FPrimitiveSceneInfo;
class FScene;
class UTextureCube;
struct FExponentialHeightFogDynamicState;
 
class FLightPrimitiveInteraction
{
public:
 
    static void InitializeMemoryPool();
 
    struct FShouldCreateResult
    {
        bool bShouldCreate = false;
        bool bDynamic = true;
        bool bRelevant = false;
        bool bIsLightMapped = true;
        bool bShadowMapped = false;
        bool bTranslucentObjectShadow = false;
        bool bInsetObjectShadow = false;
    };
 
    static FShouldCreateResult ShouldCreate(FLightSceneInfo* LightSceneInfo,FPrimitiveSceneInfo* PrimitiveSceneInfo);
    static void Create(FLightSceneInfo* LightSceneInfo,FPrimitiveSceneInfo* PrimitiveSceneInfo);
    static void Destroy(FLightPrimitiveInteraction* LightPrimitiveInteraction);
 
    static uint32 GetMemoryPoolSize();
 
    // Accessors.
    bool HasShadow() const { return bCastShadow; }
    bool IsLightMapped() const { return bLightMapped; }
    bool IsDynamic() const { return bIsDynamic; }
    bool IsShadowMapped() const { return bIsShadowMapped; }
    bool IsUncachedStaticLighting() const { return bUncachedStaticLighting; }
    bool HasTranslucentObjectShadow() const { return bHasTranslucentObjectShadow; }
    bool HasInsetObjectShadow() const { return bHasInsetObjectShadow; }
    bool CastsSelfShadowOnly() const { return bSelfShadowOnly; }
    bool IsMobileDynamicLocalLight() const { return bMobileDynamicLocalLight; }
 
    FORCEINLINE bool IsNaniteMeshProxy() const { return bNaniteMeshProxy; }
    FORCEINLINE bool ProxySupportsGPUScene() const { return bProxySupportsGPUScene; }
 
 
    FLightSceneInfo* GetLight() const { return LightSceneInfo; }
    int32 GetLightId() const { return LightId; }
    FPrimitiveSceneInfo* GetPrimitiveSceneInfo() const { return PrimitiveSceneInfo; }
    FLightPrimitiveInteraction* GetNextPrimitive() const { return NextPrimitive; }
    FLightPrimitiveInteraction* GetNextLight() const { return NextLight; }
 
    friend uint32 GetTypeHash( const FLightPrimitiveInteraction* Interaction )
    {
        return (uint32)Interaction->LightId;
    }
 
    void FlushCachedShadowMapData();
 
    void* operator new(size_t Size);
    void operator delete(void* RawMemory);
 
private:
    FLightSceneInfo* LightSceneInfo;
 
    FPrimitiveSceneInfo* PrimitiveSceneInfo;
 
    FLightPrimitiveInteraction** PrevPrimitiveLink;
 
    FLightPrimitiveInteraction* NextPrimitive;
 
    FLightPrimitiveInteraction** PrevLightLink;
 
    FLightPrimitiveInteraction* NextLight;
 
    int32 LightId;
 
    uint32 bCastShadow : 1;
 
    uint32 bLightMapped : 1;
 
    uint32 bIsDynamic : 1;
 
    uint32 bIsShadowMapped : 1;
 
    uint32 bUncachedStaticLighting : 1;
 
    uint32 bHasTranslucentObjectShadow : 1;
 
    uint32 bHasInsetObjectShadow : 1;
 
    uint32 bSelfShadowOnly : 1;
 
    uint32 bMobileDynamicLocalLight : 1;
 
    uint32 bNaniteMeshProxy : 1;
 
    uint32 bProxySupportsGPUScene : 1;
 
    FLightPrimitiveInteraction(FLightSceneInfo* InLightSceneInfo,FPrimitiveSceneInfo* InPrimitiveSceneInfo,
        bool bIsDynamic,bool bInLightMapped,bool bInIsShadowMapped, bool bInHasTranslucentObjectShadow, bool bInHasInsetObjectShadow);
 
    ~FLightPrimitiveInteraction();
 
};
 
class FExponentialHeightFogSceneInfo
{
public:
 
    struct FExponentialHeightFogSceneData
    {
        float Height;
        float Density;
        float HeightFalloff;
    };
 
    static constexpr int NumFogs = 2;
 
    uint64 Id;
    FExponentialHeightFogSceneData FogData[NumFogs];
    float FogMaxOpacity;
    float StartDistance;
    float EndDistance;
    float FogCutoffDistance;
    FLinearColor FogColor;
    float DirectionalInscatteringExponent; 
    float DirectionalInscatteringStartDistance;
    FLinearColor DirectionalInscatteringColor;
    UTextureCube* InscatteringColorCubemap;
    float InscatteringColorCubemapAngle;
    float FullyDirectionalInscatteringColorDistance;
    float NonDirectionalInscatteringColorDistance;
 
    bool bEnableVolumetricFog;
    float VolumetricFogScatteringDistribution;
    FLinearColor VolumetricFogAlbedo;
    FLinearColor VolumetricFogEmissive;
    float VolumetricFogExtinctionScale;
    float VolumetricFogDistance;
    float VolumetricFogStaticLightingScatteringIntensity;
    bool bOverrideLightColorsWithFogInscatteringColors;
    bool bHoldout;
    bool bRenderInMainPass;
    bool bVisibleInReflectionCaptures;
    bool bVisibleInRealTimeSkyCaptures;
    float VolumetricFogStartDistance;
    float VolumetricFogNearFadeInDistance;
 
    FLinearColor SkyAtmosphereAmbientContributionColorScale;
 
    FExponentialHeightFogSceneInfo(uint64 InId, const FExponentialHeightFogDynamicState& State);
};
 
extern bool IsIndirectLightingCacheAllowed(ERHIFeatureLevel::Type InFeatureLevel);
 
extern bool CanIndirectLightingCacheUseVolumeTexture(ERHIFeatureLevel::Type InFeatureLevel);