Class LightnessExtensions

Namespace

SixLabors.ImageSharp.Processing

Assembly

SixLabors.ImageSharp.dll

Defines extensions that allow the alteration of the lightness component of an Image using Mutate/Clone.

public static class LightnessExtensions

Inheritance

object

LightnessExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Lightness(IImageProcessingContext, float)

Alters the lightness component of the image.

public static IImageProcessingContext Lightness(this IImageProcessingContext source, float amount)

Parameters

source IImageProcessingContext

The current image processing context.

amount float

The proportion of the conversion. Must be greater than or equal to 0.

Returns

IImageProcessingContext

The IImageProcessingContext.

Remarks

A value of 0 will create an image that is completely black. A value of 1 leaves the input unchanged. Other values are linear multipliers on the effect. Values of an amount over 1 are allowed, providing lighter results.

Lightness(IImageProcessingContext, float, Rectangle)

Alters the lightness component of the image.

public static IImageProcessingContext Lightness(this IImageProcessingContext source, float amount, Rectangle rectangle)

Parameters

source IImageProcessingContext

The current image processing context.

amount float

The proportion of the conversion. Must be greater than or equal to 0.

rectangle Rectangle

The Rectangle structure that specifies the portion of the image object to alter.

Returns

IImageProcessingContext

The IImageProcessingContext.

Remarks

A value of 0 will create an image that is completely black. A value of 1 leaves the input unchanged. Other values are linear multipliers on the effect. Values of an amount over 1 are allowed, providing lighter results.