Class LayerEffectDescriptor
A class that describes a layer effect
Namespace: Artemis.Core.LayerEffects
Assembly: Artemis.Core.dll
Syntax
public class LayerEffectDescriptorProperties
Description
The description that is displayed in the UI
Declaration
public string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
DisplayName
The name that is displayed in the UI
Declaration
public string DisplayName { get; }Property Value
| Type | Description |
|---|---|
| string |
Icon
The Material icon to display in the UI, a full reference can be found here
Declaration
public string Icon { get; }Property Value
| Type | Description |
|---|---|
| string |
IsPlaceholder
Gets a boolean indicating whether this descriptor is a placeholder descriptor.
Declaration
public bool IsPlaceholder { get; }Property Value
| Type | Description |
|---|---|
| bool |
LayerEffectType
The type of the layer effect
Declaration
public Type? LayerEffectType { get; }Property Value
| Type | Description |
|---|---|
| Type |
Provider
The plugin that provided this LayerEffectDescriptor
Declaration
public LayerEffectProvider Provider { get; }Property Value
| Type | Description |
|---|---|
| LayerEffectProvider |
Methods
CreateInstance(RenderProfileElement, LayerEffectEntity?)
Creates an instance of the described effect and applies it to the render element
Declaration
public BaseLayerEffect CreateInstance(RenderProfileElement renderElement, LayerEffectEntity? entity)Parameters
| Type | Name | Description |
|---|---|---|
| RenderProfileElement | renderElement | |
| LayerEffectEntity | entity |
Returns
| Type | Description |
|---|---|
| BaseLayerEffect |