Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    LightShaftComponent Class

    Namespace: Stride.Engine
    Assembly: Stride.Engine.dll

    The source for light shafts, should be placed on the same entity as the light component which will be used for light shafts

    System.Object → EntityComponent → ActivableEntityComponent → LightShaftComponent
    Derived from LightShaftComponent:

    [Display("Light shaft", null, Expand = ExpandRule.Always)]
    [DataContract("LightShaftComponent")]
    [DefaultEntityComponentRenderer(typeof(LightShaftProcessor))]
    [ComponentCategory("Lights")]
    public class LightShaftComponent : ActivableEntityComponent, IIdentifiable
    Name Description
    Properties
    DensityFactor

    Density of the light shaft fog

    SampleCount

    Number of samples taken per pixel

    SeparateBoundingVolumes

    If true, all bounding volumes will be drawn one by one.

    | Improve this Doc View Source

    Properties


    DensityFactor

    Density of the light shaft fog

    [Display("Density", null)]
    public float DensityFactor { get; set; }
    Property Value
    Type Description
    System.Single

    SampleCount

    Number of samples taken per pixel

    [DataMemberRange(1, 0)]
    public int SampleCount { get; set; }
    Property Value
    Type Description
    System.Int32

    SeparateBoundingVolumes

    If true, all bounding volumes will be drawn one by one.

    [Display("Process bounding volumes separately", null)]
    public bool SeparateBoundingVolumes { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    If this is off, the light shafts might be lower in quality if the bounding volumes overlap (in the same pixel). If this is on, and the bounding volumes overlap (in space), the light shafts inside the overlapping area will become twice as bright.


    Inherited Members

    ActivableEntityComponent.Enabled
    EntityComponent.Entity
    EntityComponent.Id
    EntityComponent.EnsureEntity

    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