Table of Contents

Constructor Effect

Namespace
PaintDotNet.Effects
Assembly
PaintDotNet.Effects.Core.dll

Effect(string, IBitmapSource, string?, EffectOptions)

The constructor for the Effect class.

protected Effect(string name, IBitmapSource image, string? submenuName, EffectOptions options)

Parameters

name string
The display name of the effect which will be used in UI elements (e.g. menus, dialog titles, history entries).
image IBitmapSource
An image/icon for the effect that will be used in UI elements (e.g. menus, dialog boxes, history entries).
This should have a square size, at least 16x16 pixels, and will be scaled up or down to 16x16 dips (e.g. 32x32 pixels if system scaling is set to 200%).
submenuName string
The name of a sub-menu to place the effect into. May be null, in which case no sub-menu is used.
options EffectOptions
Contains flags and options to configure the behavior of the effect.

Effect(string, Image, string?, EffectOptions)

The constructor for the Effect class.

protected Effect(string name, Image image, string? submenuName, EffectOptions options)

Parameters

name string

The display name of the effect which will be used in UI elements (e.g. menus, dialog titles, history entries).

image Image

An image/icon for the effect that will be used in UI elements (e.g. menus, dialog boxes, history entries).
This should have a square size, at least 16x16 pixels, and will be scaled up or down to 16x16 dips (e.g. 32x32 pixels if system scaling is set to 200%).

submenuName string

The name of a sub-menu to place the effect into. May be null, in which case no sub-menu is used.

options EffectOptions

Contains flags and options to configure the behavior of the effect.

Effect(string, string?, EffectOptions)

The constructor for the Effect class.

protected Effect(string name, string? submenuName, EffectOptions options)

Parameters

name string
The display name of the effect which will be used in UI elements (e.g. menus, dialog titles, history entries).
submenuName string
The name of a sub-menu to place the effect into. May be null, in which case no sub-menu is used.
options EffectOptions
Contains flags and options to configure the behavior of the effect.