1. Epic GamesDeveloper
  3. FSceneInterface

FSceneInterface

An interface to the private scene manager implementation of a scene.

API > API/Runtime > API/Runtime/Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/SceneInterface.h
Include #include "SceneInterface.h"

Syntax

class FSceneInterface

Remarks

An interface to the private scene manager implementation of a scene. Use GetRendererModule().AllocateScene to create. The scene

Variables

  Type Name Description
Protected variable ERHIFeatureLevel::Type FeatureLevel This scene's feature level

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Public function Virtual bool

AddCustomRenderPass ( const FSceneViewFamily* ViewFamily,
const FCustomRenderPassRendererInput& CustomRenderPassInput
)

 Enqueues a new custom render pass to execute the next time this scene is rendered by ANY scene renderer.
Public function void

AddDecal ( UDecalComponent* Component
)

 Adds a new decal component to the scene
Public function void Adds a new exponential height fog component to the scene
Public function void Adds a hair strands proxy to the scene
Public function void Adds a new light component to the scene which is currently invisible, but needed for editor previewing
Public function void Adds a new light component to the scene
Public function void Adds a new local height fog component to the scene
Public function Virtual void

AddLumenSceneCard ( ULumenSceneCardComponent* LumenSceneCardComponent
)

  
Public function Virtual bool Add a pixel inspector request.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

AddPrecomputedVolumetricLightmap ( const FPrecomputedVolumetricLightmap* Volume,
bool bIsPersistentLevel
)

  
Public function void FPrimtiveDesc version for primitive/light scene interactions.
Public function void Adds a new primitive component to the scene
Public function Virtual void Adds a reflection capture to the scene.
Public function Virtual void Add a runtime virtual texture object to the scene.
Public function void

AddSkyAtmosphere ( FSkyAtmosphereSceneProxy* SkyAtmosphereSceneProxy,
bool bStaticLightingBuilt
)

 Adds the unique volumetric cloud component to the scene
Public function void

AddSparseVolumeTextureViewer ( FSparseVolumeTextureViewerSceneProxy* SVTV
)

  
Public function void

AddSpeedTreeWind ( FVertexFactory* VertexFactory,
const UStaticMesh* StaticMesh
)

 Adds a SpeedTree wind computation object to the scene.
Public function void

AddVolumetricCloud ( FVolumetricCloudSceneProxy* VolumetricCloudSceneProxy
)

 Adds the unique volumetric cloud component to the scene
Public function void Adds a wind source component to the scene.
Public function Virtual void

AllocateAndCaptureFrameSkyEnvMap ( FRDGBuilder& GraphBuilder,
FSceneRenderer& SceneRenderer,
FViewInfo& MainView,
bool bShouldRenderSkyAtmosphere,
bool bShouldRenderVolumetricCloud,
FInstanceCullingManager& InstanceCullingManager
)

  
Public function Virtual void

AllocateAndCaptureFrameSkyEnvMap ( FRDGBuilder& GraphBuilder,
FSceneRenderer& SceneRenderer,
FViewInfo& MainView,
bool bShouldRenderSkyAtmosphere,
bool bShouldRenderVolumetricCloud,
FInstanceCullingManager& InstanceCullingManager,
FRDGExternalAccessQueue& ExternalAccessQueue
)

  
Public function void

AllocateReflectionCaptures ( const TArray< UReflectionCaptureComponent* >& NewCaptures,
const TCHAR* CaptureReason,
bool bVerifyOnlyCapturing,
bool bCapturingForMobile
)

  
Public function Virtual void

AllocateReflectionCaptures ( const TArray< UReflectionCaptureComponent* >& NewCaptures,
const TCHAR* CaptureReason,
bool bVerifyOnlyCapturing,
bool bCapturingForMobile,
bool bInsideTick
)

 Allocates reflection captures in the scene's reflection cubemap array and updates them by recapturing the scene.
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset
)

 Shifts scene data by provided delta Called on world origin changes
Public function void Batched versions of Add / Remove / ReleasePrimitive, for improved CPU performance
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function Virtual Const void  
Public function Virtual void  
Public function Virtual Const void

Export ( FArchive& Ar
)

 Exports the scene.
Public function void  
Public function Virtual Const void

GetComputeTaskWorkers ( TArray< class IComputeTaskWorker* >& OutWorkers
)

 Gets the compute work scheduler objects associated with the scene.
Public function Const void

GetDirectionalWindParameters ( FVector& OutDirection,
float& OutSpeed,
float& OutMinGustAmt,
float& OutMaxGustAmt
)

 Same as GetWindParameters, but ignores point wind sources.
Public function Const ERHIFeatureLevel::Type  
Public function Virtual Const uint32  
Public function FFXSystemInterface * Get the FX system associated with the scene.
Public function Virtual FGPUSkinCache * Gets the GPU Skin Cache system associated with the scene.
Public function void

GetLightIESAtlasSlot ( const FLightSceneProxy* Proxy,
FLightRenderParameters* Out
)

 Return the IES profile index corresponding to the local light proxy
Public function Virtual Const bool

GetPreviousLocalToWorld ( const FPrimitiveSceneInfo* PrimitiveSceneInfo,
FMatrix& OutPreviousLocalToWorld
)

 Get the primitive previous local to world (used for motion blur).
Public function Const FPrimitiveSceneInfo *

GetPrimitiveSceneInfo ( const FPersistentPrimitiveIndex& PersistentPrimitiveIndex
)

  
Public function Const FPrimitiveSceneInfo * Finds the primitive with the associated component id.
Public function Const FPrimitiveSceneInfo *

GetPrimitiveSceneInfo ( int32 PrimitiveIndex
)

 Finds the primitive with the associated index into the primitive array.
Public function Const TConstArrayView< FPrimitiveSceneProxy * >  
Public function Virtual Const void

GetPrimitiveUniformShaderParameters_RenderThread ( const FPrimitiveSceneInfo* PrimitiveSceneInfo,
bool& bHasPrecomputedVolumetricLightmap,
FMatrix& PreviousLocalToWorld,
int32& SingleCaptureIndex,
bool& OutputVelocity
)

 Retrieves primitive uniform shader parameters that are internal to the renderer.
Public function Virtual FRayTracingDynamicGeometryCollection *  
Public function Virtual FRayTracingSkinnedGeometryUpdateQueue *  
Public function void

GetRectLightAtlasSlot ( const FRectLightSceneProxy* Proxy,
FLightRenderParameters* Out
)

 Return the rect. light atlas slot information corresponding to the rect light proxy
Public function Virtual void Reads back reflection capture data from the GPU.
Public function Const void

GetRelevantLights ( UPrimitiveComponent* Primitive,
TArray< const ULightComponent* >* RelevantLights
)

 Retrieves the lights interacting with the passed in primitive and adds them to the out array.
Public function Const const FScene *  
Public function FScene * Return the scene to be used for rendering.
Public function Virtual Const void

GetRuntimeVirtualTextureHidePrimitiveMask ( uint8& bHideMaskEditor,
uint8& bHideMaskGame
)

 Get the bitmasks describing which virtual texture objects will hide the associated primitives.
Public function Const TConstArrayView< FPrimitiveComponentId > Returns the FPrimitiveComponentId for all primitives in the scene
Public function Const EShaderPlatform  
Public function Const EShadingPath  
Public function Static EShadingPath  
Public function FSkyAtmosphereRenderSceneInfo * Returns the scene's unique info if it exists
Public function Const const FSkyAtmosphereRenderSceneInfo *  
Public function Const FRHIUniformBuffer *

GetSpeedTreeUniformBuffer ( const FVertexFactory* VertexFactory
)

 Looks up the SpeedTree uniform buffer for the passed in vertex factory.
Public function FVolumetricCloudRenderSceneInfo * Returns the scene's unique info if it exists
Public function Const const FVolumetricCloudRenderSceneInfo *  
Public function Const void

GetWindParameters ( const FVector& Position,
FVector& OutDirection,
float& OutSpeed,
float& OutMinGustAmt,
float& OutMaxGustAmt
)

 Accesses wind parameters. XYZ will contain wind direction * Strength, W contains wind speed.
Public function Const void

GetWindParameters_GameThread ( const FVector& Position,
FVector& OutDirection,
float& OutSpeed,
float& OutMinGustAmt,
float& OutMaxGustAmt
)

 Accesses wind parameters safely for game thread applications
Public function Const const TArray< class FWindSourceSceneProxy * > & Accesses the wind source list. Must be called in the rendering thread.
Public function Const UWorld * Get the optional UWorld that is associated with this scene
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Virtual void  
Public function Virtual bool

InitializePixelInspector ( FRenderTarget* BufferFinalColor,
FRenderTarget* BufferSceneColor,
FRenderTarget* BufferDepth,
FRenderTarget* BufferHDR,
FRenderTarget* BufferA,
FRenderTarget* BufferBCDEF,
int32 BufferIndex
)

 Initialize the pixel inspector buffers.
Public function Virtual void Invalidates Lumen surface cache and forces it to be refreshed.
Public function Virtual void Mark scene as needing to restart path tracer accumulation.
Public function Virtual void Invalidates pages in a runtime virtual texture object.
Public function Virtual Const bool  
Public function Virtual void

OnLevelAddedToWorld ( const FName& InLevelName,
UWorld* InWorld,
bool bIsLightingScenario
)

 Notification that level was added to a world
Public function Virtual void

OnLevelRemovedFromWorld ( const FName& InLevelName,
UWorld* InWorld,
bool bIsLightingScenario
)

  
Public function Virtual void  
Public function Virtual void

ProcessAndRenderIlluminanceMeter ( FRDGBuilder& GraphBuilder,
TArrayView< FViewInfo > Views,
FRDGTextureRef SceneColorTexture
)

  
Public function Virtual void  
Public function void

Release ()

 Release this scene and remove it from the rendering thread
Public function void  
Public function void Called when a primitive is being unregistered and will not be immediately re-registered.
Public function Virtual void  
Public function Virtual void  
Public function void

RemoveDecal ( UDecalComponent* Component
)

 Removes a decal component from the scene
Public function void Removes a exponential height fog component from the scene
Public function void Removes a hair strands proxy to the scene
Public function void Removes a light component from the scene
Public function void Removes a local height fog component from the scene
Public function Virtual void

RemoveLumenSceneCard ( ULumenSceneCardComponent* LumenSceneCardComponent
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function void Removes a primitive component from the scene
Public function void  
Public function Virtual void Removes a reflection capture from the scene.
Public function Virtual void Removes a runtime virtual texture object from the scene.
Public function void

RemoveSkyAtmosphere ( FSkyAtmosphereSceneProxy* SkyAtmosphereSceneProxy
)

 Removes the unique volumetric cloud component to the scene
Public function void

RemoveSparseVolumeTextureViewer ( FSparseVolumeTextureViewerSceneProxy* SVTV
)

  
Public function void

RemoveSpeedTreeWind_RenderThread ( FVertexFactory* VertexFactory,
const UStaticMesh* StaticMesh
)

 Removes a SpeedTree wind computation object to the scene.
Public function void

RemoveVolumetricCloud ( FVolumetricCloudSceneProxy* VolumetricCloudSceneProxy
)

 Removes the unique volumetric cloud component to the scene
Public function void Removes a wind source component from the scene.
Public function Virtual bool

RequestGPUSceneUpdate ( FPrimitiveSceneInfo& PrimitiveSceneInfo,
EPrimitiveDirtyState PrimitiveDirtyState
)

  
Public function Virtual bool  
Public function Const bool Indicates if hit proxies should be processed by this scene
Public function void Reset the physics field scene proxy
Public function Virtual void

ResetReflectionCaptures ( bool bOnlyIfOOM
)

 Resets reflection capture data to allow it to be rebuilt from scratch.
Public function void Sets the FX system associated with the scene.
Public function void

SetPhysicsField ( FPhysicsFieldSceneProxy* PhysicsFieldSceneProxy
)

 Set the physics field scene proxy to the scene
Public function Virtual void

SetPrecomputedVisibility ( const FPrecomputedVisibilityHandler* PrecomputedVisibilityHandler
)

 Sets the precomputed visibility handler for the scene, or NULL to clear the current one.
Public function Virtual void

SetPrecomputedVolumeDistanceField ( const FPrecomputedVolumeDistanceField* PrecomputedVolumeDistanceField
)

 Sets the precomputed volume distance field for the scene, or NULL to clear the current one.
Public function void  
Public function void Set the shader print/debug cvars to be able to show the fields
Public function Virtual void  
Public function void  
Public function void  
Public function void Updates all primitive scene info additions, remobals and translation changes
Public function Virtual void  
Public function Virtual void Update render states that possibly cached inside renderer, like mesh draw commands.
Public function void

UpdateCustomPrimitiveData ( FPrimitiveSceneDesc* Primitive,
const FCustomPrimitiveData& CustomPrimitiveData
)

  
Public function void Updates the custom primitive data of a primitive component which has already been added to the scene.
Public function void  
Public function void  
Public function void Updates the transform of a decal which has already been added to the scene.
Public function Virtual void  
Public function void

UpdateInstanceCullDistance ( UPrimitiveComponent* Primitive,
float StartCullDistance,
float EndCullDistance
)

  
Public function void Updates the color and brightness of a light which has already been added to the scene.
Public function void Updates the transform of a light which has already been added to the scene.
Public function Virtual void

UpdateLumenSceneCardTransform ( ULumenSceneCardComponent* LumenSceneCardComponent
)

  
Public function Virtual void Updates the scene's list of parameter collection id's and their uniform buffers.
Public function Virtual void

UpdatePhysicsField ( FRHICommandListImmediate& RHICmdList,
FViewInfo& View
)

  
Public function void

UpdatePhysicsField ( FRDGBuilder& GraphBuilder,
FViewInfo& View
)

 Reset the physics field scene proxy
Public function Virtual void

UpdatePlanarReflectionContents ( UPlanarReflectionComponent* CaptureComponent,
FSceneRenderer& MainSceneRenderer
)

  
Public function Virtual void  
Public function void Updates primitive attachment state.
Public function Virtual void Updates distance field scene data (transforms, uv scale, self-shadow bias, etc.) but doesn't change allocation in the atlas
Public function void

UpdatePrimitiveDrawDistance ( UPrimitiveComponent* Primitive,
float MinDrawDistance,
float MaxDrawDistance,
float VirtualTextureMaxDrawDistance
)

  
Public function void  
Public function void Updates all the instances that have been updated through the InstanceUpdateCmdBuffer on the UPrimitiveComponent.
Public function void  
Public function Virtual void

UpdatePrimitiveSelectedState_RenderThread ( const FPrimitiveSceneInfo* PrimitiveSceneInfo,
bool bIsSelected
)

 Updates the selected state values that might be cached inside the renderer
Public function void  
Public function void Updates the transform of a primitive which has already been added to the scene.
Public function Virtual void

UpdatePrimitiveVelocityState_RenderThread ( FPrimitiveSceneInfo* PrimitiveSceneInfo,
bool bIsBeingMoved
)

 Updates the velocity state values that might be cached inside the renderer
Public function Virtual void Updates a reflection capture's transform, and then re-captures the scene.
Public function Virtual void  
Public function Virtual void Updates the contents of the given scene capture by rendering the scene.
Public function Virtual void

UpdateSceneSettings ( AWorldSettings* WorldSettings
)

  
Public function Virtual void

UpdateSkyCaptureContents ( const USkyLightComponent* CaptureComponent,
bool bCaptureEmissiveOnly,
UTextureCube* SourceCubemap,
FTexture* OutProcessedTexture,
float& OutAverageBrightness,
FSHVectorRGB3& OutIrradianceEnvironmentMap,
TArray< FFloat16Color >* OutRadianceMap,
FLinearColor* SpecifiedCubemapColorScale
)

 Updates the contents of the given sky capture by rendering the scene.
Public function void

UpdateSpeedTreeWind ( double CurrentTime
)

 Ticks the SpeedTree wind object and updates the uniform buffer.
Public function Virtual void Updates all static draw lists.
Public function void Update a wind source component from the scene.
Public function Virtual void

ValidateSkyLightRealTimeCapture ( FRDGBuilder& GraphBuilder,
const FViewInfo& View,
FRDGTextureRef SceneColorTexture
)

  

Classes

  Type Name Description
Public struct FCustomRenderPassRendererInput Contains settings used to construct scene view for custom render pass during the renderer construction.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page