Class BaseLayerEffect
For internal use only, please use LayerEffect<T> instead
Implements
Inherited Members
Namespace: Artemis.Core.LayerEffects
Assembly: Artemis.Core.dll
Syntax
public abstract class BaseLayerEffect : CorePropertyChanged, INotifyPropertyChanged, IDisposable
Constructors
| Improve this Doc View SourceBaseLayerEffect()
Declaration
protected BaseLayerEffect()
Properties
| Improve this Doc View SourceBaseProperties
Gets a reference to the layer property group without knowing it's type
Declaration
public virtual LayerPropertyGroup BaseProperties { get; }
Property Value
Type | Description |
---|---|
LayerPropertyGroup |
ConfigurationDialog
Gets or sets a configuration dialog complementing the regular properties
Declaration
public ILayerEffectConfigurationDialog ConfigurationDialog { get; protected set; }
Property Value
Type | Description |
---|---|
ILayerEffectConfigurationDialog |
Descriptor
Gets the LayerEffectDescriptor that registered this effect
Declaration
public LayerEffectDescriptor Descriptor { get; }
Property Value
Type | Description |
---|---|
LayerEffectDescriptor |
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 |
EntityId
Gets the unique ID of this effect
Declaration
public Guid EntityId { get; }
Property Value
Type | Description |
---|---|
System.Guid |
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 |
Name
The name which appears in the editor
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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 |
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 |
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 SourceDisableLayerEffect()
Called when the layer effect is deactivated
Declaration
public abstract void DisableLayerEffect()
Dispose()
Declaration
public void Dispose()
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. |
EnableLayerEffect()
Called when the layer effect is activated
Declaration
public abstract void EnableLayerEffect()
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 |
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 |
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 |