Class SaturateExtensions

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

Inheritance

object

SaturateExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Processing

Assembly: SixLabors.ImageSharp.dll

Syntax

public static class SaturateExtensions

Methods

Saturate(IImageProcessingContext, float)

Alters the saturation component of the image.

Declaration

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

Parameters

Type	Name	Description
IImageProcessingContext	source	The current image processing context.
float	amount	The proportion of the conversion. Must be greater than or equal to 0.

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
IImageProcessingContext	source	The current image processing context.
float	amount	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

Type	Description
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