Skip to content

Class SceneRenderer

Namespace: Apogee.Rendering
Assembly: Apogee.Rendering.dll

The Forward+ renderer. Every frame it builds a render graph: a depth prepass, a light-culling compute pass over the 16 x 9 x 24 cluster grid, the PBR forward pass (opaque and alpha-masked, then blended draws far to near), and a tone-mapping pass into the target.

public sealed class SceneRenderer : IDisposable

Inheritance

object ← SceneRenderer

Implements

IDisposable

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

SceneRenderer(GraphicsDevice, ShaderLibrary?, string?, int)

public SceneRenderer(GraphicsDevice device, ShaderLibrary? shaders = null, string? cacheDirectory = null, int framesInFlight = 2)

Parameters

device GraphicsDevice

shaders ShaderLibrary?

cacheDirectory string?

framesInFlight int

Properties

LastPlan

The graph of the most recent , for the dev overlay.

public GraphPlan? LastPlan { get; }

Property Value

GraphPlan?

LastStats

public RenderStats? LastStats { get; }

Property Value

RenderStats?

Shaders

The library the shaders come from: its are what the dev overlay shows when a shader edit does not compile.

public ShaderLibrary Shaders { get; }

Property Value

ShaderLibrary

Methods

CreateModel(ModelData)

Puts a model on the GPU to place it many times (see , which does it for models by path).

public GpuModel CreateModel(ModelData model)

Parameters

model ModelData

Returns

GpuModel

CreateScene(ModelData, Double3)

Puts a model on the GPU, with its origin at at in the world (the world's origin by default). The scene owns the model.

public RenderScene CreateScene(ModelData model, Double3 at = default)

Parameters

model ModelData

at Double3

Returns

RenderScene

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Render(Frame, RenderScene, Camera, in RenderTarget, RenderSettings?, IRenderOverlay?)

Records a frame of scene seen by camera into frame, ending with the image in target.

public void Render(Frame frame, RenderScene scene, Camera camera, in RenderTarget target, RenderSettings? settings = null, IRenderOverlay? overlay = null)

Parameters

frame Frame

scene RenderScene

camera Camera

target RenderTarget

settings RenderSettings?

overlay IRenderOverlay?

Render(Frame, RenderWorld, Camera, in RenderTarget, RenderSettings?, IRenderOverlay?)

Records a frame of the entities of world (their models and lights) seen by camera.

public void Render(Frame frame, RenderWorld world, Camera camera, in RenderTarget target, RenderSettings? settings = null, IRenderOverlay? overlay = null)

Parameters

frame Frame

world RenderWorld

camera Camera

target RenderTarget

settings RenderSettings?

overlay IRenderOverlay?