Class SaturateExtensions

Namespace

SixLabors.ImageSharp.Processing

Assembly

SixLabors.ImageSharp.dll

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

public static class SaturateExtensions

Inheritance

object

SaturateExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Saturate(IImageProcessingContext, float)

Alters the saturation component of the image.

public static IImageProcessingContext Saturate(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 is completely un-saturated. A value of 1 leaves the input unchanged. Other values are linear multipliers on the effect. Values of amount over 1 are allowed, providing super-saturated results

Saturate(IImageProcessingContext, float, Rectangle)

Alters the saturation component of the image.

public static IImageProcessingContext Saturate(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 is completely un-saturated. A value of 1 leaves the input unchanged. Other values are linear multipliers on the effect. Values of amount over 1 are allowed, providing super-saturated results