Class SceneRendering

Scene rendering helper subsystem that boosts the level rendering by providing efficient objects cache and culling implementation.

SceneRendering
SceneRendering
SceneRendering
SceneRendering
SceneRendering
SceneRendering
SceneRendering
Assembly: FlaxEngine.dll
File: Engine/Level/Scene/SceneRendering.h
Syntax
public class SceneRendering

Fields

Actors

Declaration
public Array<DrawActor> Actors[MAX]
Field Value
Array<DrawActor>

FreeActors

Declaration
public Array<int32> FreeActors[MAX]
Field Value
Array<int32>

Locker

Declaration
public ReadWriteLock Locker
Field Value
ReadWriteLock

PostFxProviders

Declaration
public Array<IPostFxSettingsProvider* > PostFxProviders
Field Value
Array<IPostFxSettingsProvider >

Methods

AddActor(Actor* a, int32& key)

Declaration
public void AddActor(Actor* a, int32& key)
Parameters
Actor a

int32 key

AddLightsDebug(T* obj)

Declaration
public void AddLightsDebug(T* obj)
Parameters
T obj

Returns
void

Type Parameters
class T

Method

AddPhysicsDebug(IPhysicsDebug* obj)

Declaration
public void AddPhysicsDebug(IPhysicsDebug* obj)
Parameters
IPhysicsDebug obj

Returns
void

AddPostFxProvider(IPostFxSettingsProvider* obj)

Declaration
public void AddPostFxProvider(IPostFxSettingsProvider* obj)
Parameters
IPostFxSettingsProvider obj

Returns
void

AddViewportIcon(Actor* obj)

Declaration
public void AddViewportIcon(Actor* obj)
Parameters
Actor obj

Returns
void

Clear()

Clears this instance data.

Declaration
public void Clear()

CollectPostFxVolumes(RenderContext& renderContext)

Collects the post fx volumes for the given rendering view.

Declaration
public void CollectPostFxVolumes(RenderContext& renderContext)
Parameters
RenderContext renderContext

The rendering context.

Draw(RenderContextBatch& renderContextBatch, DrawCategory category=SceneDraw)

Draws the scene. Performs the optimized actors culling and draw calls submission for the current render pass (defined by the render view).

Declaration
public void Draw(RenderContextBatch& renderContextBatch, DrawCategory category=SceneDraw)
Parameters
RenderContextBatch renderContextBatch

The rendering context batch.
DrawCategory category

The actors category to draw.

RemoveActor(Actor* a, int32& key)

Declaration
public void RemoveActor(Actor* a, int32& key)
Parameters
Actor a

int32 key

RemoveLightsDebug(T* obj)

Declaration
public void RemoveLightsDebug(T* obj)
Parameters
T obj

Type Parameters
class T

Method

RemovePhysicsDebug(IPhysicsDebug* obj)

Declaration
public void RemovePhysicsDebug(IPhysicsDebug* obj)
Parameters
IPhysicsDebug obj

Returns
void

RemovePostFxProvider(IPostFxSettingsProvider* obj)

Declaration
public void RemovePostFxProvider(IPostFxSettingsProvider* obj)
Parameters
IPostFxSettingsProvider obj

Returns
void

RemoveViewportIcon(Actor* obj)

Declaration
public void RemoveViewportIcon(Actor* obj)
Parameters
Actor obj

Returns
void

UpdateActor(Actor* a, int32& key, ISceneRenderingListener::UpdateFlags flags=ISceneRenderingListener::Auto)

Declaration
public void UpdateActor(Actor* a, int32& key, ISceneRenderingListener::UpdateFlags flags=ISceneRenderingListener::Auto)
Parameters
Actor a

int32 key

ISceneRenderingListener::UpdateFlags flags