Class LightDirectional

Namespace

Stride.Rendering.Lights

Assembly

Stride.Rendering.dll

A directional light.

[DataContract("LightDirectional")]
[Display("Directional", null)]
public class LightDirectional : ColorLightBase, IDirectLight, IColorLight, ILight

Inheritance

object

ColorLightBase

LightDirectional

Implements

IDirectLight

IColorLight

ILight

Inherited Members

ColorLightBase.Color

ColorLightBase.ComputeColor(ColorSpace, float)

Constructors

LightDirectional()

public LightDirectional()

Properties

HasBoundingBox

Gets a value indicating whether this instance has a bounding box.

public bool HasBoundingBox { get; }

Property Value

bool

true if this instance has a bounding box; otherwise, false.

Shadow

Gets or sets the shadow.

[DataMember(200)]
public LightDirectionalShadowMap Shadow { get; set; }

Property Value

LightDirectionalShadowMap

The shadow.

Methods

ComputeBounds(Vector3, Vector3)

Computes the bounds of this light..

public BoundingBox ComputeBounds(Vector3 position, Vector3 direction)

Parameters

position Vector3

The position.

direction Vector3

The direction.

Returns

BoundingBox

BoundingBox.

ComputeScreenCoverage(RenderView, Vector3, Vector3)

Computes the screen coverage of this light in pixel.

public float ComputeScreenCoverage(RenderView renderView, Vector3 position, Vector3 direction)

Parameters

renderView RenderView

The render view.

position Vector3

The position of the light in world space.

direction Vector3

The direction of the light in world space.

Returns

float

The largest screen coverage width or height size in pixels of this light.

Update(RenderLight)

public override bool Update(RenderLight light)

Parameters

light RenderLight

Returns

bool