s&box docs
API ReferenceSandbox

DirectionalLightclass

A directional light that casts shadows, like the sun.

object→Light→DirectionalLight
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.DirectionalLight : Sandbox.Light

Constructors1

Showing 1 constructors

Methods3

Showing 3 methods

protected virtual void DrawGizmos()PROTECTEDVIRTUAL

Returns:void—

protected virtual void OnAwake()PROTECTEDVIRTUALLIFECYCLE

Returns:void—

Properties4

Showing 4 properties

public int Sandbox.DirectionalLight.ShadowCascadeCount { get; set; }PUBLICGETSET

Number of cascades to split the view frustum into for the whole scene dynamic shadow. More cascades result in better shadow resolution, but adds significant rendering cost. User settings will set a maximum.

Returns:int—

public float Sandbox.DirectionalLight.ShadowCascadeSplitRatio { get; set; }PUBLICGETSET

Controls how cascades 2+ are distributed between the first cascade boundary and the far clip. 0 is uniform, 1 is fully logarithmic.

Returns:float—

public Color Sandbox.DirectionalLight.SkyColor { get; set; }PUBLICGETSET

Color of the ambient sky color This is kept for long term support, the recommended way to do this is with an Ambient Light component.

Returns:Color—

Render()

Previous Page

ShadowCascadeCount

Next Page

On this page

Constructorspublic DirectionalLight()Methodsprotected virtual Sandbox.SceneLight CreateSceneObject()protected virtual System.Void DrawGizmos()protected virtual System.Void OnAwake()Propertiespublic System.Int32 Sandbox.DirectionalLight.ShadowCascadeCount { get; set; }public System.Single Sandbox.DirectionalLight.ShadowCascadeSplitRatio { get; set; }public Color Sandbox.DirectionalLight.SkyColor { get; set; }public Sandbox.DirectionalLight.CascadeVisualizer Sandbox.DirectionalLight.Visualizer { get; set; }Metadata