Table of Contents

Class LayerEffectDescriptor

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

A class that describes a layer effect

public class LayerEffectDescriptor
Inheritance
LayerEffectDescriptor

Properties

Description

The description that is displayed in the UI

public string Description { get; }

Property Value

string

DisplayName

The name that is displayed in the UI

public string DisplayName { get; }

Property Value

string

Icon

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

public string Icon { get; }

Property Value

string

IsPlaceholder

Gets a boolean indicating whether this descriptor is a placeholder descriptor.

public bool IsPlaceholder { get; }

Property Value

bool

LayerEffectType

The type of the layer effect

public Type? LayerEffectType { get; }

Property Value

Type

Provider

The plugin that provided this LayerEffectDescriptor

public LayerEffectProvider Provider { get; }

Property Value

LayerEffectProvider

Methods

CreateInstance(RenderProfileElement, LayerEffectEntity?)

Creates an instance of the described effect and applies it to the render element

public BaseLayerEffect CreateInstance(RenderProfileElement renderElement, LayerEffectEntity? entity)

Parameters

renderElement RenderProfileElement
entity LayerEffectEntity

Returns

BaseLayerEffect