Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    LightStreak Class

    Namespace: Stride.Rendering.Images
    Assembly: Stride.Rendering.dll

    Applies some light-streaks effect to an image. This takes in input a bright-pass buffer, calculates the light-streaks and blends them additively to the specified output.

    System.Object → DisposeBase → ComponentBase → RendererCoreBase → RendererBase → DrawEffect → ImageEffect → LightStreak
    Derived from LightStreak:

    [DataContract("LightStreak")]
    public class LightStreak : ImageEffect, IComponent, IReferencable, ICollectorHolder, IImageEffect, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
    Name Description
    Constructors
    LightStreak()

    Initializes a new instance of the LightStreak class.

    Properties
    Amount

    Amount of light streak (intensity).

    AnamorphicOffsetsWeights

    For each light streak, you can define some sub-light-streaks drawn at a certain offset of the original streak, with a certain weight.

    Attenuation

    How fast the attenuation is along a streak. (Affects the streak length.)

    ColorAberrationCoefficients

    RGB coefficients to apply for color aberration along a streak.

    ColorAberrationStrength

    Strength of the color aberration.

    IsAnamorphic

    Applies an anamorphic effect to the streak.

    IterationCount

    Number of stretching iterations to apply.

    Phase

    Phase angle for the streaks, in degrees.

    StreakCount

    Number of light streaks.

    TapsPerIteration

    Number of texture taps for each iteration of light streak extension.

    Methods
    DrawCore(RenderDrawContext)
    InitializeCore()
    | Improve this Doc View Source

    Constructors


    LightStreak()

    Initializes a new instance of the LightStreak class.

    public LightStreak()
    | Improve this Doc View Source

    Properties


    Amount

    Amount of light streak (intensity).

    [DataMember(10)]
    public float Amount { get; set; }
    Property Value
    Type Description
    System.Single

    AnamorphicOffsetsWeights

    For each light streak, you can define some sub-light-streaks drawn at a certain offset of the original streak, with a certain weight.

    public Vector3[] AnamorphicOffsetsWeights { get; set; }
    Property Value
    Type Description
    Vector3[]

    Attenuation

    How fast the attenuation is along a streak. (Affects the streak length.)

    [DataMember(30)]
    [DataMemberRange(0, 1, 0.0099999997764825821, 0.10000000149011612, 2)]
    public float Attenuation { get; set; }
    Property Value
    Type Description
    System.Single

    ColorAberrationCoefficients

    RGB coefficients to apply for color aberration along a streak.

    public Vector3 ColorAberrationCoefficients { get; set; }
    Property Value
    Type Description
    Vector3

    ColorAberrationStrength

    Strength of the color aberration.

    [Display("Color abberation", null)]
    [DataMember(50)]
    [DataMemberRange(0, 1, 0.01, 0.1, 2)]
    public float ColorAberrationStrength { get; set; }
    Property Value
    Type Description
    System.Single

    IsAnamorphic

    Applies an anamorphic effect to the streak.

    [Display("Anamorphic", null)]
    [DataMember(60)]
    public bool IsAnamorphic { get; set; }
    Property Value
    Type Description
    System.Boolean

    IterationCount

    Number of stretching iterations to apply.

    public int IterationCount { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    Each iteration rises the length of the light streak to the next power of TapsPerIteration.


    Phase

    Phase angle for the streaks, in degrees.

    [DataMember(40)]
    [DataMemberRange(0, 180, 1, 10, 1)]
    public float Phase { get; set; }
    Property Value
    Type Description
    System.Single

    StreakCount

    Number of light streaks.

    [Display("Streaks", null)]
    [DataMember(20)]
    [DataMemberRange(1, 8, 1, 1, 0)]
    public int StreakCount { get; set; }
    Property Value
    Type Description
    System.Int32

    TapsPerIteration

    Number of texture taps for each iteration of light streak extension.

    public int TapsPerIteration { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    Methods


    DrawCore(RenderDrawContext)

    protected override void DrawCore(RenderDrawContext contextParameters)
    Parameters
    Type Name Description
    RenderDrawContext contextParameters
    Overrides
    RendererBase.DrawCore(RenderDrawContext)

    InitializeCore()

    protected override void InitializeCore()
    Overrides
    RendererCoreBase.InitializeCore()

    Inherited Members

    ImageEffect.EnableSetRenderTargets
    ImageEffect.SetInput(Int32, Texture)
    ImageEffect.Reset()
    ImageEffect.SetOutput(Texture)
    ImageEffect.SetOutput(Texture[])
    ImageEffect.SetDepthOutput(Texture, Texture)
    ImageEffect.SetDepthOutput(Texture, Texture[])
    ImageEffect.SetViewport(Nullable<Viewport>)
    ImageEffect.PreDrawCore(RenderDrawContext)
    ImageEffect.SetRenderTargets(RenderDrawContext)
    ImageEffect.PostDrawCore(RenderDrawContext)
    ImageEffect.DisposeCreatedRenderTargetViews(RenderDrawContext)
    ImageEffect.InputCount
    ImageEffect.GetInput(Int32)
    ImageEffect.GetSafeInput(Int32)
    ImageEffect.DepthStencil
    ImageEffect.HasDepthStencilOutput
    ImageEffect.OutputCount
    ImageEffect.GetOutput(Int32)
    ImageEffect.GetSafeOutput(Int32)
    ImageEffect.NewScopedRenderTarget2D(TextureDescription)
    ImageEffect.NewScopedRenderTarget2D(Int32, Int32, PixelFormat, TextureFlags, Int32)
    ImageEffect.NewScopedRenderTarget2D(Int32, Int32, PixelFormat, MipMapCount, TextureFlags, Int32)
    DrawEffect.SamplingPattern
    DrawEffect.Parameters
    DrawEffect.Scaler
    DrawEffect.SetDefaultParameters()
    DrawEffect.Draw(RenderDrawContext, String)
    DrawEffect.Draw(RenderDrawContext, String, Object[])
    DrawEffect.ToString()
    RendererBase.Draw(RenderDrawContext)
    RendererCoreBase.Enabled
    RendererCoreBase.Profiling
    RendererCoreBase.ProfilingKey
    RendererCoreBase.Context
    RendererCoreBase.Services
    RendererCoreBase.Content
    RendererCoreBase.GraphicsDevice
    RendererCoreBase.EffectSystem
    RendererCoreBase.Initialized
    RendererCoreBase.Initialize(RenderContext)
    RendererCoreBase.Unload()
    RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat)
    RendererCoreBase.NewScopedTypedBuffer(Int32, PixelFormat, Boolean, GraphicsResourceUsage)
    RendererCoreBase.PushScopedResource<T>(T)
    RendererCoreBase.CheckIsInDrawCore()
    RendererCoreBase.Destroy()
    RendererCoreBase.ToLoadAndUnload<T>(T)
    RendererCoreBase.PreDrawCoreInternal(RenderDrawContext)
    RendererCoreBase.EnsureContext(RenderContext)
    RendererCoreBase.PostDrawCoreInternal(RenderDrawContext)
    ComponentBase.Tags
    ComponentBase.Name
    ComponentBase.ICollectorHolder.Collector
    ComponentBase.OnNameChanged()
    DisposeBase.Dispose()
    DisposeBase.IsDisposed
    DisposeBase.IReferencable.ReferenceCount
    DisposeBase.IReferencable.AddReference()
    DisposeBase.IReferencable.Release()
    DisposeBase.OnAddReference()
    DisposeBase.OnReleaseReference()

    Extension Methods

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

    Back to top

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