Navigation
API > API/Runtime > API/Runtime/Engine
A game side builder interface that collects scene renderers to process as one workload.
| Name | ISceneRenderBuilder |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/SceneRenderBuilderInterface.h |
| Include Path | #include "SceneRenderBuilderInterface.h" |
Syntax
class ISceneRenderBuilder
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISceneRenderBuilder() |
SceneRenderBuilderInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddCommand
(
TUniqueFunction< void()>&& Function |
Adds a command that executes on the game thread and is pipelined with scene render commands on the render thread. | SceneRenderBuilderInterface.h | |
void AddRenderCommand
(
TUniqueFunction< void(FRHICommandListImmediate&)>&& Function |
Utility method that enqueues a render command that is interleaved with scene render commands. | SceneRenderBuilderInterface.h | |
void AddRenderer
(
FSceneRenderer* Renderer, |
SceneRenderBuilderInterface.h | ||
void AddRenderer
(
FSceneRenderer* Renderer, |
Adds a command to render a scene renderer on the render thread using RDG. | SceneRenderBuilderInterface.h | |
TArray< FSceneRenderer *, FConcurrentLinearArrayAllocator > CreateLinkedSceneRenderers
(
TConstArrayView< FSceneViewFamily* > ViewFamilies, |
Creates a linked set of scene renderers with related view families based on the current feature level. | SceneRenderBuilderInterface.h | |
FSceneRenderer * CreateSceneRenderer
(
FSceneViewFamily* ViewFamily |
Creates a scene renderer based on the current feature level. | SceneRenderBuilderInterface.h | |
void Execute() |
Call to execute all enqueued commands on the render thread. Resets the builder back to empty. | SceneRenderBuilderInterface.h | |
FConcurrentLinearBulkObjectAllocator & GetAllocator() |
Returns a linear allocator for allocating objects that can be used safely in command functions. | SceneRenderBuilderInterface.h | |
bool IsCompatible
(
const FEngineShowFlags& EngineShowFlags |
Whether a renderer with the provided show flags can be added to the builder. | SceneRenderBuilderInterface.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TUniquePtr< ISceneRenderBuilder > Create
(
FSceneInterface* SceneInterface |
Creates an instance of a scene render builder using a specified scene. | SceneRenderBuilderInterface.h |