Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    ImageEffectShader Class

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

    Post effect using an Effect (either sdfx or sdsl).

    System.Object → DisposeBase → ComponentBase → RendererCoreBase → RendererBase → DrawEffect → ImageEffect → ImageEffectShader
    Derived from ImageEffectShader: ColorCombiner FXAAEffect ImageScaler LuminanceLogEffect SphericalHarmonicsRendererEffect TemporalAntiAliasEffect

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

    Initializes a new instance of the ImageEffectShader class.

    Properties
    BlendState
    DepthStencilState
    EffectInstance

    The current effect instance.

    EffectName

    Effect name.

    Methods
    DrawCore(RenderDrawContext)
    InitializeCore()
    PreDrawCore(RenderDrawContext)
    SetDefaultParameters()

    Sets the default parameters (called at constructor time and if is called)

    UpdateParameters()

    Updates the effect from properties defined in this instance. See remarks.

    | Improve this Doc View Source

    Constructors


    ImageEffectShader(String, Boolean)

    Initializes a new instance of the ImageEffectShader class.

    public ImageEffectShader(string effectName = null, bool delaySetRenderTargets = false)
    Parameters
    Type Name Description
    System.String effectName
    System.Boolean delaySetRenderTargets
    | Improve this Doc View Source

    Properties


    BlendState

    public BlendStateDescription BlendState { get; set; }
    Property Value
    Type Description
    BlendStateDescription

    DepthStencilState

    public DepthStencilStateDescription DepthStencilState { get; set; }
    Property Value
    Type Description
    DepthStencilStateDescription

    EffectInstance

    The current effect instance.

    public DynamicEffectInstance EffectInstance { get; }
    Property Value
    Type Description
    DynamicEffectInstance

    EffectName

    Effect name.

    public string EffectName { get; protected set; }
    Property Value
    Type Description
    System.String
    | 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()

    PreDrawCore(RenderDrawContext)

    protected override void PreDrawCore(RenderDrawContext context)
    Parameters
    Type Name Description
    RenderDrawContext context
    Overrides
    ImageEffect.PreDrawCore(RenderDrawContext)

    SetDefaultParameters()

    Sets the default parameters (called at constructor time and if is called)

    protected override void SetDefaultParameters()
    Overrides
    DrawEffect.SetDefaultParameters()

    UpdateParameters()

    Updates the effect from properties defined in this instance. See remarks.

    protected virtual void UpdateParameters()
    Remarks

    By default, all the input textures will be remapped to Texture0...etc.

    Exceptions
    Type Condition
    System.InvalidOperationException

    Expecting less than 10 textures in input


    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.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.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