IRendererModule

The public interface of the renderer module.

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

IRendererModule

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

Name Description

Public function

void

 

AddVirtualTextureProducerDestroyedCallback

(
    const FVirtualTextureProducerHandle ...,
    FVTProducerDestroyedFunction * ...,
    void * Baton
)

Public function

FSceneInterf ...

 

AllocateScene

(
    UWorld * World,
    bool bInRequiresHitProxies,
    bool bCreateFXSystem,
    ERHIFeatureLevel::Type InFeatureLev...
)

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

Public function

FSceneViewSt ...

 

AllocateViewState()

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

Public function

IAllocatedVi ...

 

AllocateVirtualTexture

(
    const FAllocatedVTDescription & Des...
)

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

void

 

CreateAndInitSingleView

(
    FRHICommandListImmediate & RHICmdLi...,
    FSceneViewFamily * ViewFamily,
    const FSceneViewInitOptions * V...
)

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

void

 

DebugLogOnCrash()

Renderer gets a chance to log some useful crash data

Public function

void

 

DestroyVirtualTexture

(
    IAllocatedVirtualTexture * Allo...
)

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 , FSha ...,
    EDrawRectangleFlags Flags
)

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

Public function

void

 

DrawTileMesh

(
    FRHICommandListImmediate & RHICmdLi...,
    FMeshPassProcessorRenderState & Dra...,
    const FSceneView & View,
    FMeshBatch & Mesh,
    bool bIsHitTesting,
    const FHitProxyId & HitProxyId,
    bool bUse128bitRT
)

Draws a tile mesh element with the specified view.

Public function

void

 

ExecVisualizeTextureCmd

(
    const FString & Cmd
)

Public function

void

 

FlushVirtualTextureCache()

Evict all data from virtual texture caches

Public function

const TSet < ...

 

GetAllocatedScenes()

Public function

uint32

 

GetNumDynamicLightsAffectingPrimitive

(
    const FPrimitiveSceneInfo * Pri...,
    const FLightCacheInterface * LC...
)

Public function

FOnResolvedS ...

 

GetResolvedSceneColorCallbacks()

Accessor for post scene color resolve delegates

Public function

void

 

GPUBenchmark

(
    FSynthBenchmarkResults & InOut,
    float WorkScale
)

Public function Const

bool

 

HasPostOpaqueExtentions()

Public function

void

 

InitializeSystemTextures

(
    FRHICommandListImmediate & RHICmdLi...
)

Public function

void

 

LoadPendingVirtualTextureTiles

(
    FRHICommandListImmediate & RHICmdLi...,
    ERHIFeatureLevel::Type FeatureLevel
)

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

Public function

void

 

OnWorldCleanup

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

Public function

void

 

PerFrameCleanupIfSkipRenderer()

Performs necessary per-frame cleanup.

Public function

void

 

PostRenderAllViewports()

Public function

void

 

ReallocateSceneRenderTargets()

Forces reallocation of scene render targets.

Public function

void

 

RegisterCustomCullingImpl

(
    ICustomCulling * impl
)

Register/unregister a custom occlusion culling implementation

Public function

void

 

RegisterOverlayRenderDelegate

(
    const FPostOpaqueRenderDelegate & O...
)

Public function

void

 

RegisterPersistentViewUniformBufferExtension

Public function

void

 

RegisterPostOpaqueRenderDelegate

(
    const FPostOpaqueRenderDelegate & P...
)

Public function

FVirtualText ...

 

RegisterVirtualTextureProducer

(
    const FVTProducerDescription & Desc,
    IVirtualTexture * Producer
)

Public function

void

 

ReleaseVirtualTextureProducer

(
    const FVirtualTextureProducerHandle ...
)

Public function

uint32

 

RemoveAllVirtualTextureProducerDestroyedCallbacks

(
    const void * Baton
)

Public function

void

 

RemoveScene

(
    FSceneInterface * Scene
)

Public function

void

 

RenderOverlayExtensions

(
    const FViewInfo& View,
    FRHICommandListImmediate & RHICmdLi...,
    FSceneRenderTargets& SceneContext
)

Public function

void

 

RenderPostOpaqueExtensions

(
    const FViewInfo& View,
    FRHICommandListImmediate & RHICmdLi...,
    FSceneRenderTargets& SceneContext,
    TUniformBufferRef < FSceneTexturesUn ...
)

Public function

void

 

RenderPostResolvedSceneColorExtension

(
    FRHICommandListImmediate & RHICmdLi...,
    FSceneRenderTargets& SceneContext
)

Calls registered post resolve delegates, if any

Public function

void

 

RequestVirtualTextureTiles

(
    const FVector2D & InScreenSpaceSize,
    int32 InMipLevel
)

Provided a list of packed virtual texture tile ids, let the VT system request them.

Public function

void

 

RequestVirtualTextureTilesForRegion

(
    IAllocatedVirtualTexture * Allo...,
    const FVector2D & InScreenSpaceSize,
    const FIntRect & InTextureRegion,
    int32 InMipLevel
)

Public function

void

 

SceneRenderTargetsSetBufferSize

(
    uint32 SizeX,
    uint32 SizeY
)

Sets the buffer size of the render targets.

Public function

void

 

UnregisterCustomCullingImpl

(
    ICustomCulling * impl
)

Public function

void

 

UpdateMapNeedsLightingFullyRebuiltState

(
    UWorld * World
)

Public function

void

 

UpdateStaticDrawLists()

Updates all static draw lists for each allocated scene.

Public function

void

 

UpdateStaticDrawListsForMaterials

(
    const TArray < const FMaterial *...
)

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.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback