Class LayerEffectProvider

Allows you to register one or more LayerEffect<T>s usable by profile layers.

Inheritance
object
CorePropertyChanged
PluginFeature
LayerEffectProvider
Implements
Inherited Members
Namespace: Artemis.Core.LayerEffects
Assembly: Artemis.Core.dll
Syntax
public abstract class LayerEffectProvider : PluginFeature, IDisposable

Constructors

LayerEffectProvider()

Allows you to register one or more LayerEffect<T>s usable by profile layers.

Declaration
protected LayerEffectProvider()

Properties

LayerEffectDescriptors

A read-only collection of all layer effects added with RegisterLayerEffectDescriptor<T>(string, string, string)

Declaration
public ReadOnlyCollection<LayerEffectDescriptor> LayerEffectDescriptors { get; }
Property Value
Type Description
ReadOnlyCollection<LayerEffectDescriptor>

Methods

RegisterLayerEffectDescriptor<T>(string, string, string)

Adds a layer effect descriptor for a given layer effect, so that it appears in the UI.

Note: You do not need to manually remove these on disable

Declaration
protected void RegisterLayerEffectDescriptor<T>(string displayName, string description, string icon) where T : BaseLayerEffect
Parameters
Type Name Description
string displayName

The name to display in the UI
string description

The description to display in the UI
string icon

The Material icon to display in the UI, a full reference can be found here.

May also be a path to an SVG file relative to the directory of the plugin.
Type Parameters
Name Description
T

The type of the layer effect you wish to register

Implements

IDisposable