Class LayerEffectProvider
Allows you to register one or more LayerEffect<T>s usable by profile layers.
Implements
System.IDisposable
Inherited Members
Namespace: Artemis.Core.LayerEffects
Assembly: Artemis.Core.dll
Syntax
public abstract class LayerEffectProvider : PluginFeature, INotifyPropertyChanged, IDisposable
Constructors
| Improve this Doc View SourceLayerEffectProvider()
Allows you to register one or more LayerEffect<T>s usable by profile layers.
Declaration
protected LayerEffectProvider()
Properties
| Improve this Doc View SourceLayerEffectDescriptors
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 |
---|---|
System.Collections.ObjectModel.ReadOnlyCollection<LayerEffectDescriptor> |
Methods
| Improve this Doc View SourceRegisterLayerEffectDescriptor<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 |
---|---|---|
System.String | displayName | The name to display in the UI |
System.String | description | The description to display in the UI |
System.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
System.IDisposable