Class GrayscaleEffect

Namespace

PaintDotNet.Direct2D1.Effects

Assembly

PaintDotNet.Windows.Core.dll

Converts an image to monochromatic gray.

For more information, see Grayscale effect

public sealed class GrayscaleEffect : DeviceEffect<GrayscaleEffect.Props>, ISerializable, IDeviceEffect, IDeviceImage, IDirect2DResource, IFactoryProperty, IDeviceEffectProperties, IInternalImpl, IObjectRef, IIsDisposed, IDisposable

Inheritance

object

RefTrackedObject

DeviceEffect

DeviceEffect<GrayscaleEffect.Props>

GrayscaleEffect

Implements

ISerializable

IDeviceEffect

IDeviceImage

IDirect2DResource

IFactoryProperty

IDeviceEffectProperties

IInternalImpl

IObjectRef

IIsDisposed

IDisposable

Inherited Members

DeviceEffect<GrayscaleEffect.Props>.Properties

DeviceEffect.IsInputSet(int)

DeviceEffect.GetInput(int)

DeviceEffect.SetInput(int, IDeviceImage, bool)

DeviceEffect.TryGetSubProperties(int, out IDeviceEffectProperties)

DeviceEffect.TryGetPropertyName(int, out string)

DeviceEffect.TryGetPropertyIndex(string, out int)

DeviceEffect.TryGetPropertyType(int, out DeviceEffectPropertyType)

DeviceEffect.TryGetValueSize(int, out int)

DeviceEffect.GetValue(int, DeviceEffectPropertyType, Span<byte>)

DeviceEffect.GetValueByName(string, DeviceEffectPropertyType, Span<byte>)

DeviceEffect.GetValueRef(int, DeviceEffectPropertyType, Type)

DeviceEffect.GetValueRefByName(string, DeviceEffectPropertyType, Type)

DeviceEffect.GetValueSize(int)

DeviceEffect.SetValue(int, DeviceEffectPropertyType, ReadOnlySpan<byte>)

DeviceEffect.SetValueByName(string, DeviceEffectPropertyType, ReadOnlySpan<byte>)

DeviceEffect.SetValueRef(int, DeviceEffectPropertyType, IObjectRef)

DeviceEffect.SetValueRefByName(string, DeviceEffectPropertyType, IObjectRef)

DeviceEffect.InputCount

DeviceEffect.Factory

DeviceEffect.PropertyCount

RefTrackedObject.Dispose()

RefTrackedObject.TryCreateRef(Type, out IObjectRef)

RefTrackedObject.IsDisposed

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

DeviceEffectExtensions.Initialize<TEffect>(TEffect, Action<TEffect>)

DeviceEffectExtensions.InvalidateInputRectangle(IDeviceEffect, IDeviceContext, int, RectFloat)

DeviceImageExtensions.GetLocalBounds(IDeviceImage, IDeviceContext)

DeviceImageExtensions.GetWorldBounds(IDeviceImage, IDeviceContext)

Remarks

NOTE: This effect works on sRGB (gamma 2.2) images. To correctly apply this effect to linear (gamma 1.0, aka "scRGB") images, use GrayscaleEffect2 instead and set the InputGamma property to Linear.

This effect calculates the luma for the image's color values, which is different than luminance which is calculated by the LuminanceToAlphaEffect. See Difference between Luma and Luminance for more information.

This effect works correctly with both premultiplied and straight alpha images.

Constructors

GrayscaleEffect(IDeviceEffectFactory)

GrayscaleEffect(IDeviceEffectFactory, IDeviceImage)