Navigation
API > API/Runtime > API/Runtime/RenderCore
The public interface of the renderer module.
| Name | IRendererModule |
| Type | class |
| Header File | /Engine/Source/Runtime/RenderCore/Public/RendererInterface.h |
| Include Path | #include "RendererInterface.h" |
Syntax
class IRendererModule : public IModuleInterface
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnResolvedSceneColor | TMulticastDelegate_TwoParams< void, FRDGBuilder &, const FSceneTextures & > | Delegate that is called upon resolving scene color. | RendererInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddMeshBatchToGPUScene
(
FGPUScenePrimitiveCollector* Collector, |
RendererInterface.h | ||
void AddVirtualTextureProducerDestroyedCallback
(
const FVirtualTextureProducerHandle& Handle, |
RendererInterface.h | ||
IAdaptiveVirtualTexture * AllocateAdaptiveVirtualTexture
(
FRHICommandListBase& RHICmdList, |
RendererInterface.h | ||
IAdaptiveVirtualTexture * AllocateAdaptiveVirtualTexture
(
const FAdaptiveVTDescription& AdaptiveVTDesc, |
RendererInterface.h | ||
FSceneInterface * AllocateScene
(
UWorld* World, |
Allocates a new instance of the private FScene implementation for the given world. | RendererInterface.h | |
FSceneViewStateInterface * AllocateViewState
(
ERHIFeatureLevel::Type FeatureLevel, |
RendererInterface.h | ||
FSceneViewStateInterface * AllocateViewState
(
ERHIFeatureLevel::Type FeatureLevel |
Allocates a new instance of the private scene manager implementation of FSceneViewStateInterface | RendererInterface.h | |
IAllocatedVirtualTexture * AllocateVirtualTexture
(
const FAllocatedVTDescription& Desc |
RendererInterface.h | ||
IAllocatedVirtualTexture * AllocateVirtualTexture
(
FRHICommandListBase& RHICmdList, |
RendererInterface.h | ||
void BeginRenderingViewFamilies
(
FCanvas* Canvas, |
Experimental: Render multiple view families in a single scene render call. | RendererInterface.h | |
void BeginRenderingViewFamily
(
FCanvas* Canvas, |
Call from the game thread to send a message to the rendering thread to being rendering this view family. | RendererInterface.h | |
IScenePrimitiveRenderingContext * BeginScenePrimitiveRendering
(
FRDGBuilder& GraphBuilder, |
RendererInterface.h | ||
IScenePrimitiveRenderingContext * BeginScenePrimitiveRendering
(
FRDGBuilder& GraphBuilder, |
Prepare Scene primitive rendering and return context. | RendererInterface.h | |
void CreateAndInitSingleView
(
FRHICommandListImmediate& RHICmdList, |
Call from the render thread to create and initalize a new FViewInfo with the specified options, and add it to the specified view family. | RendererInterface.h | |
TUniquePtr< ISceneRenderBuilder > CreateSceneRenderBuilder
(
FSceneInterface* Scene |
RendererInterface.h | ||
FSceneUniformBuffer * CreateSinglePrimitiveSceneUniformBuffer
(
FRDGBuilder& GraphBuilder, |
RendererInterface.h | ||
FSceneUniformBuffer * CreateSinglePrimitiveSceneUniformBuffer
(
FRDGBuilder& GraphBuilder, |
Create a Scene Uniform Buffer containing only the scene representation for a single primitive | RendererInterface.h | |
TRDGUniformBufferRef< FBatchedPrimitiveParameters > CreateSinglePrimitiveUniformView
(
FRDGBuilder& GraphBuilder, |
RendererInterface.h | ||
TRDGUniformBufferRef< FBatchedPrimitiveParameters > CreateSinglePrimitiveUniformView
(
FRDGBuilder& GraphBuilder, |
Create a Uniform Buffer containing representation for a single primitive. | RendererInterface.h | |
void DebugLogOnCrash() |
Renderer gets a chance to log some useful crash data | RendererInterface.h | |
void DestroyAdaptiveVirtualTexture
(
IAdaptiveVirtualTexture* AdaptiveVT |
RendererInterface.h | ||
void DestroyVirtualTexture
(
IAllocatedVirtualTexture* AllocatedVT |
RendererInterface.h | ||
void DrawRectangle
(
FRHICommandList& RHICmdList, |
Draws a quad with the given vertex positions and UVs in denormalized pixel/texel coordinates. | RendererInterface.h | |
void DrawTileMesh
(
FCanvasRenderContext& RenderContext, |
Draws a tile mesh element with the specified view. | RendererInterface.h | |
void ExecVisualizeTextureCmd
(
const FString& Cmd |
RendererInterface.h | ||
IVirtualTexture * FindProducer
(
const FVirtualTextureProducerHandle& Handle |
RendererInterface.h | ||
void FlushVirtualTextureCache () |
Evict all data from virtual texture caches. | RendererInterface.h | |
void FlushVirtualTextureCache
(
IAllocatedVirtualTexture* AllocatedVT, |
Evict all data from virtual texture cache for a given allocated virtual texture. | RendererInterface.h | |
const TSet< FSceneInterface * > & GetAllocatedScenes() |
RendererInterface.h | ||
const FGlobalDistanceFieldParameterData * GetGlobalDistanceFieldParameterData
(
const FSceneView& View |
RendererInterface.h | ||
IMaterialCacheTagProvider * GetMaterialCacheTagProvider() |
Get the shared tag provider, always valid | RendererInterface.h | |
uint64 GetNaniteRequestRecordBuffer
(
TArray< uint32 >& OutRequestData |
Fetch the page requests recorded since the last call to SetNaniteRequestRecordBuffer. | RendererInterface.h | |
uint32 GetNumDynamicLightsAffectingPrimitive
(
const FPrimitiveSceneInfo* PrimitiveSceneInfo, |
RendererInterface.h | ||
const FViewMatrices & GetPreviousViewMatrices
(
const FSceneView& View |
RendererInterface.h | ||
FOnResolvedSceneColor & GetResolvedSceneColorCallbacks() |
Accessor for post scene color resolve delegates | RendererInterface.h | |
uint64 GetVirtualTextureRequestRecordBuffer
(
TSet< uint64 >& OutPageRequests |
Fetch the virtual texture page requests recorded since the last call to SetVirtualTextureRequestRecordBuffer. | RendererInterface.h | |
void GPUBenchmark
(
FSynthBenchmarkResults& InOut, |
RendererInterface.h | ||
void InitializeSystemTextures
(
FRHICommandListImmediate& RHICmdList |
RendererInterface.h | ||
void InvalidatePathTracedOutput
(
PathTracing::EInvalidateReason InvalidateReason |
Mark all the current scenes as needing to restart path tracer accumulation | RendererInterface.h | |
void LoadPendingVirtualTextureTiles
(
FRHICommandListImmediate& RHICmdList, |
Ensure that any tiles requested by 'RequestVirtualTextureTiles' are loaded, must be called from render thread | RendererInterface.h | |
void LockVirtualTextureTiles
(
FVirtualTextureProducerHandle ProducerHandle, |
Lock all tiles associated with a producer up to and including a given mip level. | RendererInterface.h | |
void OnWorldCleanup
(
UWorld* World, |
RendererInterface.h | ||
void PerFrameCleanupIfSkipRenderer () |
Performs necessary per-frame cleanup. | RendererInterface.h | |
void PostRenderAllViewports() |
RendererInterface.h | ||
void PrefetchNaniteResource
(
const Nanite::FResources* Resource, |
Start prefetching streaming data for Nanite resource that will soon be used for rendering. | RendererInterface.h | |
void RegisterCustomCullingImpl
(
ICustomCulling* impl |
Register/unregister a custom occlusion culling implementation | RendererInterface.h | |
FDelegateHandle RegisterOverlayRenderDelegate
(
const FPostOpaqueRenderDelegate& OverlayRenderDelegate |
RendererInterface.h | ||
void RegisterPersistentViewUniformBufferExtension
(
IPersistentViewUniformBufferExtension* Extension |
RendererInterface.h | ||
FDelegateHandle RegisterPostOpaqueRenderDelegate
(
const FPostOpaqueRenderDelegate& PostOpaqueRenderDelegate |
RendererInterface.h | ||
FVirtualTextureProducerHandle RegisterVirtualTextureProducer
(
FRHICommandListBase& RHICmdList, |
RendererInterface.h | ||
FVirtualTextureProducerHandle RegisterVirtualTextureProducer
(
const FVTProducerDescription& Desc, |
RendererInterface.h | ||
void ReleaseVirtualTexturePendingResources() |
RendererInterface.h | ||
void ReleaseVirtualTextureProducer
(
const FVirtualTextureProducerHandle& Handle |
RendererInterface.h | ||
uint32 RemoveAllVirtualTextureProducerDestroyedCallbacks
(
const void* Baton |
RendererInterface.h | ||
void RemoveOverlayRenderDelegate
(
FDelegateHandle OverlayRenderDelegate |
RendererInterface.h | ||
void RemovePostOpaqueRenderDelegate
(
FDelegateHandle PostOpaqueRenderDelegate |
RendererInterface.h | ||
void RemoveScene
(
FSceneInterface* Scene |
RendererInterface.h | ||
void RequestNanitePages
(
TArrayView< uint32 > InRequestData |
Request Nanite pages that were captured with SetNaniteRequestRecordBuffer. | RendererInterface.h | |
void RequestStaticMeshUpdate
(
FPrimitiveSceneInfo* Info |
RendererInterface.h | ||
void RequestVirtualTextureTiles
(
const FVector2D& InScreenSpaceSize, |
RendererInterface.h | ||
void RequestVirtualTextureTiles
(
TArray< uint64 >&& InPageRequests |
Request an array of virtual texture page requests that was captured with SetVirtualTextureRequestRecordBuffer. | RendererInterface.h | |
void RequestVirtualTextureTiles
(
const FMaterialRenderProxy* InMaterialRenderProxy, |
RendererInterface.h | ||
void RequestVirtualTextureTiles
(
IAllocatedVirtualTexture* AllocatedVT, |
Helper function to request loading of tiles for a virtual texture that will be displayed in the UI. | RendererInterface.h | |
void ResetSceneTextureExtentHistory () |
Resets the scene texture extent history. | RendererInterface.h | |
void SetNaniteRequestRecordBuffer
(
uint64 Handle |
Allocate a buffer and record all nanite page requests until the next call to either SetNaniteRequestRecordBuffer or GetNaniteRequestRecordBuffer. | RendererInterface.h | |
void SetVirtualTextureRequestRecordBuffer
(
uint64 Handle |
Allocate a buffer and record all virtual texture page requests until the next call to either SetVirtualTextureRequestRecordBuffer or GetVirtualTextureRequestRecordBuffer. | RendererInterface.h | |
void SyncVirtualTextureUpdates
(
FRHICommandListImmediate& RHICmdList, |
Do a full virtual texture system update to read and process feedback. | RendererInterface.h | |
void UnregisterCustomCullingImpl
(
ICustomCulling* impl |
RendererInterface.h | ||
void UpdateMapNeedsLightingFullyRebuiltState
(
UWorld* World |
RendererInterface.h | ||
void UpdateStaticDrawLists() |
Updates all static draw lists for each allocated scene. | RendererInterface.h | |
void UpdateStaticDrawListsForMaterials
(
const TArray< const FMaterial* >& Materials |
Updates static draw lists for the given set of materials for each allocated scene. | RendererInterface.h |