Navigation
API > API/Plugins > API/Plugins/RenderGrid
The singleton class that manages render grids.
This functionality is separated from the UI in order to make it is reusable, meaning that it can also be used in other modules.
| Name | FRenderGridManager |
| Type | class |
| Header File | /Engine/Plugins/Experimental/RenderGrid/Source/RenderGrid/Public/RenderGrid/RenderGridManager.h |
| Include Path | #include "RenderGrid/RenderGridManager.h" |
Syntax
class FRenderGridManager
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| GeneratedIdCharacterLength | int32 | The number of characters for a generated ID. | RenderGrid/RenderGridManager.h |
| TmpRenderedFramesPath | FString | A folder in which rendered frames for temporary use will be placed in. | RenderGrid/RenderGridManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| StartFrameOfRenders | TMap< FGuid, int32 > | The map that stores the start frame (of a render) of each rendered render grid job. | RenderGrid/RenderGridManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRenderGridManagerPreviousPropValues ApplyJobPropValues
(
const URenderGrid* Grid, |
Applies the props of the given render grid job, also requires the render grid to be given as well (to know what props the render grid job is using). | RenderGrid/RenderGridManager.h | |
URenderGridQueue * CreateBatchRenderQueue
(
URenderGrid* Grid, |
Batch render the given render grid job(s) of the given render grid. | RenderGrid/RenderGridManager.h | |
URenderGridQueue * CreateBatchRenderQueueSingleFrame
(
URenderGrid* Grid, |
Batch render the given render grid job(s) of the given render grid. | RenderGrid/RenderGridManager.h | |
URenderGridQueue * CreateBatchRenderQueueSingleFramePosition
(
URenderGrid* Grid, |
Batch render the given render grid job(s) of the given render grid. | RenderGrid/RenderGridManager.h | |
UTexture2D * GetRenderedPreviewFrame
(
URenderGridJob* Job, |
Gets the rendered preview frame of the given frame number (of a rendering in which the frame number was not specified). | RenderGrid/RenderGridManager.h | |
UTexture2D * GetRenderedPreviewFrame
(
URenderGridJob* Job, |
Gets the rendered preview frame of the given frame number (of a rendering in which the frame number was not specified). | RenderGrid/RenderGridManager.h | |
| Gets the rendered preview frame (of a rendering in which the frame number was specified). | RenderGrid/RenderGridManager.h | ||
UTexture2D * GetSingleRenderedPreviewFrame
(
URenderGridJob* Job, |
Gets the rendered preview frame (of a rendering in which the frame number was specified). | RenderGrid/RenderGridManager.h | |
URenderGridQueue * RenderPreviewFrame
(
const FRenderGridManagerRenderPreviewFrameArgs& Args |
Render a preview frame (or multiple if no frame number is specified) of the given render grid job. | RenderGrid/RenderGridManager.h | |
void RestorePropValues
(
const FRenderGridManagerPreviousPropValues& PreviousPropValues |
Restores the props that were previously applied, to the values that they were before. | RenderGrid/RenderGridManager.h | |
void UpdateStoredRenderGridJobsPropValues
(
URenderGrid* Grid |
Makes sure that all the data from the current props source is stored in all of the render grid jobs of this render grid. | RenderGrid/RenderGridManager.h |