Navigation
API > API/Plugins > API/Plugins/DisplayCluster
DisplayCluster callbacks API
| Name | IDisplayClusterCallbacks |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/IDisplayClusterCallbacks.h |
| Include Path | #include "IDisplayClusterCallbacks.h" |
Syntax
class IDisplayClusterCallbacks
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDisplayClusterCallbacks() |
IDisplayClusterCallbacks.h |
Classes
| Name | Remarks |
|---|---|
| FDisplayClusterCustomPresentSetEvent | Callback triggered when custom present handler was created |
| FDisplayClusterEndFrameEvent | Called on DisplayCluster EndFrame |
| FDisplayClusterEndSceneEvent | Called on end scene |
| FDisplayClusterEndSessionEvent | Called on session end |
| FDisplayClusterFailoverNodeDown | Notifies about cluster node failure. Called from AnyThread. |
| FDisplayClusterFailoverPrimaryNodeChanged | Notifies about new primary node. Called from AnyThread. |
| FDisplayClusterFramePresentated_RHIThread | Called after frame presentation |
| FDisplayClusterPassthroughMediaCapture_RenderThread | Called to process passthrough media capture |
| FDisplayClusterPassthroughMediaInput_RenderThread | Called to process passthrough media input |
| FDisplayClusterPostBackbufferUpdate_RenderThread | (deprecated) Called after backbuffer update |
| FDisplayClusterPostBackbufferUpdated_RenderThread | Called after backbuffer update |
| FDisplayClusterPostCrossGpuTransfer_RenderThread | Called after inter-GPU synchronization |
| FDisplayClusterPostFrameRender_RenderThread | Called in the end of the nD rendering chain, right before updating the backbuffer |
| FDisplayClusterPostRenderViewFamily_RenderThread | Called once the ViewFamily of this viewport is rendered |
| FDisplayClusterPostResolveOverridden_RenderThread | Called for every viewport that has configured content override |
| FDisplayClusterPostTickEvent | Called on DisplayCluster PostTick |
| FDisplayClusterPostTonemapPass_RenderThread | Called after tonemap pass (before applying OCIO transformation) |
| FDisplayClusterPostWarp_RenderThread | Called once after warping all the viewports |
| FDisplayClusterPostWarpViewport_RenderThread | Called after warping a specific viewport |
| FDisplayClusterPreProcessIcvfx_RenderThread | Called before applying ICVFX shaders |
| FDisplayClusterPresentationPostSynchronization_RHIThread | Called after presentation synchronization is completed |
| FDisplayClusterPresentationPreSynchronization_RHIThread | Called before presentation synchronization is initiated |
| FDisplayClusterPreSubmitViewFamilies | Callback triggered before submitting view families to render |
| FDisplayClusterPreTickEvent | Called on DisplayCluster PreTick |
| FDisplayClusterPreWarp_RenderThread | Called once before warping all available viewports |
| FDisplayClusterPreWarpViewport_RenderThread | Called before warping a specific viewport |
| FDisplayClusterProcessLatency_RenderThread | Called to let the artificial latency subsystem do its job |
| FDisplayClusterStartFrameEvent | Called on DisplayCluster StartFrame |
| FDisplayClusterStartSceneEvent | Called on start scene |
| FDisplayClusterStartSessionEvent | Called on session start |
| FDisplayClusterTickEvent | Called on DisplayCluster Tick |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDisplayClusterUpdateViewportMediaState | TMulticastDelegate_TwoParams< void, IDisplayClusterViewport *, EDisplayClusterViewportMediaState & > | The viewport can be used by external media, which affects the internal logic of the viewport. | IDisplayClusterCallbacks.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDisplayClusterCustomPresentSetEvent & OnDisplayClusterCustomPresentSet() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterEndFrameEvent & OnDisplayClusterEndFrame() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterEndSceneEvent & OnDisplayClusterEndScene() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterEndSessionEvent & OnDisplayClusterEndSession() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterFailoverNodeDown & OnDisplayClusterFailoverNodeDown() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterFailoverPrimaryNodeChanged & OnDisplayClusterFailoverPrimaryNodeChanged() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterFramePresentated_RHIThread & OnDisplayClusterFramePresented_RHIThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPassthroughMediaCapture_RenderThread & OnDisplayClusterPassthroughMediaCapture_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPassthroughMediaInput_RenderThread & OnDisplayClusterPassthroughMediaInput_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostBackbufferUpdate_RenderThread & OnDisplayClusterPostBackbufferUpdate_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostBackbufferUpdated_RenderThread & OnDisplayClusterPostBackbufferUpdated_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostCrossGpuTransfer_RenderThread & OnDisplayClusterPostCrossGpuTransfer_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostFrameRender_RenderThread & OnDisplayClusterPostFrameRender_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostRenderViewFamily_RenderThread & OnDisplayClusterPostRenderViewFamily_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostResolveOverridden_RenderThread & OnDisplayClusterPostResolveOverridden_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostTickEvent & OnDisplayClusterPostTick() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostTonemapPass_RenderThread & OnDisplayClusterPostTonemapPass_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostWarp_RenderThread & OnDisplayClusterPostWarp_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPostWarpViewport_RenderThread & OnDisplayClusterPostWarpViewport_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPreProcessIcvfx_RenderThread & OnDisplayClusterPreProcessIcvfx_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPresentationPostSynchronization_RHIThread & OnDisplayClusterPresentationPostSynchronization_RHIThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPresentationPreSynchronization_RHIThread & OnDisplayClusterPresentationPreSynchronization_RHIThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPreSubmitViewFamilies & OnDisplayClusterPreSubmitViewFamilies() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPreTickEvent & OnDisplayClusterPreTick() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPreWarp_RenderThread & OnDisplayClusterPreWarp_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterPreWarpViewport_RenderThread & OnDisplayClusterPreWarpViewport_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterProcessLatency_RenderThread & OnDisplayClusterProcessLatency_RenderThread() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterStartFrameEvent & OnDisplayClusterStartFrame() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterStartSceneEvent & OnDisplayClusterStartScene() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterStartSessionEvent & OnDisplayClusterStartSession() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterTickEvent & OnDisplayClusterTick() |
IDisplayClusterCallbacks.h | ||
FDisplayClusterUpdateViewportMediaState & OnDisplayClusterUpdateViewportMediaState() |
IDisplayClusterCallbacks.h |