Struct RenderContextBatch

The high-level renderer context batch that encapsulates multiple rendering requests within a single task (eg. optimize main view scene rendering and shadow projections at once).

Assembly: FlaxEngine.dll

File: Engine/Graphics/RenderTask.h

Syntax

public struct RenderContextBatch

Constructors

RenderContextBatch()

Declaration

public RenderContextBatch() = default

RenderContextBatch(const RenderContext& context)

Declaration

public RenderContextBatch(const RenderContext& context)

Parameters

RenderContext context

RenderContextBatch(SceneRenderTask* task)

Declaration

public RenderContextBatch(SceneRenderTask* task)

Parameters

SceneRenderTask task

Fields

Buffers

The render buffers.

Declaration

public RenderBuffers* Buffers = nullptr

Field Value

RenderBuffers

Contexts

The all render views collection for the current rendering (main view, shadow projections, etc.).

Declaration

public Array<RenderContext, RendererAllocation> Contexts

Field Value

Array<RenderContext, RendererAllocation>

EnableAsync

Enables using async tasks via Job System when performing drawing.

Declaration

public bool EnableAsync = true

Field Value

bool

Task

The scene rendering task that is a source of renderable objects (optional).

Declaration

public SceneRenderTask* Task = nullptr

Field Value

SceneRenderTask

WaitLabels

The Job System labels to wait on, after draw calls collecting.

Declaration

public Array<uint64, InlinedAllocation<8>> WaitLabels

Field Value

Array<uint64, InlinedAllocation<8>>

Methods

GetMainContext()

Declaration

public RenderContext GetMainContext()

Returns

RenderContext