Class Renderer

High-level rendering service.

Inheritance

System.Object

Renderer

Namespace: FlaxEngine

Assembly: FlaxEngine.CSharp.dll

Syntax

[Unmanaged]
public static class Renderer : Object

Methods

DrawActors(ref RenderContext, Actor[])

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

Declaration

[Unmanaged]
public static void DrawActors(ref RenderContext renderContext, Actor[] customActors = null)

Parameters

RenderContext renderContext The rendering context.

Actor[] customActors The custom set of actors to render. If empty, the loaded scenes will be rendered.

DrawActors(ref RenderContext, List<Actor>)

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

Declaration

[Unmanaged]
public static void DrawActors(ref RenderContext renderContext, List<Actor> customActors)

Parameters

RenderContext renderContext The rendering context.

System.Collections.Generic.List<Actor> customActors The custom set of actors to render. If empty, the loaded scenes will be rendered.

DrawPostFxMaterial(GPUContext, ref RenderContext, MaterialBase, GPUTexture, GPUTextureView)

Draws postFx material to the render target.

Declaration

[Unmanaged]
public static void DrawPostFxMaterial(GPUContext context, ref 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, SceneRenderTask, GPUTexture, Actor[])

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

Declaration

[Unmanaged]
public static void DrawSceneDepth(GPUContext context, SceneRenderTask task, GPUTexture output, Actor[] 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.

Actor[] customActors The custom set of actors to render. If empty, the loaded scenes will be rendered.

DrawSceneDepth(GPUContext, SceneRenderTask, GPUTexture, List<Actor>)

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

Declaration

[Unmanaged]
public static void DrawSceneDepth(GPUContext context, SceneRenderTask task, GPUTexture output, List<Actor> 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.

System.Collections.Generic.List<Actor> customActors The custom set of actors to render. If empty, the loaded scenes will be rendered.

Render(SceneRenderTask)

Performs rendering for the input task.

Declaration

[Unmanaged]
public static void Render(SceneRenderTask task)

Parameters

SceneRenderTask task The scene rendering task.