Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    LightProbeProcessor Class

    Namespace: Stride.Rendering.LightProbes
    Assembly: Stride.Engine.dll
    System.Object → EntityProcessor → EntityProcessor<LightProbeComponent, LightProbeComponent> → EntityProcessor<LightProbeComponent> → LightProbeProcessor
    Derived from LightProbeProcessor:

    public class LightProbeProcessor : EntityProcessor<LightProbeComponent>, IEntityComponentRenderProcessor
    Name Description
    Constructors
    LightProbeProcessor()
    Properties
    VisibilityGroup
    Methods
    Draw(RenderContext)
    OnEntityComponentAdding(Entity, LightProbeComponent, LightProbeComponent)
    OnEntityComponentRemoved(Entity, LightProbeComponent, LightProbeComponent)
    UpdateLightProbeCoefficients()

    Updates only the coefficients of the light probes (from Coefficients to Coefficients).

    UpdateLightProbePositions()

    Light probe runtime data is auto-computed when lightprobes are added/removed. If you move them at runtime, please call this method.

    | Improve this Doc View Source

    Constructors


    LightProbeProcessor()

    public LightProbeProcessor()
    | Improve this Doc View Source

    Properties


    VisibilityGroup

    public VisibilityGroup VisibilityGroup { get; set; }
    Property Value
    Type Description
    VisibilityGroup
    | Improve this Doc View Source

    Methods


    Draw(RenderContext)

    public override void Draw(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context
    Overrides
    EntityProcessor.Draw(RenderContext)

    OnEntityComponentAdding(Entity, LightProbeComponent, LightProbeComponent)

    protected override void OnEntityComponentAdding(Entity entity, LightProbeComponent component, LightProbeComponent data)
    Parameters
    Type Name Description
    Entity entity
    LightProbeComponent component
    LightProbeComponent data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.LightProbeComponent, Stride.Engine.LightProbeComponent>.OnEntityComponentAdding(Stride.Engine.Entity, Stride.Engine.LightProbeComponent, Stride.Engine.LightProbeComponent)

    OnEntityComponentRemoved(Entity, LightProbeComponent, LightProbeComponent)

    protected override void OnEntityComponentRemoved(Entity entity, LightProbeComponent component, LightProbeComponent data)
    Parameters
    Type Name Description
    Entity entity
    LightProbeComponent component
    LightProbeComponent data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.LightProbeComponent, Stride.Engine.LightProbeComponent>.OnEntityComponentRemoved(Stride.Engine.Entity, Stride.Engine.LightProbeComponent, Stride.Engine.LightProbeComponent)

    UpdateLightProbeCoefficients()

    Updates only the coefficients of the light probes (from Coefficients to Coefficients).

    public void UpdateLightProbeCoefficients()

    UpdateLightProbePositions()

    Light probe runtime data is auto-computed when lightprobes are added/removed. If you move them at runtime, please call this method.

    public void UpdateLightProbePositions()
    Remarks

    This will also update coefficients.


    Inherited Members

    EntityProcessor<LightProbeComponent>.GenerateComponentData(Entity, LightProbeComponent)
    EntityProcessor<LightProbeComponent>.IsAssociatedDataValid(Entity, LightProbeComponent, LightProbeComponent)
    EntityProcessor<LightProbeComponent, LightProbeComponent>.ComponentDatas
    EntityProcessor<LightProbeComponent, LightProbeComponent>.OnSystemAdd()
    EntityProcessor<LightProbeComponent, LightProbeComponent>.OnSystemRemove()
    EntityProcessor<LightProbeComponent, LightProbeComponent>.RemoveAllEntities()
    EntityProcessor<LightProbeComponent, LightProbeComponent>.ProcessEntityComponent(Entity, EntityComponent, Boolean)
    EntityProcessor<LightProbeComponent, LightProbeComponent>.GenerateComponentData(Entity, LightProbeComponent)
    EntityProcessor<LightProbeComponent, LightProbeComponent>.IsAssociatedDataValid(Entity, LightProbeComponent, LightProbeComponent)
    EntityProcessor<LightProbeComponent, LightProbeComponent>.OnEntityComponentAdding(Entity, LightProbeComponent, LightProbeComponent)
    EntityProcessor<LightProbeComponent, LightProbeComponent>.OnEntityComponentRemoved(Entity, LightProbeComponent, LightProbeComponent)
    EntityProcessor.Tags
    EntityProcessor.UpdateProfilingState
    EntityProcessor.DrawProfilingState
    EntityProcessor.Enabled
    EntityProcessor.MainComponentType
    EntityProcessor.RequiredTypes
    EntityProcessor.HasRequiredComponents
    EntityProcessor.Order
    EntityProcessor.EntityManager
    EntityProcessor.Services
    EntityProcessor.Update(GameTime)
    EntityProcessor.OnSystemAdd()
    EntityProcessor.OnSystemRemove()
    EntityProcessor.RemoveAllEntities()
    EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, Boolean)
    EntityProcessor.InternalAddEntity(Entity)
    EntityProcessor.InternalRemoveEntity(Entity, Boolean)

    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