UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FRendererModule Class Referencefinal

#include <RendererModule.h>

+ Inheritance diagram for FRendererModule:

Public Member Functions

 FRendererModule ()
 
virtual bool SupportsDynamicReloading () override
 
virtual void StartupModule () override
 
virtual void ShutdownModule () override
 
virtual void BeginRenderingViewFamily (FCanvas *Canvas, FSceneViewFamily *ViewFamily) override
 
virtual void CreateAndInitSingleView (FRHICommandListImmediate &RHICmdList, class FSceneViewFamily *ViewFamily, const struct FSceneViewInitOptions *ViewInitOptions) override
 
virtual FSceneInterface * AllocateScene (UWorld *World, bool bInRequiresHitProxies, bool bCreateFXSystem, ERHIFeatureLevel::Type InFeatureLevel) override
 
virtual void RemoveScene (FSceneInterface *Scene) override
 
virtual void UpdateStaticDrawLists () override
 
virtual void UpdateStaticDrawListsForMaterials (const TArray< const FMaterial * > &Materials) override
 
virtual FSceneViewStateInterface * AllocateViewState (ERHIFeatureLevel::Type FeatureLevel) override
 
virtual FSceneViewStateInterface * AllocateViewState (ERHIFeatureLevel::Type FeatureLevel, FSceneViewStateInterface *ShareOriginTarget) override
 
virtual uint32 GetNumDynamicLightsAffectingPrimitive (const FPrimitiveSceneInfo *PrimitiveSceneInfo, const FLightCacheInterface *LCI) override
 
virtual void OnWorldCleanup (UWorld *World, bool bSessionEnded, bool bCleanupResources, bool bWorldChanged) override
 
virtual void InitializeSystemTextures (FRHICommandListImmediate &RHICmdList)
 
virtual FSceneUniformBuffer * CreateSinglePrimitiveSceneUniformBuffer (FRDGBuilder &GraphBuilder, ERHIFeatureLevel::Type FeatureLevel, FMeshBatch &Mesh) override
 
virtual FSceneUniformBuffer * CreateSinglePrimitiveSceneUniformBuffer (FRDGBuilder &GraphBuilder, const FViewInfo &SceneView, FMeshBatch &Mesh) override
 
virtual TRDGUniformBufferRef< FBatchedPrimitiveParameters > CreateSinglePrimitiveUniformView (FRDGBuilder &GraphBuilder, ERHIFeatureLevel::Type FeatureLevel, EShaderPlatform ShaderPlatform, FMeshBatch &Mesh) override
 
virtual TRDGUniformBufferRef< FBatchedPrimitiveParameters > CreateSinglePrimitiveUniformView (FRDGBuilder &GraphBuilder, const FViewInfo &SceneView, FMeshBatch &Mesh) override
 
virtual void DrawTileMesh (FCanvasRenderContext &RenderContext, FMeshPassProcessorRenderState &DrawRenderState, const FSceneView &View, FMeshBatch &Mesh, bool bIsHitTesting, const FHitProxyId &HitProxyId, bool bUse128bitRT=false) override
 
virtual void DebugLogOnCrash () override
 
virtual void GPUBenchmark (FSynthBenchmarkResults &InOut, float WorkScale) override
 
virtual void ExecVisualizeTextureCmd (const FString &Cmd) override
 
virtual void UpdateMapNeedsLightingFullyRebuiltState (UWorld *World) override
 
virtual void DrawRectangle (FRHICommandList &RHICmdList, float X, float Y, float SizeX, float SizeY, float U, float V, float SizeU, float SizeV, FIntPoint TargetSize, FIntPoint TextureSize, const TShaderRef< FShader > &VertexShader, EDrawRectangleFlags Flags=EDRF_Default) override
 
virtual const TSet< FSceneInterface * > & GetAllocatedScenes () override
 
virtual void RegisterCustomCullingImpl (ICustomCulling *impl) override
 
virtual void UnregisterCustomCullingImpl (ICustomCulling *impl) override
 
virtual FDelegateHandle RegisterPostOpaqueRenderDelegate (const FPostOpaqueRenderDelegate &InPostOpaqueRenderDelegate) override
 
virtual void RemovePostOpaqueRenderDelegate (FDelegateHandle InPostOpaqueRenderDelegate) override
 
virtual FDelegateHandle RegisterOverlayRenderDelegate (const FPostOpaqueRenderDelegate &InOverlayRenderDelegate) override
 
virtual void RemoveOverlayRenderDelegate (FDelegateHandle InOverlayRenderDelegate) override
 
virtual FOnResolvedSceneColor & GetResolvedSceneColorCallbacks () override
 
virtual void PostRenderAllViewports () override
 
virtual void PerFrameCleanupIfSkipRenderer () override
 
virtual IMaterialCacheTagProvider * GetMaterialCacheTagProvider () override
 
virtual IAllocatedVirtualTexture * AllocateVirtualTexture (FRHICommandListBase &RHICmdList, const FAllocatedVTDescription &Desc) override
 
virtual void DestroyVirtualTexture (IAllocatedVirtualTexture *AllocatedVT) override
 
virtual IAdaptiveVirtualTexture * AllocateAdaptiveVirtualTexture (FRHICommandListBase &RHICmdList, const FAdaptiveVTDescription &AdaptiveVTDesc, const FAllocatedVTDescription &AllocatedVTDesc) override
 
virtual void DestroyAdaptiveVirtualTexture (IAdaptiveVirtualTexture *AdaptiveVT) override
 
virtual FVirtualTextureProducerHandle RegisterVirtualTextureProducer (FRHICommandListBase &RHICmdList, const FVTProducerDescription &Desc, IVirtualTexture *Producer) override
 
virtual void ReleaseVirtualTextureProducer (const FVirtualTextureProducerHandle &Handle) override
 
virtual void AddVirtualTextureProducerDestroyedCallback (const FVirtualTextureProducerHandle &Handle, FVTProducerDestroyedFunction *Function, void *Baton) override
 
virtual uint32 RemoveAllVirtualTextureProducerDestroyedCallbacks (const void *Baton) override
 
virtual void ReleaseVirtualTexturePendingResources () override
 
virtual void RequestVirtualTextureTiles (TArray< uint64 > &&InPageRequests) override
 
virtual void RequestVirtualTextureTiles (const FVector2D &InScreenSpaceSize, int32 InMipLevel) override
 
virtual void RequestVirtualTextureTiles (const FMaterialRenderProxy *InMaterialRenderProxy, const FVector2D &InScreenSpaceSize, ERHIFeatureLevel::Type InFeatureLevel) override
 
virtual void RequestVirtualTextureTiles (IAllocatedVirtualTexture *AllocatedVT, const FVector2D &InScreenSpaceSize, const FVector2D &InViewportPosition, const FVector2D &InViewportSize, const FVector2D &InUV0, const FVector2D &InUV1, int32 InMipLevel) override
 
virtual IVirtualTexture * FindProducer (const FVirtualTextureProducerHandle &Handle) override
 
virtual void LoadPendingVirtualTextureTiles (FRHICommandListImmediate &RHICmdList, ERHIFeatureLevel::Type FeatureLevel) override
 
virtual void LockVirtualTextureTiles (FVirtualTextureProducerHandle ProducerHandle, int32 InMipLevel) override
 
virtual void SetVirtualTextureRequestRecordBuffer (uint64 Handle) override
 
virtual uint64 GetVirtualTextureRequestRecordBuffer (TSet< uint64 > &OutPageRequests) override
 
virtual void FlushVirtualTextureCache () override
 
virtual void FlushVirtualTextureCache (IAllocatedVirtualTexture *AllocatedVT, const FVector2f &InUV0, const FVector2f &InUV1) override
 
virtual void SyncVirtualTextureUpdates (FRHICommandListImmediate &RHICmdList, ERHIFeatureLevel::Type FeatureLevel) override
 
virtual void SetNaniteRequestRecordBuffer (uint64 Handle) override
 
virtual uint64 GetNaniteRequestRecordBuffer (TArray< uint32 > &OutPageRequests) override
 
virtual void RequestNanitePages (TArrayView< uint32 > InRequestData) override
 
virtual void PrefetchNaniteResource (const Nanite::FResources *Resource, uint32 NumFramesUntilRender) override
 
virtual void RegisterPersistentViewUniformBufferExtension (IPersistentViewUniformBufferExtension *Extension) override
 
void RenderPostOpaqueExtensions (FRDGBuilder &GraphBuilder, TArrayView< const FViewInfo > Views, const FSceneTextures &SceneTextures)
 
void RenderOverlayExtensions (FRDGBuilder &GraphBuilder, TArrayView< const FViewInfo > Views, const FSceneTextures &SceneTextures)
 
void RenderPostResolvedSceneColorExtension (FRDGBuilder &GraphBuilder, const FSceneTextures &SceneTextures)
 
virtual IScenePrimitiveRenderingContext * BeginScenePrimitiveRendering (FRDGBuilder &GraphBuilder, FSceneViewFamily *ViewFamily) override
 
virtual IScenePrimitiveRenderingContext * BeginScenePrimitiveRendering (FRDGBuilder &GraphBuilder, FSceneInterface &Scene) override
 
virtual void InvalidatePathTracedOutput (PathTracing::EInvalidateReason InvalidateReason=PathTracing::EInvalidateReason::Uncategorized) override
 
virtual void BeginRenderingViewFamilies (FCanvas *Canvas, TConstArrayView< FSceneViewFamily * > ViewFamilies) override
 
virtual void ResetSceneTextureExtentHistory () override
 
virtual const FViewMatrices & GetPreviousViewMatrices (const FSceneView &View) override
 
virtual const FGlobalDistanceFieldParameterData * GetGlobalDistanceFieldParameterData (const FSceneView &View) override
 
virtual void RequestStaticMeshUpdate (FPrimitiveSceneInfo *Info) override
 
virtual void AddMeshBatchToGPUScene (FGPUScenePrimitiveCollector *Collector, FMeshBatch &MeshBatch) override
 
virtual TUniquePtr< ISceneRenderBuilder > CreateSceneRenderBuilder (FSceneInterface *Scene) override
 
- Public Member Functions inherited from IRendererModule
virtual uint32 GetNumDynamicLightsAffectingPrimitive (const class FPrimitiveSceneInfo *PrimitiveSceneInfo, const class FLightCacheInterface *LCI)=0
 
virtual void DrawTileMesh (FCanvasRenderContext &RenderContext, struct FMeshPassProcessorRenderState &DrawRenderState, const FSceneView &View, FMeshBatch &Mesh, bool bIsHitTesting, const class FHitProxyId &HitProxyId, bool bUse128bitRT=false)=0
 
virtual void DrawRectangle (FRHICommandList &RHICmdList, float X, float Y, float SizeX, float SizeY, float U, float V, float SizeU, float SizeV, FIntPoint TargetSize, FIntPoint TextureSize, const TShaderRefBase< FShader, FShaderMapPointerTable > &VertexShader, EDrawRectangleFlags Flags=EDRF_Default)=0
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FOnResolvedSceneColor, FRDGBuilder &, const FSceneTextures &)
 
RENDERCORE_API IAllocatedVirtualTexture * AllocateVirtualTexture (const FAllocatedVTDescription &Desc)
 
RENDERCORE_API IAdaptiveVirtualTexture * AllocateAdaptiveVirtualTexture (const FAdaptiveVTDescription &AdaptiveVTDesc, const FAllocatedVTDescription &AllocatedVTDesc)
 
RENDERCORE_API FVirtualTextureProducerHandle RegisterVirtualTextureProducer (const FVTProducerDescription &Desc, IVirtualTexture *Producer)
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Detailed Description

The renderer module implementation.

Constructor & Destructor Documentation

◆ FRendererModule()

FRendererModule::FRendererModule ( )

Member Function Documentation

◆ AddMeshBatchToGPUScene()

void FRendererModule::AddMeshBatchToGPUScene ( FGPUScenePrimitiveCollector *  Collector,
FMeshBatch &  MeshBatch 
)
overridevirtual

Implements IRendererModule.

◆ AddVirtualTextureProducerDestroyedCallback()

void FRendererModule::AddVirtualTextureProducerDestroyedCallback ( const FVirtualTextureProducerHandle &  Handle,
FVTProducerDestroyedFunction *  Function,
void *  Baton 
)
overridevirtual

Implements IRendererModule.

◆ AllocateAdaptiveVirtualTexture()

IAdaptiveVirtualTexture * FRendererModule::AllocateAdaptiveVirtualTexture ( FRHICommandListBase &  RHICmdList,
const FAdaptiveVTDescription &  AdaptiveVTDesc,
const FAllocatedVTDescription &  AllocatedVTDesc 
)
overridevirtual

Implements IRendererModule.

◆ AllocateScene()

FSceneInterface * FRendererModule::AllocateScene ( UWorld *  World,
bool  bInRequiresHitProxies,
bool  bCreateFXSystem,
ERHIFeatureLevel::Type  InFeatureLevel 
)
overridevirtual

Allocates a new instance of the private FScene implementation for the given world.

Parameters
World- An optional world to associate with the scene.
bInRequiresHitProxies- Indicates that hit proxies should be rendered in the scene.

Implements IRendererModule.

◆ AllocateViewState() [1/2]

FSceneViewStateInterface * FRendererModule::AllocateViewState ( ERHIFeatureLevel::Type  FeatureLevel)
overridevirtual

Allocates a new instance of the private scene manager implementation of FSceneViewStateInterface

Implements IRendererModule.

◆ AllocateViewState() [2/2]

FSceneViewStateInterface * FRendererModule::AllocateViewState ( ERHIFeatureLevel::Type  FeatureLevel,
FSceneViewStateInterface *  ShareOriginTarget 
)
overridevirtual

Implements IRendererModule.

◆ AllocateVirtualTexture()

IAllocatedVirtualTexture * FRendererModule::AllocateVirtualTexture ( FRHICommandListBase &  RHICmdList,
const FAllocatedVTDescription &  Desc 
)
overridevirtual

Implements IRendererModule.

◆ BeginRenderingViewFamilies()

void FRendererModule::BeginRenderingViewFamilies ( FCanvas *  Canvas,
TConstArrayView< FSceneViewFamily * >  ViewFamilies 
)
overridevirtual

Experimental: Render multiple view families in a single scene render call. All families must reference the same FScene. Scene Capture not yet supported.

Implements IRendererModule.

◆ BeginRenderingViewFamily()

void FRendererModule::BeginRenderingViewFamily ( FCanvas *  Canvas,
FSceneViewFamily *  ViewFamily 
)
overridevirtual

Call from the game thread to send a message to the rendering thread to being rendering this view family.

Implements IRendererModule.

◆ BeginScenePrimitiveRendering() [1/2]

IScenePrimitiveRenderingContext * FRendererModule::BeginScenePrimitiveRendering ( FRDGBuilder &  GraphBuilder,
FSceneInterface &  Scene 
)
overridevirtual

Implements IRendererModule.

◆ BeginScenePrimitiveRendering() [2/2]

IScenePrimitiveRenderingContext * FRendererModule::BeginScenePrimitiveRendering ( FRDGBuilder &  GraphBuilder,
FSceneViewFamily *  ViewFamily 
)
overridevirtual

Prepare Scene primitive rendering and return context. Ensures all primitives that are created are commited and GPU-Scene is updated and allocates a dynamic primitive context. The intended use is for stand-alone rendering that involves Scene proxies (that then may need the machinery to render GPU-Scene aware primitives.

Implements IRendererModule.

◆ CreateAndInitSingleView()

void FRendererModule::CreateAndInitSingleView ( FRHICommandListImmediate &  RHICmdList,
class FSceneViewFamily *  ViewFamily,
const struct FSceneViewInitOptions *  ViewInitOptions 
)
overridevirtual

Call from the render thread to create and initalize a new FViewInfo with the specified options, and add it to the specified view family.

Implements IRendererModule.

◆ CreateSceneRenderBuilder()

TUniquePtr< ISceneRenderBuilder > FRendererModule::CreateSceneRenderBuilder ( FSceneInterface *  Scene)
overridevirtual

Implements IRendererModule.

◆ CreateSinglePrimitiveSceneUniformBuffer() [1/2]

FSceneUniformBuffer * FRendererModule::CreateSinglePrimitiveSceneUniformBuffer ( FRDGBuilder &  GraphBuilder,
const FViewInfo &  SceneView,
FMeshBatch &  Mesh 
)
overridevirtual

Implements IRendererModule.

◆ CreateSinglePrimitiveSceneUniformBuffer() [2/2]

FSceneUniformBuffer * FRendererModule::CreateSinglePrimitiveSceneUniformBuffer ( FRDGBuilder &  GraphBuilder,
ERHIFeatureLevel::Type  FeatureLevel,
FMeshBatch &  Mesh 
)
overridevirtual

Create a Scene Uniform Buffer containing only the scene representation for a single primitive

Implements IRendererModule.

◆ CreateSinglePrimitiveUniformView() [1/2]

TRDGUniformBufferRef< FBatchedPrimitiveParameters > FRendererModule::CreateSinglePrimitiveUniformView ( FRDGBuilder &  GraphBuilder,
const FViewInfo &  SceneView,
FMeshBatch &  Mesh 
)
overridevirtual

Implements IRendererModule.

◆ CreateSinglePrimitiveUniformView() [2/2]

TRDGUniformBufferRef< FBatchedPrimitiveParameters > FRendererModule::CreateSinglePrimitiveUniformView ( FRDGBuilder &  GraphBuilder,
ERHIFeatureLevel::Type  FeatureLevel,
EShaderPlatform  ShaderPlatform,
FMeshBatch &  Mesh 
)
overridevirtual

Create a Uniform Buffer containing representation for a single primitive. (For platforms that use "UniformView" path)

Implements IRendererModule.

◆ DebugLogOnCrash()

void FRendererModule::DebugLogOnCrash ( )
overridevirtual

Renderer gets a chance to log some useful crash data

Implements IRendererModule.

◆ DestroyAdaptiveVirtualTexture()

void FRendererModule::DestroyAdaptiveVirtualTexture ( IAdaptiveVirtualTexture *  AdaptiveVT)
overridevirtual

Implements IRendererModule.

◆ DestroyVirtualTexture()

void FRendererModule::DestroyVirtualTexture ( IAllocatedVirtualTexture *  AllocatedVT)
overridevirtual

Implements IRendererModule.

◆ DrawRectangle()

void FRendererModule::DrawRectangle ( FRHICommandList &  RHICmdList,
float  X,
float  Y,
float  SizeX,
float  SizeY,
float  U,
float  V,
float  SizeU,
float  SizeV,
FIntPoint  TargetSize,
FIntPoint  TextureSize,
const TShaderRef< FShader > &  VertexShader,
EDrawRectangleFlags  Flags = EDRF_Default 
)
overridevirtual

◆ DrawTileMesh()

void FRendererModule::DrawTileMesh ( FCanvasRenderContext &  RenderContext,
FMeshPassProcessorRenderState &  DrawRenderState,
const FSceneView &  View,
FMeshBatch &  Mesh,
bool  bIsHitTesting,
const FHitProxyId &  HitProxyId,
bool  bUse128bitRT = false 
)
overridevirtual

◆ ExecVisualizeTextureCmd()

void FRendererModule::ExecVisualizeTextureCmd ( const FString &  Cmd)
overridevirtual

Implements IRendererModule.

◆ FindProducer()

IVirtualTexture * FRendererModule::FindProducer ( const FVirtualTextureProducerHandle &  Handle)
overridevirtual

Implements IRendererModule.

◆ FlushVirtualTextureCache() [1/2]

void FRendererModule::FlushVirtualTextureCache ( )
overridevirtual

Evict all data from virtual texture caches.

Implements IRendererModule.

◆ FlushVirtualTextureCache() [2/2]

void FRendererModule::FlushVirtualTextureCache ( IAllocatedVirtualTexture *  AllocatedVT,
const FVector2f &  InUV0,
const FVector2f &  InUV1 
)
overridevirtual

Evict all data from virtual texture cache for a given allocated virtual texture.

Implements IRendererModule.

◆ GetAllocatedScenes()

virtual const TSet< FSceneInterface * > & FRendererModule::GetAllocatedScenes ( )
inlineoverridevirtual

Implements IRendererModule.

◆ GetGlobalDistanceFieldParameterData()

const FGlobalDistanceFieldParameterData * FRendererModule::GetGlobalDistanceFieldParameterData ( const FSceneView &  View)
overridevirtual

Implements IRendererModule.

◆ GetMaterialCacheTagProvider()

IMaterialCacheTagProvider * FRendererModule::GetMaterialCacheTagProvider ( )
overridevirtual

Get the shared tag provider, always valid

Implements IRendererModule.

◆ GetNaniteRequestRecordBuffer()

uint64 FRendererModule::GetNaniteRequestRecordBuffer ( TArray< uint32 > &  OutRequestData)
overridevirtual

Fetch the page requests recorded since the last call to SetNaniteRequestRecordBuffer. Returns the handle that was passed in.

Implements IRendererModule.

◆ GetNumDynamicLightsAffectingPrimitive()

uint32 FRendererModule::GetNumDynamicLightsAffectingPrimitive ( const FPrimitiveSceneInfo *  PrimitiveSceneInfo,
const FLightCacheInterface *  LCI 
)
overridevirtual

◆ GetPreviousViewMatrices()

const FViewMatrices & FRendererModule::GetPreviousViewMatrices ( const FSceneView &  View)
overridevirtual

Implements IRendererModule.

◆ GetResolvedSceneColorCallbacks()

virtual FOnResolvedSceneColor & FRendererModule::GetResolvedSceneColorCallbacks ( )
inlineoverridevirtual

Accessor for post scene color resolve delegates

Implements IRendererModule.

◆ GetVirtualTextureRequestRecordBuffer()

uint64 FRendererModule::GetVirtualTextureRequestRecordBuffer ( TSet< uint64 > &  OutPageRequests)
overridevirtual

Fetch the virtual texture page requests recorded since the last call to SetVirtualTextureRequestRecordBuffer. Returns the handle that was passed in.

Implements IRendererModule.

◆ GPUBenchmark()

void FRendererModule::GPUBenchmark ( FSynthBenchmarkResults &  InOut,
float  WorkScale 
)
overridevirtual

Implements IRendererModule.

◆ InitializeSystemTextures()

void FRendererModule::InitializeSystemTextures ( FRHICommandListImmediate &  RHICmdList)
virtual

Implements IRendererModule.

◆ InvalidatePathTracedOutput()

void FRendererModule::InvalidatePathTracedOutput ( PathTracing::EInvalidateReason  InvalidateReason = PathTracing::EInvalidateReason::Uncategorized)
overridevirtual

Mark all the current scenes as needing to restart path tracer accumulation

Implements IRendererModule.

◆ LoadPendingVirtualTextureTiles()

void FRendererModule::LoadPendingVirtualTextureTiles ( FRHICommandListImmediate &  RHICmdList,
ERHIFeatureLevel::Type  FeatureLevel 
)
overridevirtual

Ensure that any tiles requested by 'RequestVirtualTextureTiles' are loaded, must be called from render thread

Implements IRendererModule.

◆ LockVirtualTextureTiles()

void FRendererModule::LockVirtualTextureTiles ( FVirtualTextureProducerHandle  ProducerHandle,
int32  InMipLevel 
)
overridevirtual

Lock all tiles associated with a producer up to and including a given mip level. The mip level is stored on the producer, so that if we call twice then the second call will either lock or unlock tiles to reach the new level. Locked tiles should remain resident once loaded, though there is no guarantee over how quickly they will be loaded. Also if the virtual texture pools are already oversubscribed then we will not be able to satisfy the loading.

Implements IRendererModule.

◆ OnWorldCleanup()

void FRendererModule::OnWorldCleanup ( UWorld *  World,
bool  bSessionEnded,
bool  bCleanupResources,
bool  bWorldChanged 
)
overridevirtual

Implements IRendererModule.

◆ PerFrameCleanupIfSkipRenderer()

void FRendererModule::PerFrameCleanupIfSkipRenderer ( )
overridevirtual

Performs necessary per-frame cleanup. Only use when rendering through scene renderer (i.e. BeginRenderingViewFamily) is skipped

Implements IRendererModule.

◆ PostRenderAllViewports()

void FRendererModule::PostRenderAllViewports ( )
overridevirtual

Implements IRendererModule.

◆ PrefetchNaniteResource()

void FRendererModule::PrefetchNaniteResource ( const Nanite::FResources *  Resource,
uint32  NumFramesUntilRender 
)
overridevirtual

Start prefetching streaming data for Nanite resource that will soon be used for rendering. TODO: Implement callback mechanism

Implements IRendererModule.

◆ RegisterCustomCullingImpl()

void FRendererModule::RegisterCustomCullingImpl ( ICustomCulling *  impl)
overridevirtual

Register/unregister a custom occlusion culling implementation

Implements IRendererModule.

◆ RegisterOverlayRenderDelegate()

FDelegateHandle FRendererModule::RegisterOverlayRenderDelegate ( const FPostOpaqueRenderDelegate &  InOverlayRenderDelegate)
overridevirtual

Implements IRendererModule.

◆ RegisterPersistentViewUniformBufferExtension()

void FRendererModule::RegisterPersistentViewUniformBufferExtension ( IPersistentViewUniformBufferExtension *  Extension)
overridevirtual

Implements IRendererModule.

◆ RegisterPostOpaqueRenderDelegate()

FDelegateHandle FRendererModule::RegisterPostOpaqueRenderDelegate ( const FPostOpaqueRenderDelegate &  InPostOpaqueRenderDelegate)
overridevirtual

Implements IRendererModule.

◆ RegisterVirtualTextureProducer()

FVirtualTextureProducerHandle FRendererModule::RegisterVirtualTextureProducer ( FRHICommandListBase &  RHICmdList,
const FVTProducerDescription &  Desc,
IVirtualTexture *  Producer 
)
overridevirtual

Implements IRendererModule.

◆ ReleaseVirtualTexturePendingResources()

void FRendererModule::ReleaseVirtualTexturePendingResources ( )
overridevirtual

Implements IRendererModule.

◆ ReleaseVirtualTextureProducer()

void FRendererModule::ReleaseVirtualTextureProducer ( const FVirtualTextureProducerHandle &  Handle)
overridevirtual

Implements IRendererModule.

◆ RemoveAllVirtualTextureProducerDestroyedCallbacks()

uint32 FRendererModule::RemoveAllVirtualTextureProducerDestroyedCallbacks ( const void *  Baton)
overridevirtual

Implements IRendererModule.

◆ RemoveOverlayRenderDelegate()

void FRendererModule::RemoveOverlayRenderDelegate ( FDelegateHandle  InOverlayRenderDelegate)
overridevirtual

Implements IRendererModule.

◆ RemovePostOpaqueRenderDelegate()

void FRendererModule::RemovePostOpaqueRenderDelegate ( FDelegateHandle  InPostOpaqueRenderDelegate)
overridevirtual

Implements IRendererModule.

◆ RemoveScene()

void FRendererModule::RemoveScene ( FSceneInterface *  Scene)
overridevirtual

Implements IRendererModule.

◆ RenderOverlayExtensions()

void FRendererModule::RenderOverlayExtensions ( FRDGBuilder &  GraphBuilder,
TArrayView< const FViewInfo >  Views,
const FSceneTextures &  SceneTextures 
)

◆ RenderPostOpaqueExtensions()

void FRendererModule::RenderPostOpaqueExtensions ( FRDGBuilder &  GraphBuilder,
TArrayView< const FViewInfo >  Views,
const FSceneTextures &  SceneTextures 
)

◆ RenderPostResolvedSceneColorExtension()

void FRendererModule::RenderPostResolvedSceneColorExtension ( FRDGBuilder &  GraphBuilder,
const FSceneTextures &  SceneTextures 
)

◆ RequestNanitePages()

void FRendererModule::RequestNanitePages ( TArrayView< uint32 >  InRequestData)
overridevirtual

Request Nanite pages that were captured with SetNaniteRequestRecordBuffer. Note that the array will be moved and ownership is taken.

Implements IRendererModule.

◆ RequestStaticMeshUpdate()

void FRendererModule::RequestStaticMeshUpdate ( FPrimitiveSceneInfo *  Info)
overridevirtual

Implements IRendererModule.

◆ RequestVirtualTextureTiles() [1/4]

void FRendererModule::RequestVirtualTextureTiles ( const FMaterialRenderProxy *  InMaterialRenderProxy,
const FVector2D &  InScreenSpaceSize,
ERHIFeatureLevel::Type  InFeatureLevel 
)
overridevirtual

Implements IRendererModule.

◆ RequestVirtualTextureTiles() [2/4]

void FRendererModule::RequestVirtualTextureTiles ( const FVector2D &  InScreenSpaceSize,
int32  InMipLevel 
)
overridevirtual

Implements IRendererModule.

◆ RequestVirtualTextureTiles() [3/4]

void FRendererModule::RequestVirtualTextureTiles ( IAllocatedVirtualTexture *  AllocatedVT,
const FVector2D &  InScreenSpaceSize,
const FVector2D &  InViewportPosition,
const FVector2D &  InViewportSize,
const FVector2D &  InUV0,
const FVector2D &  InUV1,
int32  InMipLevel 
)
overridevirtual

Helper function to request loading of tiles for a virtual texture that will be displayed in the UI. It will request only the tiles that will be visible after clipping to the provided viewport.

Parameters
AllocatedVTThe virtual texture.
InScreenSpaceSizeSize on screen at which the texture is to be displayed.
InViewportPositionPosition in the viewport where the texture will be displayed.
InViewportSizeSize of the viewport.
InUV0UV coordinate to use for the top left corner of the texture.
InUV1UV coordinate to use for the bottom right corner of the texture.
InMipLevel[optional] Specific mip level to fetch tiles for.

Implements IRendererModule.

◆ RequestVirtualTextureTiles() [4/4]

void FRendererModule::RequestVirtualTextureTiles ( TArray< uint64 > &&  InPageRequests)
overridevirtual

Request an array of virtual texture page requests that was captured with SetVirtualTextureRequestRecordBuffer. Note that the array will be moved and ownership is taken.

Implements IRendererModule.

◆ ResetSceneTextureExtentHistory()

void FRendererModule::ResetSceneTextureExtentHistory ( )
overridevirtual

Resets the scene texture extent history. Call this method after rendering with very large render targets. The next scene render will create them at the requested size.

Implements IRendererModule.

◆ SetNaniteRequestRecordBuffer()

void FRendererModule::SetNaniteRequestRecordBuffer ( uint64  Handle)
overridevirtual

Allocate a buffer and record all nanite page requests until the next call to either SetNaniteRequestRecordBuffer or GetNaniteRequestRecordBuffer.

Implements IRendererModule.

◆ SetVirtualTextureRequestRecordBuffer()

void FRendererModule::SetVirtualTextureRequestRecordBuffer ( uint64  Handle)
overridevirtual

Allocate a buffer and record all virtual texture page requests until the next call to either SetVirtualTextureRequestRecordBuffer or GetVirtualTextureRequestRecordBuffer.

Implements IRendererModule.

◆ ShutdownModule()

void FRendererModule::ShutdownModule ( )
overridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

◆ StartupModule()

void FRendererModule::StartupModule ( )
overridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

◆ SupportsDynamicReloading()

virtual bool FRendererModule::SupportsDynamicReloading ( )
inlineoverridevirtual

Override this to set whether your module is allowed to be unloaded on the fly

Returns
Whether the module supports shutdown separate from the rest of the engine.

Reimplemented from IModuleInterface.

◆ SyncVirtualTextureUpdates()

void FRendererModule::SyncVirtualTextureUpdates ( FRHICommandListImmediate &  RHICmdList,
ERHIFeatureLevel::Type  FeatureLevel 
)
overridevirtual

Do a full virtual texture system update to read and process feedback. This will sync until all outstanding page rendering or streaming is complete.

Implements IRendererModule.

◆ UnregisterCustomCullingImpl()

void FRendererModule::UnregisterCustomCullingImpl ( ICustomCulling *  impl)
overridevirtual

Implements IRendererModule.

◆ UpdateMapNeedsLightingFullyRebuiltState()

void FRendererModule::UpdateMapNeedsLightingFullyRebuiltState ( UWorld *  World)
overridevirtual

Implements IRendererModule.

◆ UpdateStaticDrawLists()

void FRendererModule::UpdateStaticDrawLists ( )
overridevirtual

Updates all static draw lists for each allocated scene.

Implements IRendererModule.

◆ UpdateStaticDrawListsForMaterials()

void FRendererModule::UpdateStaticDrawListsForMaterials ( const TArray< const FMaterial * > &  Materials)
overridevirtual

Updates static draw lists for the given set of materials for each allocated scene.

Implements IRendererModule.

The documentation for this class was generated from the following files: