Class RenderLightCollectionGroup

Namespace

Stride.Rendering.Lights

Assembly

Stride.Rendering.dll

A list of RenderLightCollection for a particular type of light (direct light, direct light + shadows, environment lights).

public sealed class RenderLightCollectionGroup : IEnumerable<RenderLightCollection>, IEnumerable

Inheritance

object

RenderLightCollectionGroup

Implements

IEnumerable<RenderLightCollection>

IEnumerable

Extension Methods

EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>)

EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.NotNull<T>(IEnumerable<T>)

EnumerableExtensions.ToHashCode<T>(IEnumerable<T>)

EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>)

EnumerableExtensions.IsNullOrEmpty(IEnumerable)

Properties

AllLights

Gets all the lights stored in this group.

public List<RenderLight> AllLights { get; }

Property Value

List<RenderLight>

All lights.

AllLightsWithShadows

Gets the lights with shadows.

public List<RenderLight> AllLightsWithShadows { get; }

Property Value

List<RenderLight>

The lights with shadows.

Count

Gets the number of RenderLightCollection stored in this group.

public int Count { get; }

Property Value

int

The number of RenderLightCollection stored in this group.

this[int]

Gets the RenderLightCollection at the specified index.

public RenderLightCollection this[int index] { get; }

Parameters

index int

The index.

Property Value

RenderLightCollection

LightComponentCollection.

Exceptions

ArgumentOutOfRangeException

index [{0}] out of range [0, {1}].ToFormat(index, lights.Count - 1)

LightType

Gets the light type this collection contains.

public Type LightType { get; }

Property Value

Type

Methods

FindLightCollectionByGroup(RenderGroup)

Gets the light affecting a specific group.

public RenderLightCollection FindLightCollectionByGroup(RenderGroup group)

Parameters

group RenderGroup

The group.

Returns

RenderLightCollection

LightComponentCollection.

GetEnumerator()

public FastListStruct<RenderLightCollection>.Enumerator GetEnumerator()

Returns

FastListStruct<RenderLightCollection>.Enumerator