Artemis Artemis
Artemis Artemis

Search Results for

    Class LayerBrushDescriptor

    A class that describes a layer brush

    Inheritance
    object
    LayerBrushDescriptor
    Namespace: Artemis.Core.LayerBrushes
    Assembly: Artemis.Core.dll
    Syntax
    public class LayerBrushDescriptor

    Properties

    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

    LayerBrushType

    The type of the layer brush

    Declaration
    public Type LayerBrushType { get; }
    Property Value
    Type Description
    Type

    Provider

    The plugin that provided this LayerBrushDescriptor

    Declaration
    public LayerBrushProvider Provider { get; }
    Property Value
    Type Description
    LayerBrushProvider

    Methods

    CreateInstance(Layer, LayerBrushEntity?)

    Creates an instance of the described brush and applies it to the layer

    Declaration
    public BaseLayerBrush CreateInstance(Layer layer, LayerBrushEntity? entity)
    Parameters
    Type Name Description
    Layer layer
    LayerBrushEntity entity
    Returns
    Type Description
    BaseLayerBrush

    MatchesLayerBrushReference(LayerBrushReference?)

    Determines whether the provided reference references to a brush provided by this descriptor

    Declaration
    public bool MatchesLayerBrushReference(LayerBrushReference? reference)
    Parameters
    Type Name Description
    LayerBrushReference reference
    Returns
    Type Description
    bool
    Content is available under the PolyForm Noncommercial License, by Artemis RGB.