Class Renderer

High-level rendering service.

Inheritance

Renderer

Assembly: FlaxEngine.dll

File: Engine/Renderer/Renderer.h

Syntax

public class Renderer

Methods

DrawActors(RenderContext& renderContext, const Array<Actor* , HeapAllocation>& customActors)

Invoked drawing of the scene objects (collects draw calls into RenderList for a given RenderContext).

Declaration

public static void DrawActors(RenderContext& renderContext, const Array<Actor* , HeapAllocation>& customActors)

Parameters

RenderContext renderContext The rendering context.

Array<Actor , HeapAllocation> customActors The custom set of actors to render. If empty, the loaded scenes will be rendered.

DrawPostFxMaterial(GPUContext* context, const RenderContext& renderContext, MaterialBase* material, GPUTexture* output, GPUTextureView* input)

Draws postFx material to the render target.

Declaration

public static void DrawPostFxMaterial(GPUContext* context, const RenderContext& renderContext, MaterialBase* material, GPUTexture* output, GPUTextureView* input)

Parameters

GPUContext context The GPU commands context to use.

RenderContext renderContext The rendering context.

MaterialBase material The material to render. It must be a post fx material.

GPUTexture output The output texture. Must be valid and created.

GPUTextureView input The input texture. It's optional.

DrawSceneDepth(GPUContext* context, SceneRenderTask* task, GPUTexture* output, const Array<Actor* , HeapAllocation>& customActors)

Draws scene objects depth (to the output Z buffer). The output must be depth texture to write hardware depth to it.

Declaration

public static void DrawSceneDepth(GPUContext* context, SceneRenderTask* task, GPUTexture* output, const Array<Actor* , HeapAllocation>& customActors)

Parameters

GPUContext context The GPU commands context to use.

SceneRenderTask task Render task to use it's view description and the render buffers.

GPUTexture output The output texture. Must be valid and created.

Array<Actor , HeapAllocation> customActors The custom set of actors to render. If empty, the loaded scenes will be rendered.

IsReady()

Determines whether the scene rendering system is ready (all shaders are loaded and helper resources are ready).

Declaration

public static bool IsReady()

Returns

bool

Render(SceneRenderTask* task)

Performs rendering for the input task.

Declaration

public static void Render(SceneRenderTask* task)

Parameters

SceneRenderTask task The scene rendering task.