Table of Contents

Class LightingSetup

Namespace
Stride.CommunityToolkit.Engine
Assembly
Stride.CommunityToolkit.dll

The lights of a SceneSetup3D: one directional light, the three-light studio rig, or a light down each world axis. Built through Directional(float, bool), Studio(float, float, bool) or AllDirections(float).

public sealed record LightingSetup : IEquatable<LightingSetup>
Inheritance
LightingSetup
Implements

Constructors

LightingSetup(LightingRig, float, bool, float)

The lights of a SceneSetup3D: one directional light, the three-light studio rig, or a light down each world axis. Built through Directional(float, bool), Studio(float, float, bool) or AllDirections(float).

public LightingSetup(LightingRig Rig, float Intensity, bool Shadows = true, float YawDegrees = 45)

Parameters

Rig LightingRig

Which lights.

Intensity float

The intensity of the main light; the studio rig scales its fill and rim from it.

Shadows bool

Whether the main light casts shadows.

YawDegrees float

The studio rig's turn about Y.

Properties

Intensity

The intensity of the main light; the studio rig scales its fill and rim from it.

public float Intensity { get; init; }

Property Value

float

Rig

Which lights.

public LightingRig Rig { get; init; }

Property Value

LightingRig

Shadows

Whether the main light casts shadows.

public bool Shadows { get; init; }

Property Value

bool

YawDegrees

The studio rig's turn about Y.

public float YawDegrees { get; init; }

Property Value

float

Methods

AllDirections(float)

Six lights, one down each world axis, of AddAllDirectionLighting(IGame, float, bool); no shadows.

public static LightingSetup AllDirections(float intensity = 5)

Parameters

intensity float

Returns

LightingSetup

Directional(float, bool)

One directional light from above and behind the camera, what AddDirectionalLight(IGame, string?, bool, float) adds.

public static LightingSetup Directional(float intensity = 20, bool shadows = true)

Parameters

intensity float
shadows bool

Returns

LightingSetup

Studio(float, float, bool)

The key, fill and rim lights of AddStudioLighting(IGame, float, float, bool, bool).

public static LightingSetup Studio(float intensity = 15, float yawDegrees = 45, bool shadows = true)

Parameters

intensity float
yawDegrees float
shadows bool

Returns

LightingSetup