Artemis logo
Search Results for

    Show / Hide Table of Contents

    Class BaseLayerEffect

    For internal use only, please use LayerEffect<T> instead

    Inheritance
    System.Object
    CorePropertyChanged
    BaseLayerEffect
    LayerEffect<T>
    Implements
    System.IDisposable
    Inherited Members
    CorePropertyChanged.PropertyChanged
    CorePropertyChanged.RequiresUpdate<T>(T, T)
    CorePropertyChanged.SetAndNotify<T>(T, T, String)
    CorePropertyChanged.OnPropertyChanged(String)
    Namespace: Artemis.Core.LayerEffects
    Assembly: Artemis.Core.dll
    Syntax
    public abstract class BaseLayerEffect : CorePropertyChanged, INotifyPropertyChanged, IDisposable

    Constructors

    | Improve this Doc View Source

    BaseLayerEffect()

    Declaration
    protected BaseLayerEffect()

    Properties

    | Improve this Doc View Source

    BaseProperties

    Gets a reference to the layer property group without knowing it's type

    Declaration
    public virtual LayerPropertyGroup BaseProperties { get; }
    Property Value
    Type Description
    LayerPropertyGroup
    | Improve this Doc View Source

    ConfigurationDialog

    Gets or sets a configuration dialog complementing the regular properties

    Declaration
    public ILayerEffectConfigurationDialog ConfigurationDialog { get; protected set; }
    Property Value
    Type Description
    ILayerEffectConfigurationDialog
    | Improve this Doc View Source

    Descriptor

    Gets the LayerEffectDescriptor that registered this effect

    Declaration
    public LayerEffectDescriptor Descriptor { get; }
    Property Value
    Type Description
    LayerEffectDescriptor
    | Improve this Doc View Source

    Enabled

    Gets or sets the enabled state, if not enabled the effect is skipped in render and update

    Declaration
    public bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    EntityId

    Gets the unique ID of this effect

    Declaration
    public Guid EntityId { get; }
    Property Value
    Type Description
    System.Guid
    | Improve this Doc View Source

    HasBeenRenamed

    Gets or sets whether the effect has been renamed by the user, if true consider refraining from changing the name programatically

    Declaration
    public bool HasBeenRenamed { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Name

    The name which appears in the editor

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Order

    Gets the order in which this effect appears in the update loop and editor

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

    ProfileElement

    Gets the profile element (such as layer or folder) this effect is applied to

    Declaration
    public RenderProfileElement ProfileElement { get; }
    Property Value
    Type Description
    RenderProfileElement
    | Improve this Doc View Source

    ProviderId

    Gets the ID of the LayerEffectProvider that provided this effect

    Declaration
    public string ProviderId { get; }
    Property Value
    Type Description
    System.String

    Methods

    | Improve this Doc View Source

    DisableLayerEffect()

    Called when the layer effect is deactivated

    Declaration
    public abstract void DisableLayerEffect()
    | Improve this Doc View Source

    Dispose()

    Declaration
    public void Dispose()
    | Improve this Doc View Source

    Dispose(Boolean)

    Releases the unmanaged resources used by the object and optionally releases the managed resources.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    | Improve this Doc View Source

    EnableLayerEffect()

    Called when the layer effect is activated

    Declaration
    public abstract void EnableLayerEffect()
    | Improve this Doc View Source

    PostProcess(SKCanvas, SKRect, SKPaint)

    Called after the layer of folder has been rendered

    Declaration
    public abstract void PostProcess(SKCanvas canvas, SKRect renderBounds, SKPaint paint)
    Parameters
    Type Name Description
    SkiaSharp.SKCanvas canvas

    The canvas used to render the frame

    SkiaSharp.SKRect renderBounds

    The bounds this layer/folder rendered in

    SkiaSharp.SKPaint paint

    The paint this layer/folder used to render

    | Improve this Doc View Source

    PreProcess(SKCanvas, SKRect, SKPaint)

    Called before the layer or folder will be rendered

    Declaration
    public abstract void PreProcess(SKCanvas canvas, SKRect renderBounds, SKPaint paint)
    Parameters
    Type Name Description
    SkiaSharp.SKCanvas canvas

    The canvas used to render the frame

    SkiaSharp.SKRect renderBounds

    The bounds this layer/folder will render in

    SkiaSharp.SKPaint paint

    The paint this layer/folder will use to render

    | Improve this Doc View Source

    Update(Double)

    Called before rendering every frame, write your update logic here

    Declaration
    public abstract void Update(double deltaTime)
    Parameters
    Type Name Description
    System.Double deltaTime

    Implements

    System.IDisposable
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX