Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    LightShadowMapRendererBase Class

    Namespace: Stride.Rendering.Shadows
    Assembly: Stride.Rendering.dll

    Base class for shadow map renderers

    System.Object → LightShadowMapRendererBase
    Derived from LightShadowMapRendererBase: LightDirectionalShadowMapRenderer LightPointShadowMapRendererCubeMap LightPointShadowMapRendererParaboloid LightSpotShadowMapRenderer

    [DataContract(Inherited = true, DefaultMemberMode = DataMemberMode.Never)]
    public abstract class LightShadowMapRendererBase : ILightShadowMapRenderer, ILightShadowRenderer
    Name Description
    Constructors
    LightShadowMapRendererBase()
    Fields
    shadowMaps
    shadowRenderViews
    Properties
    ShadowCasterRenderStage

    The shadow map render stage this light shadow map renderer uses

    Methods
    ApplyViewParameters(RenderDrawContext, ParameterCollection, LightShadowMapTexture)
    CanRenderLight(IDirectLight)
    Collect(RenderContext, RenderView, LightShadowMapTexture)
    CreateRenderView()

    Creates a default view with the shadow caster stage added to it

    CreateShaderGroupData(LightShadowType)
    CreateShadowMapTexture(RenderView, RenderLight, IDirectLight, Int32)
    GetShadowType(LightShadowMap)
    Reset(RenderContext)
    | Improve this Doc View Source

    Constructors


    LightShadowMapRendererBase()

    protected LightShadowMapRendererBase()
    | Improve this Doc View Source

    Fields


    shadowMaps

    protected PoolListStruct<LightShadowMapTexture> shadowMaps
    Field Value
    Type Description
    PoolListStruct<LightShadowMapTexture>

    shadowRenderViews

    protected PoolListStruct<ShadowMapRenderView> shadowRenderViews
    Field Value
    Type Description
    PoolListStruct<ShadowMapRenderView>
    | Improve this Doc View Source

    Properties


    ShadowCasterRenderStage

    The shadow map render stage this light shadow map renderer uses

    [DataMember]
    public RenderStage ShadowCasterRenderStage { get; set; }
    Property Value
    Type Description
    RenderStage
    | Improve this Doc View Source

    Methods


    ApplyViewParameters(RenderDrawContext, ParameterCollection, LightShadowMapTexture)

    public virtual void ApplyViewParameters(RenderDrawContext context, ParameterCollection parameters, LightShadowMapTexture shadowMapTexture)
    Parameters
    Type Name Description
    RenderDrawContext context
    ParameterCollection parameters
    LightShadowMapTexture shadowMapTexture

    CanRenderLight(IDirectLight)

    public abstract bool CanRenderLight(IDirectLight light)
    Parameters
    Type Name Description
    IDirectLight light
    Returns
    Type Description
    System.Boolean

    Collect(RenderContext, RenderView, LightShadowMapTexture)

    public abstract void Collect(RenderContext context, RenderView sourceView, LightShadowMapTexture lightShadowMap)
    Parameters
    Type Name Description
    RenderContext context
    RenderView sourceView
    LightShadowMapTexture lightShadowMap

    CreateRenderView()

    Creates a default view with the shadow caster stage added to it

    public virtual ShadowMapRenderView CreateRenderView()
    Returns
    Type Description
    ShadowMapRenderView

    CreateShaderGroupData(LightShadowType)

    public abstract ILightShadowMapShaderGroupData CreateShaderGroupData(LightShadowType shadowType)
    Parameters
    Type Name Description
    LightShadowType shadowType
    Returns
    Type Description
    ILightShadowMapShaderGroupData

    CreateShadowMapTexture(RenderView, RenderLight, IDirectLight, Int32)

    public virtual LightShadowMapTexture CreateShadowMapTexture(RenderView renderView, RenderLight renderLight, IDirectLight light, int shadowMapSize)
    Parameters
    Type Name Description
    RenderView renderView
    RenderLight renderLight
    IDirectLight light
    System.Int32 shadowMapSize
    Returns
    Type Description
    LightShadowMapTexture

    GetShadowType(LightShadowMap)

    public virtual LightShadowType GetShadowType(LightShadowMap shadowMap)
    Parameters
    Type Name Description
    LightShadowMap shadowMap
    Returns
    Type Description
    LightShadowType

    Reset(RenderContext)

    public virtual void Reset(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation