Table of Contents

Class LayerEffectProvider

Namespace
Artemis.Core.LayerEffects
Assembly
Artemis.Core.dll

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

public abstract class LayerEffectProvider : PluginFeature, IDisposable
Inheritance
object
CorePropertyChanged
LayerEffectProvider
Implements
Inherited Members

Constructors

LayerEffectProvider()

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

protected LayerEffectProvider()

Properties

LayerEffectDescriptors

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

public ReadOnlyCollection<LayerEffectDescriptor> LayerEffectDescriptors { get; }

Property Value

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

protected void RegisterLayerEffectDescriptor<T>(string displayName, string description, string icon) where T : BaseLayerEffect

Parameters

displayName string

The name to display in the UI

description string

The description to display in the UI

icon string

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

T

The type of the layer effect you wish to register