1. Epic GamesDeveloper
  3. IRendererModule

IRendererModule

The public interface of the renderer module.

API > API/Runtime > API/Runtime/RenderCore

Inheritance Hierarchy

References

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

Syntax

class IRendererModule : public IModuleInterface

Remarks

The public interface of the renderer module.

Functions

  Type Name Description
Public function void

AddMeshBatchToGPUScene ( FGPUScenePrimitiveCollector* Collector,
FMeshBatch& MeshBatch
)

  
Public function void  
Public function IAdaptiveVirtualTexture *

AllocateAdaptiveVirtualTexture ( FRHICommandListBase& RHICmdList,
const FAdaptiveVTDescription& AdaptiveVTDesc,
const FAllocatedVTDescription& AllocatedVTDesc
)

  
Public function IAdaptiveVirtualTexture *

AllocateAdaptiveVirtualTexture ( const FAdaptiveVTDescription& AdaptiveVTDesc,
const FAllocatedVTDescription& AllocatedVTDesc
)

  
Public function FSceneInterface *

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

 Allocates a new instance of the private FScene implementation for the given world.
Public function FSceneViewStateInterface * Allocates a new instance of the private scene manager implementation of FSceneViewStateInterface
Public function FSceneViewStateInterface *

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

  
Public function IAllocatedVirtualTexture *  
Public function IAllocatedVirtualTexture *  
Public function void

BeginRenderingViewFamilies ( FCanvas* Canvas,
TArrayView< FSceneViewFamily* > ViewFamilies
)

 Experimental: Render multiple view families in a single scene render call.
Public function void

BeginRenderingViewFamily ( FCanvas* Canvas,
FSceneViewFamily* ViewFamily
)

 Call from the game thread to send a message to the rendering thread to being rendering this view family.
Public function IScenePrimitiveRenderingContext *

BeginScenePrimitiveRendering ( FRDGBuilder& GraphBuilder,
FSceneInterface& Scene
)

  
Public function IScenePrimitiveRenderingContext *

BeginScenePrimitiveRendering ( FRDGBuilder& GraphBuilder,
FSceneViewFamily* ViewFamily
)

 Prepare Scene primitive rendering and return context.
Public function void

CreateAndInitSingleView ( FRHICommandListImmediate& RHICmdList,
FSceneViewFamily* ViewFamily,
const FSceneViewInitOptions* ViewInitOptions
)

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

CreateSinglePrimitiveSceneUniformBuffer ( FRDGBuilder& GraphBuilder,
const FViewInfo& SceneView,
FMeshBatch& Mesh
)

 Create a Scene Uniform Buffer containing only the scene representation for a single primitive
Public function TRDGUniformBufferRef< FBatchedPrimitiveParameters >

CreateSinglePrimitiveUniformView ( FRDGBuilder& GraphBuilder,
const FViewInfo& SceneView,
FMeshBatch& Mesh
)

 Create a Uniform Buffer containing representation for a single primitive.
Public function void Renderer gets a chance to log some useful crash data
Public function void  
Public function void  
Public function 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
)

 Draws a quad with the given vertex positions and UVs in denormalized pixel/texel coordinates.
Public function void

DrawTileMesh ( FCanvasRenderContext& RenderContext,
FMeshPassProcessorRenderState& DrawRenderState,
const FSceneView& View,
FMeshBatch& Mesh,
bool bIsHitTesting,
const FHitProxyId& HitProxyId,
bool bUse128bitRT
)

 Draws a tile mesh element with the specified view.
Public function void  
Public function void

FlushVirtualTextureCache ( IAllocatedVirtualTexture* AllocatedVT,
const FVector2f& InUV0,
const FVector2f& InUV1
)

 Evict all data from virtual texture cache for a given allocated virtual texture.
Public function void Evict all data from virtual texture caches.
Public function const TSet< FSceneInterface * > &  
Public function const FGlobalDistanceFieldParameterData *

GetGlobalDistanceFieldParameterData ( const FSceneView& View
)

  
Public function uint64

GetNaniteRequestRecordBuffer ( TArray< uint32 >& OutRequestData
)

 Fetch the page requests recorded since the last call to SetNaniteRequestRecordBuffer.
Public function uint32

GetNumDynamicLightsAffectingPrimitive ( const FPrimitiveSceneInfo* PrimitiveSceneInfo,
const FLightCacheInterface* LCI
)

  
Public function const FViewMatrices &

GetPreviousViewMatrices ( const FSceneView& View
)

  
Public function FOnResolvedSceneColor & Accessor for post scene color resolve delegates
Public function uint64 Fetch the virtual texture page requests recorded since the last call to SetVirtualTextureRequestRecordBuffer.
Public function void

GPUBenchmark ( FSynthBenchmarkResults& InOut,
float WorkScale
)

  
Public function void  
Public function void Mark all the current scenes as needing to restart path tracer accumulation
Public function void Ensure that any tiles requested by 'RequestVirtualTextureTiles' are loaded, must be called from render thread
Public function void

OnWorldCleanup ( UWorld* World,
bool bSessionEnded,
bool bCleanupResources,
bool bWorldChanged
)

  
Public function void Performs necessary per-frame cleanup.
Public function void  
Public function void

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

 Start prefetching streaming data for Nanite resource that will soon be used for rendering.
Public function void Register/unregister a custom occlusion culling implementation
Public function FDelegateHandle

RegisterOverlayRenderDelegate ( const FPostOpaqueRenderDelegate& OverlayRenderDelegate
)

  
Public function void  
Public function FDelegateHandle

RegisterPostOpaqueRenderDelegate ( const FPostOpaqueRenderDelegate& PostOpaqueRenderDelegate
)

  
Public function FVirtualTextureProducerHandle  
Public function FVirtualTextureProducerHandle  
Public function void  
Public function void  
Public function uint32  
Public function void

RemoveOverlayRenderDelegate ( FDelegateHandle OverlayRenderDelegate
)

  
Public function void

RemovePostOpaqueRenderDelegate ( FDelegateHandle PostOpaqueRenderDelegate
)

  
Public function void

RemoveScene ( FSceneInterface* Scene
)

  
Public function void

RequestNanitePages ( TArrayView< uint32 > InRequestData
)

 Request Nanite pages that were captured with SetNaniteRequestRecordBuffer.
Public function void

RequestStaticMeshUpdate ( FPrimitiveSceneInfo* Info
)

  
Public function void

RequestVirtualTextureTiles ( const FVector2D& InScreenSpaceSize,
int32 InMipLevel
)

  
Public function void

RequestVirtualTextureTiles ( TArray< uint64 >&& InPageRequests
)

 Request an array of virtual texture page requests that was captured with SetVirtualTextureRequestRecordBuffer.
Public function void

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

  
Public function void

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

 Helper function to request loading of tiles for a virtual texture that will be displayed in the UI.
Public function void

RequestVirtualTextureTilesForRegion ( IAllocatedVirtualTexture* AllocatedVT,
const FVector2D& InScreenSpaceSize,
const FVector2D& InViewportPosition,
const FVector2D& InViewportSize,
const FVector2D& InUV0,
const FVector2D& InUV1,
int32 InMipLevel
)

  
Public function void Resets the scene texture extent history.
Public function void Allocate a buffer and record all nanite page requests until the next call to either SetNaniteRequestRecordBuffer or GetNaniteRequestRecordBuffer.
Public function void Allocate a buffer and record all virtual texture page requests until the next call to either SetVirtualTextureRequestRecordBuffer or GetVirtualTextureRequestRecordBuffer.
Public function void  
Public function void  
Public function void Updates all static draw lists for each allocated scene.
Public function void

UpdateStaticDrawListsForMaterials ( const TArray< const FMaterial* >& Materials
)

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

Typedefs

Name Description
FOnResolvedSceneColor Delegate that is called upon resolving scene color.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page