RenderLightCollectionGroup Class

    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).

    System.Object → RenderLightCollectionGroup
    Derived from RenderLightCollectionGroup: 

    public sealed class RenderLightCollectionGroup : IEnumerable<RenderLightCollection>, IEnumerable
    Name Description
    Properties
    AllLights

    Gets all the lights stored in this group.
    AllLightsWithShadows

    Gets the lights with shadows.
    Count

    Gets the number of RenderLightCollection stored in this group.
    Item[Int32]

    Gets the RenderLightCollection at the specified index.
    LightType

    Gets the light type this collection contains.
    Methods
    FindLightCollectionByGroup(RenderGroup)

    Gets the light affecting a specific group.
    GetEnumerator()
    Explicit Interface Implementations
    IEnumerable<RenderLightCollection>.GetEnumerator()
    IEnumerable.GetEnumerator()
    | Improve this Doc View Source

    Properties

    AllLights

    Gets all the lights stored in this group.

    public List<RenderLight> AllLights { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<RenderLight>

    All lights.

    AllLightsWithShadows

    Gets the lights with shadows.

    public List<RenderLight> AllLightsWithShadows { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<RenderLight>

    The lights with shadows.

    Count

    Gets the number of RenderLightCollection stored in this group.

    public int Count { get; }
    Property Value
    Type Description
    System.Int32

    The number of RenderLightCollection stored in this group.

    Item[Int32]

    Gets the RenderLightCollection at the specified index.

    public RenderLightCollection this[int index] { get; }
    Parameters
    Type Name Description
    System.Int32 index

    The index.
    Property Value
    Type Description
    RenderLightCollection

    LightComponentCollection.
    Exceptions
    Type Condition
    System.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 Description
    System.Type
    | Improve this Doc View Source

    Methods

    FindLightCollectionByGroup(RenderGroup)

    Gets the light affecting a specific group.

    public RenderLightCollection FindLightCollectionByGroup(RenderGroup group)
    Parameters
    Type Name Description
    RenderGroup group

    The group.
    Returns
    Type Description
    RenderLightCollection

    LightComponentCollection.

    GetEnumerator()

    public FastListStruct<RenderLightCollection>.Enumerator GetEnumerator()
    Returns
    Type Description
    FastListStruct.Enumerator<>
    | Improve this Doc View Source

    Explicit Interface Implementations

    IEnumerable<RenderLightCollection>.GetEnumerator()

    IEnumerator<RenderLightCollection> IEnumerable<RenderLightCollection>.GetEnumerator()
    Returns
    Type Description
    System.Collections.Generic.IEnumerator<RenderLightCollection>

    IEnumerable.GetEnumerator()

    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    System.Collections.IEnumerator

    Extension Methods