Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    Bloom Class

    Namespace: Stride.Rendering.Images
    Assembly: Stride.Rendering.dll
    System.Object → DisposeBase → ComponentBase → RendererCoreBase → RendererBase → DrawEffect → ImageEffect → Bloom
    Derived from Bloom:

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

    Initializes a new instance of the Bloom class.

    Properties
    Afterimage

    Gets the afterimage effect/>

    Amount

    Gets or sets the amount.

    Distortion

    Vertical or horizontal distortion to apply. (1, 2) means the bloom will be stretched twice longer horizontally than vertically.

    DownScale
    MipIndex
    Radius

    Radius of the bloom.

    ShowOnlyBloom
    ShowOnlyMip
    SigmaRatio

    Gets or sets the sigma ratio.

    StableConvolution

    Use the "stable bloom" rendering path.

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

    Constructors


    Bloom()

    Initializes a new instance of the Bloom class.

    public Bloom()
    | Improve this Doc View Source

    Properties


    Afterimage

    Gets the afterimage effect/>

    [DataMember(50)]
    public Afterimage Afterimage { get; }
    Property Value
    Type Description
    Afterimage

    Amount

    Gets or sets the amount.

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

    The amount.


    Distortion

    Vertical or horizontal distortion to apply. (1, 2) means the bloom will be stretched twice longer horizontally than vertically.

    [DataMember(40)]
    public Vector2 Distortion { get; set; }
    Property Value
    Type Description
    Vector2

    DownScale

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

    MipIndex

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

    Radius

    Radius of the bloom.

    [DataMember(10)]
    [DataMemberRange(1, 100, 1, 10, 1)]
    public float Radius { get; set; }
    Property Value
    Type Description
    System.Single

    ShowOnlyBloom

    public bool ShowOnlyBloom { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowOnlyMip

    public bool ShowOnlyMip { get; set; }
    Property Value
    Type Description
    System.Boolean

    SigmaRatio

    Gets or sets the sigma ratio.

    [Display("Sigma ratio", null)]
    [DataMember(30)]
    public float SigmaRatio { get; set; }
    Property Value
    Type Description
    System.Single

    The ratio


    StableConvolution

    Use the "stable bloom" rendering path.

    [DataMember(60)]
    [Display("Expanded filtering", null)]
    public bool StableConvolution { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Methods


    DrawCore(RenderDrawContext)

    protected override void DrawCore(RenderDrawContext context)
    Parameters
    Type Name Description
    RenderDrawContext context
    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