Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FSceneInterface

Light Theme

Dark Theme

FSceneInterface

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

Windows

MacOS

Linux

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

		Name	Description
	ERHIFeatureLeve...	FeatureLevel	This scene's feature level

Constructors

	Name	Description
	FSceneInterface ( ERHIFeatureLevel::Type InFeatureLev... )

Destructors

	Name	Description
	~FSceneInterface()

Functions

	Name	Description
void	AddAtmosphericFog_Impl ( UAtmosphericFogComponent* FogC... )
void	AddDecal ( UDecalComponent* Component )	Adds a new decal component to the scene
void	AddExponentialHeightFog ( UExponentialHeightFogComponent*... )	Adds a new exponential height fog component to the scene
void	AddInvisibleLight ( ULightComponent* Light )	Adds a new light component to the scene which is currently invisible, but needed for editor previewing
void	AddLight ( ULightComponent* Light )	Adds a new light component to the scene
bool	AddPixelInspectorRequest ( FPixelInspectorRequest* PixelI... )	Add a pixel inspector request.
void	AddPlanarReflection ( UPlanarReflectionComponent* Co... )
void	AddPrecomputedLightVolume ( const FPrecomputedLightVolume*... )
void	AddPrecomputedVolumetricLightmap ( const FPrecomputedVolumetricLightma..., bool bIsPersistentLevel )
void	AddPrimitive ( UPrimitiveComponent* Primitive )	Adds a new primitive component to the scene
void	AddReflectionCapture ( UReflectionCaptureComponent* C... )	Adds a reflection capture to the scene.
void	AddRuntimeVirtualTexture ( URuntimeVirtualTextureComponent... )	Add a runtime virtual texture object to the scene.
void	AddSkyAtmosphere ( FSkyAtmosphereSceneProxy* SkyA..., bool bStaticLightingBuilt )	Adds the unique volumetric cloud component to the scene
void	AddSpeedTreeWind ( FVertexFactory* VertexFactory, const UStaticMesh* StaticMesh )	Adds a SpeedTree wind computation object to the scene.
void	AddVolumetricCloud ( FVolumetricCloudSceneProxy* Vo... )	Adds the unique volumetric cloud component to the scene
void	AddWindSource ( UWindDirectionalSourceComponent... )	Adds a wind source component to the scene.
void	AllocateAndCaptureFrameSkyEnvMap ( FRDGBuilder& GraphBuilder, FSceneRenderer& SceneRenderer, FViewInfo& MainView, bool bShouldRenderSkyAtmosphere, bool bShouldRenderVolumetricCloud )
void	AllocateReflectionCaptures ( const TArray< UReflectionCaptureCom..., const TCHAR* CaptureReason, bool bVerifyOnlyCapturing, bool bCapturingForMobile )	Allocates reflection captures in the scene's reflection cubemap array and updates them by recapturing the scene.
void	ApplyWorldOffset ( FVector InOffset )	Shifts scene data by provided delta Called on world origin changes
void	DisableSkyLight ( FSkyLightSceneProxy* Light )
void	DumpUnbuiltLightInteractions ( FOutputDevice& Ar )
void	Export ( FArchive& Ar )	Exports the scene.
FAtmospheric...	GetAtmosphericFogSceneInfo_Impl()
void	GetDirectionalWindParameters ( FVector& OutDirection, float& OutSpeed, float& OutMinGustAmt, float& OutMaxGustAmt )	Same as GetWindParameters, but ignores point wind sources.
ERHIFeatureL...	GetFeatureLevel()
uint32	GetFrameNumber()
FFXSystemInt...	GetFXSystem()	Get the FX system associated with the scene.
FGPUSkinCach...	GetGPUSkinCache()	Gets the GPU Skin Cache system associated with the scene.
bool	GetPreviousLocalToWorld ( const FPrimitiveSceneInfo* Pri..., FMatrix& OutPreviousLocalToWorld )	Get the primitive previous local to world (used for motion blur).
FPrimitiveSc...	GetPrimitiveSceneInfo ( int32 PrimitiveIndex )	Finds the primitive with the associated component id.
void	GetPrimitiveUniformShaderParameters_RenderThread ( const FPrimitiveSceneInfo* Pri..., bool& bHasPrecomputedVolumetricLig..., FMatrix& PreviousLocalToWorld, int32& SingleCaptureIndex, bool& OutputVelocity )	Retrieves primitive uniform shader parameters that are internal to the renderer.
void	GetReflectionCaptureData ( UReflectionCaptureComponent* C..., FReflectionCaptureData& OutCapture... )	Reads back reflection capture data from the GPU.
void	GetRelevantLights ( UPrimitiveComponent* Primitive, TArray< const ULightComponent*... )	Retrieves the lights interacting with the passed in primitive and adds them to the out array.
FScene *	GetRenderScene()	Return the scene to be used for rendering.
void	GetRuntimeVirtualTextureHidePrimitiveMask ( uint8& bHideMaskEditor, uint8& bHideMaskGame )	Get the bitmasks describing which virtual texture objects will hide the associated primitives.
TArray< FPri...	GetScenePrimitiveComponentIds()	Returns the FPrimitiveComponentId for all primitives in the scene
EShaderPlatf...	GetShaderPlatform()
EShadingPath	GetShadingPath ( ERHIFeatureLevel::Type InFeatureLev... )
EShadingPath	GetShadingPath()
FSkyAtmosphe...	GetSkyAtmosphereSceneInfo()	Returns the scene's unique info if it exists
const FSkyAt...	GetSkyAtmosphereSceneInfo()
FRHIUniformB...	GetSpeedTreeUniformBuffer ( const FVertexFactory* VertexFa... )	Looks up the SpeedTree uniform buffer for the passed in vertex factory.
FVolumetricC...	GetVolumetricCloudSceneInfo()	Returns the scene's unique info if it exists
const FVolum...	GetVolumetricCloudSceneInfo()
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.
void	GetWindParameters_GameThread ( const FVector& Position, FVector& OutDirection, float& OutSpeed, float& OutMinGustAmt, float& OutMaxGustAmt )	Accesses wind parameters safely for game thread applications
const TArray...	GetWindSources_RenderThread()	Accesses the wind source list. Must be called in the rendering thread.
UWorld *	GetWorld()	Get the optional UWorld that is associated with this scene
bool	HasAnyExponentialHeightFog()
bool	HasAnyLights()
bool	HasAtmosphereLightRequiringLightingBuild()
bool	HasPrecomputedVolumetricLightmap_RenderThread()
bool	HasSkyLightRequiringLightingBuild()
void	IncrementFrameNumber()
bool	InitializePixelInspector ( FRenderTarget* BufferFinalColo..., FRenderTarget* BufferSceneColo..., FRenderTarget* BufferDepth, FRenderTarget* BufferHDR, FRenderTarget* BufferA, FRenderTarget* BufferBCDEF, int32 BufferIndex )	Initialize the pixel inspector buffers.
void	InvalidateRuntimeVirtualTexture ( URuntimeVirtualTextureComponent..., FBoxSphereBounds const& WorldBound... )	Invalidates pages in a runtime virtual texture object.
bool	IsEditorScene()
void	OnLevelAddedToWorld ( FName InLevelName, UWorld* InWorld, bool bIsLightingScenario )	Notification that level was added to a world
void	OnLevelRemovedFromWorld ( UWorld* InWorld, bool bIsLightingScenario )
void	OnWorldCleanup()
void	Release()	Release this scene and remove it from the rendering thread
void	ReleasePrimitive ( UPrimitiveComponent* Primitive )	Called when a primitive is being unregistered and will not be immediately re-registered.
void	ReleaseReflectionCubemap ( UReflectionCaptureComponent* C... )
void	RemoveAtmosphericFog_Impl ( UAtmosphericFogComponent* FogC... )
void	RemoveAtmosphericFogResource_RenderThread_Impl ( FRenderResource* FogResource )
void	RemoveDecal ( UDecalComponent* Component )	Removes a decal component from the scene
void	RemoveExponentialHeightFog ( UExponentialHeightFogComponent*... )	Removes a exponential height fog component from the scene
void	RemoveLight ( ULightComponent* Light )	Removes a light component from the scene
void	RemovePlanarReflection ( UPlanarReflectionComponent* Co... )
void	RemovePrecomputedLightVolume ( const FPrecomputedLightVolume*... )
void	RemovePrecomputedVolumetricLightmap ( const FPrecomputedVolumetricLightma... )
void	RemovePrimitive ( UPrimitiveComponent* Primitive )	Removes a primitive component from the scene
void	RemoveReflectionCapture ( UReflectionCaptureComponent* C... )	Removes a reflection capture from the scene.
void	RemoveRuntimeVirtualTexture ( URuntimeVirtualTextureComponent... )	Removes a runtime virtual texture object from the scene.
void	RemoveSkyAtmosphere ( FSkyAtmosphereSceneProxy* SkyA... )	Removes the unique volumetric cloud component to the scene
void	RemoveSpeedTreeWind_RenderThread ( FVertexFactory* VertexFactory, const UStaticMesh* StaticMesh )	Removes a SpeedTree wind computation object to the scene.
void	RemoveVolumetricCloud ( FVolumetricCloudSceneProxy* Vo... )	Removes the unique volumetric cloud component to the scene
void	RemoveWindSource ( UWindDirectionalSourceComponent... )	Removes a wind source component from the scene.
bool	RequiresHitProxies()	Indicates if hit proxies should be processed by this scene
void	ResetPhysicsField()	Reset the physics field scene proxy
void	SetFXSystem ( FFXSystemInterface* InFXSystem )	Sets the FX system associated with the scene.
void	SetPhysicsField ( FPhysicsFieldSceneProxy* Physi... )	Set the physics field scene proxy to the scene
void	SetPrecomputedVisibility ( const FPrecomputedVisibilityHandler... )	Sets the precomputed visibility handler for the scene, or NULL to clear the current one.
void	SetPrecomputedVolumeDistanceField ( const FPrecomputedVolumeDistanceFie... )	Sets the precomputed volume distance field for the scene, or NULL to clear the current one.
void	SetSkyLight ( FSkyLightSceneProxy* Light )
void	StartFrame()
void	UpdateAllPrimitiveSceneInfos ( FRHICommandListImmediate& RHICmdLi..., bool bAsyncCreateLPIs )	Updates all primitive scene info additions, remobals and translation changes
void	UpdateCachedRenderStates ( FPrimitiveSceneProxy* ScenePro... )	Update render states that possibly cached inside renderer, like mesh draw commands.
void	UpdateCustomPrimitiveData ( UPrimitiveComponent* Primitive )	Updates the custom primitive data of a primitive component which has already been added to the scene.
void	UpdateDecalFadeInTime ( UDecalComponent* Component )
void	UpdateDecalFadeOutTime ( UDecalComponent* Component )
void	UpdateDecalTransform ( UDecalComponent* Component )	Updates the transform of a decal which has already been added to the scene.
void	UpdateLightColorAndBrightness ( ULightComponent* Light )	Updates the color and brightness of a light which has already been added to the scene.
void	UpdateLightTransform ( ULightComponent* Light )	Updates the transform of a light which has already been added to the scene.
void	UpdateParameterCollections ( const TArray< class FMaterialParame... )	Updates the scene's list of parameter collection id's and their uniform buffers.
void	UpdatePhysicsField ( FRHICommandListImmediate& RHICmdLi..., FViewInfo& View )	Reset the physics field scene proxy
void	UpdatePlanarReflectionContents ( UPlanarReflectionComponent* Ca..., FSceneRenderer& MainSceneRenderer )
void	UpdatePlanarReflectionTransform ( UPlanarReflectionComponent* Co... )
void	UpdatePrimitiveAttachment ( UPrimitiveComponent* Primitive )	Updates primitive attachment state.
void	UpdatePrimitiveDistanceFieldSceneData_GameThread ( UPrimitiveComponent* Primitive )	Updates distance field scene data (transforms, uv scale, self-shadow bias, etc.) but doesn't change allocation in the atlas
void	UpdatePrimitiveTransform ( UPrimitiveComponent* Primitive )	Updates the transform of a primitive which has already been added to the scene.
void	UpdateReflectionCaptureTransform ( UReflectionCaptureComponent* C... )	Updates a reflection capture's transform, and then re-captures the scene.
void	UpdateSceneCaptureContents ( USceneCaptureComponent2D* Capt... )	Updates the contents of the given scene capture by rendering the scene.
void	UpdateSceneCaptureContents ( USceneCaptureComponentCube* Ca... )
void	UpdateSceneSettings ( AWorldSettings* WorldSettings )
void	UpdateSkyCaptureContents ( const USkyLightComponent* Capt..., bool bCaptureEmissiveOnly, UTextureCube* SourceCubemap, FTexture* OutProcessedTexture, float& OutAverageBrightness, FSHVectorRGB3& OutIrradianceEnviro..., TArray< FFloat16Color >* OutRa... )	Updates the contents of the given sky capture by rendering the scene.
void	UpdateSpeedTreeWind ( double CurrentTime )	Ticks the SpeedTree wind object and updates the uniform buffer.
void	UpdateStaticDrawLists()	Updates all static draw lists.
void	UpdateWindSource ( UWindDirectionalSourceComponent... )	Update a wind source component from the scene.
void	ValidateSkyLightRealTimeCapture ( FRDGBuilder& GraphBuilder, const FViewInfo& View, FRDGTextureRef SceneColorTexture )

Deprecated Functions

	Name	Description
void	AddAtmosphericFog ( UAtmosphericFogComponent* FogC... )	Please use the SkyAtmosphere actor instead.
FAtmospheric...	GetAtmosphericFogSceneInfo()	Please use the SkyAtmosphere actor instead.
void	RemoveAtmosphericFog ( UAtmosphericFogComponent* FogC... )	Please use the SkyAtmosphere actor instead.
void	RemoveAtmosphericFogResource_RenderThread ( FRenderResource* FogResource )	Please use the SkyAtmosphere actor instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss