Navigation
API > API/Plugins > API/Plugins/DisplayClusterScenePreview > API/Plugins/DisplayClusterScenePreview/IDisplayClusterScenePreview
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool RenderQueued
(
int32 RendererId, |
Queue a preview to be rendered in the future, automatically creating a canvas and render target. | IDisplayClusterScenePreview.h | |
bool RenderQueued
(
int32 RendererId, |
Queue a preview to be rendered in the future using an existing canvas. | IDisplayClusterScenePreview.h |
RenderQueued(int32, FDisplayClusterMeshProjectionRenderSettings &, const FIntPoint &, FRenderResultDelegate)
Description
Queue a preview to be rendered in the future, automatically creating a canvas and render target.
| Name | RenderQueued |
| Type | function |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterScenePreview/Public/IDisplayClusterScenePreview.h |
| Include Path | #include "IDisplayClusterScenePreview.h" |
bool RenderQueued
(
int32 RendererId,
FDisplayClusterMeshProjectionRenderSettings & RenderSettings,
const FIntPoint & Size,
FRenderResultDelegate ResultDelegate
)
Parameters
| Name | Remarks |
|---|---|
| RendererId | The ID of the renderer as returned from CreateRenderer. |
| RenderSettings | Settings controlling how the scene will be rendered. |
| Size | The size of the image to produce. Note that whenever this changes for a given renderer, the underlying RenderTarget will be resized, which has a performance cost. |
| ResultDelegate | The delegate to call when the render is complete. It will be passed a FRenderTarget containing the rendered preview, or null if the render failed. |
RenderQueued(int32, FDisplayClusterMeshProjectionRenderSettings &, TWeakPtr< FCanvas >, FRenderResultDelegate)
Description
Queue a preview to be rendered in the future using an existing canvas. The canvas must have a valid render target assigned.
| Name | RenderQueued |
| Type | function |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterScenePreview/Public/IDisplayClusterScenePreview.h |
| Include Path | #include "IDisplayClusterScenePreview.h" |
bool RenderQueued
(
int32 RendererId,
FDisplayClusterMeshProjectionRenderSettings & RenderSettings,
TWeakPtr < FCanvas > Canvas,
FRenderResultDelegate ResultDelegate
)
Parameters
| Name | Remarks |
|---|---|
| RendererId | The ID of the renderer as returned from CreateRenderer. |
| RenderSettings | Settings controlling how the scene will be rendered. |
| Canvas | The canvas to draw to. If this is invalid when the render is ready to start, the render will be skipped. |
| ResultDelegate | The delegate to call when the render is complete. It will be passed a FRenderTarget containing the rendered preview, or null if the render failed. |