Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    LensFlare Class

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

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

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

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

    Initializes a new instance of the LensFlare class.

    Properties
    Amount

    Amount of light streak (intensity).

    ColorAberrations

    Modulate the RGB color of each tap.

    ColorAberrationStrength

    Strength of the color aberration.

    HaloFactor

    Halo factor when the camera is pointing exactly at a light source.

    ZoomOffsetsDistortions

    Defines the offsets (through zooming), and the distortion factor of each tap. A distortion factor > 0 will stretch in a circular way around the center (fisheye-like); in [-1, 0] it will stretch the texture towards the center.

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

    Constructors


    LensFlare()

    Initializes a new instance of the LensFlare class.

    public LensFlare()
    | Improve this Doc View Source

    Properties


    Amount

    Amount of light streak (intensity).

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

    ColorAberrations

    Modulate the RGB color of each tap.

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

    ColorAberrationStrength

    Strength of the color aberration.

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

    HaloFactor

    Halo factor when the camera is pointing exactly at a light source.

    [Display("Halo", null)]
    [DataMember(20)]
    public float HaloFactor { get; set; }
    Property Value
    Type Description
    System.Single

    ZoomOffsetsDistortions

    Defines the offsets (through zooming), and the distortion factor of each tap. A distortion factor > 0 will stretch in a circular way around the center (fisheye-like); in [-1, 0] it will stretch the texture towards the center.

    public Vector2[] ZoomOffsetsDistortions { get; set; }
    Property Value
    Type Description
    Vector2[]
    | 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
    In This Article
    • Constructors
      • LensFlare()
    • Properties
      • Amount
      • ColorAberrations
      • ColorAberrationStrength
      • HaloFactor
      • ZoomOffsetsDistortions
    • Methods
      • DrawCore(RenderDrawContext)
      • InitializeCore()
    • Inherited Members
    • Extension Methods

    Back to top

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