Skip to content

Class RenderSettings

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

public sealed class RenderSettings

Inheritance

object ← RenderSettings

Inherited Members

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

Properties

AdaptationSpeedBright

How fast the auto-exposure follows a scene that got brighter, per second: it moves a fraction of 1 - e^(-speed * dt) of the way to the target each frame.

public float AdaptationSpeedBright { get; set; }

Property Value

float

AdaptationSpeedDark

How fast the auto-exposure follows a scene that got darker, per second. The eye adapts to dark slower than to light.

public float AdaptationSpeedDark { get; set; }

Property Value

float

Aperture

The f-number of the physical camera ().

public float Aperture { get; set; }

Property Value

float

AutoHighPercentile

The pixels above this share, in brightness, are left out of the average: a few lamps should not darken the whole image.

public float AutoHighPercentile { get; set; }

Property Value

float

AutoLowPercentile

The share of the darkest measured pixels the auto-exposure leaves out of the average (0 to 1).

public float AutoLowPercentile { get; set; }

Property Value

float

CullDraws

Leave out the draws whose bounds are outside the camera's view (on the CPU, with SIMD). Turn it off to compare, in tools and tests.

public bool CullDraws { get; set; }

Property Value

bool

Debug

public DebugView Debug { get; set; }

Property Value

DebugView

DebugDraw

Lines and triangles to draw over the lit scene, depth-tested against it; null draws none. The renderer reads it and leaves it alone: whoever fills it clears it for the next frame.

public DebugDraw? DebugDraw { get; set; }

Property Value

DebugDraw?

DebugHiddenAlpha

How visible the part of a debug line is that is behind something: 0 hides it, 1 draws it as strongly as the rest.

public float DebugHiddenAlpha { get; set; }

Property Value

float

DebugLineWidth

The width of a debug line in pixels.

public float DebugLineWidth { get; set; }

Property Value

float

DeltaTime

The seconds since the previous frame, for the adaptation; null measures it with the clock between calls to Render (tests set it to be repeatable).

public float? DeltaTime { get; set; }

Property Value

float?

Ev100

The exposure value at ISO 100 for , and where starts on its first frame. 12 suits an overcast day (EV100 15 is the "sunny 16" day, 5 a lit room).

public float Ev100 { get; set; }

Property Value

float

Exposure

The exposure compensation, as a factor: it multiplies the exposure of every mode (2 is one stop brighter, 0.5 one stop darker). The scene's light is photometric (the sun in lux, point and spot lights in candela), and this is applied after the camera's exposure, so 1 leaves it as the camera chose.

public float Exposure { get; set; }

Property Value

float

ExposureMode

How the exposure is chosen; by default, which suits any scene whatever the scale of its lights.

public ExposureMode ExposureMode { get; set; }

Property Value

ExposureMode

Iso

The physical camera's sensitivity.

public float Iso { get; set; }

Property Value

float

ManualEv100

The EV100 of and (and the start of ), before the compensation.

public float ManualEv100 { get; }

Property Value

float

MaxEv100

The auto-exposure never goes above this EV100.

public float MaxEv100 { get; set; }

Property Value

float

MinEv100

The auto-exposure never goes below this EV100 (a dark scene is not brightened beyond it).

public float MinEv100 { get; set; }

Property Value

float

ShutterSeconds

How long the physical camera's shutter is open, in seconds.

public float ShutterSeconds { get; set; }

Property Value

float

SkyColor

What the HDR image is cleared to where nothing is drawn. It is a display-referred color, not a luminance: the exposure does not change it (1 is the brightest the exposure shows without tone mapping).

public Vector3 SkyColor { get; set; }

Property Value

Vector3

Tonemapper

The tone mapper. by default.

public Tonemapper Tonemapper { get; set; }

Property Value

Tonemapper