From f4e497de5a322efe9db633c4ec3f1780739b8249 Mon Sep 17 00:00:00 2001 From: Anton Firszov Date: Sun, 5 May 2019 22:13:29 +0200 Subject: [PATCH] Fix docs for processing extensions --- .../Processing/AutoOrientExtensions.cs | 3 ++- .../Processing/BackgroundColorExtensions.cs | 3 ++- .../Processing/BinaryDiffuseExtensions.cs | 11 ++++---- .../Processing/BinaryDitherExtensions.cs | 11 ++++---- .../Processing/BinaryThresholdExtensions.cs | 11 ++++---- .../Processing/BlackWhiteExtensions.cs | 7 ++--- .../Processing/BoxBlurExtensions.cs | 9 ++++--- .../Processing/BrightnessExtensions.cs | 7 ++--- .../Processing/ColorBlindnessExtensions.cs | 8 +++--- .../Processing/ContrastExtensions.cs | 8 +++--- src/ImageSharp/Processing/CropExtensions.cs | 7 ++--- .../Processing/DetectEdgesExtensions.cs | 16 +++++------ .../Processing/DiffuseExtensions.cs | 15 ++++++----- src/ImageSharp/Processing/DitherExtensions.cs | 13 ++++----- .../Processing/EntropyCropExtensions.cs | 7 ++--- src/ImageSharp/Processing/FilterExtensions.cs | 7 ++--- src/ImageSharp/Processing/FlipExtensions.cs | 5 ++-- .../Processing/GaussianBlurExtensions.cs | 9 ++++--- .../Processing/GaussianSharpenExtensions.cs | 9 ++++--- src/ImageSharp/Processing/GlowExtensions.cs | 27 ++++++++++--------- .../Processing/GrayscaleExtensions.cs | 3 ++- .../HistogramEqualizationExtension.cs | 6 ++--- src/ImageSharp/Processing/HueExtensions.cs | 7 ++--- src/ImageSharp/Processing/InvertExtensions.cs | 7 ++--- .../Processing/KodachromeExtensions.cs | 7 ++--- .../Processing/LomographExtensions.cs | 7 ++--- .../Processing/OilPaintExtensions.cs | 11 ++++---- .../Processing/OpacityExtensions.cs | 7 ++--- src/ImageSharp/Processing/PadExtensions.cs | 5 ++-- .../Processing/PixelateExtensions.cs | 9 ++++--- .../Processing/PolaroidExtensions.cs | 7 ++--- .../Processing/QuantizeExtensions.cs | 7 ++--- src/ImageSharp/Processing/ResizeExtensions.cs | 23 ++++++++-------- src/ImageSharp/Processing/RotateExtensions.cs | 9 ++++--- .../Processing/RotateFlipExtensions.cs | 5 ++-- .../Processing/SaturateExtensions.cs | 7 ++--- src/ImageSharp/Processing/SepiaExtensions.cs | 11 ++++---- src/ImageSharp/Processing/SkewExtensions.cs | 7 ++--- .../Processing/TransformExtensions.cs | 17 ++++++------ .../Processing/VignetteExtensions.cs | 23 ++++++++-------- 40 files changed, 207 insertions(+), 171 deletions(-) diff --git a/src/ImageSharp/Processing/AutoOrientExtensions.cs b/src/ImageSharp/Processing/AutoOrientExtensions.cs index d11fc9623..d065d4583 100644 --- a/src/ImageSharp/Processing/AutoOrientExtensions.cs +++ b/src/ImageSharp/Processing/AutoOrientExtensions.cs @@ -7,7 +7,8 @@ using SixLabors.ImageSharp.Processing.Processors.Transforms; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of auto-orientation operations to the type. + /// Defines extensions that allow the application of auto-orientation operations to an + /// using Mutate/Clone. /// public static class AutoOrientExtensions { diff --git a/src/ImageSharp/Processing/BackgroundColorExtensions.cs b/src/ImageSharp/Processing/BackgroundColorExtensions.cs index 1ad2c9237..3b794e335 100644 --- a/src/ImageSharp/Processing/BackgroundColorExtensions.cs +++ b/src/ImageSharp/Processing/BackgroundColorExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of a background color to the type. + /// Defines extension methods to replace the background color of an + /// using Mutate/Clone. /// public static class BackgroundColorExtensions { diff --git a/src/ImageSharp/Processing/BinaryDiffuseExtensions.cs b/src/ImageSharp/Processing/BinaryDiffuseExtensions.cs index 788942dde..487b64e1c 100644 --- a/src/ImageSharp/Processing/BinaryDiffuseExtensions.cs +++ b/src/ImageSharp/Processing/BinaryDiffuseExtensions.cs @@ -9,7 +9,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds binary diffusion extensions to the type. + /// Defines extension methods to apply binary diffusion on an + /// using Mutate/Clone. /// public static class BinaryDiffuseExtensions { @@ -20,7 +21,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The diffusion algorithm to apply. /// The threshold to apply binarization of the image. Must be between 0 and 1. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDiffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryErrorDiffusionProcessor(diffuser, threshold)); @@ -35,7 +36,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDiffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryErrorDiffusionProcessor(diffuser, threshold), rectangle); @@ -49,7 +50,7 @@ namespace SixLabors.ImageSharp.Processing /// The threshold to apply binarization of the image. Must be between 0 and 1. /// The color to use for pixels that are above the threshold. /// The color to use for pixels that are below the threshold - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDiffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold, TPixel upperColor, TPixel lowerColor) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryErrorDiffusionProcessor(diffuser, threshold, upperColor, lowerColor)); @@ -66,7 +67,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDiffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold, TPixel upperColor, TPixel lowerColor, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryErrorDiffusionProcessor(diffuser, threshold, upperColor, lowerColor), rectangle); diff --git a/src/ImageSharp/Processing/BinaryDitherExtensions.cs b/src/ImageSharp/Processing/BinaryDitherExtensions.cs index 617770196..d8843dafa 100644 --- a/src/ImageSharp/Processing/BinaryDitherExtensions.cs +++ b/src/ImageSharp/Processing/BinaryDitherExtensions.cs @@ -9,7 +9,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds binary dithering extensions to the type. + /// Defines extensions to apply binary dithering on an + /// using Mutate/Clone. /// public static class BinaryDitherExtensions { @@ -19,7 +20,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The ordered ditherer. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDither(this IImageProcessingContext source, IOrderedDither dither) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryOrderedDitherProcessor(dither)); @@ -32,7 +33,7 @@ namespace SixLabors.ImageSharp.Processing /// The ordered ditherer. /// The color to use for pixels that are above the threshold. /// The color to use for pixels that are below the threshold - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDither(this IImageProcessingContext source, IOrderedDither dither, TPixel upperColor, TPixel lowerColor) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryOrderedDitherProcessor(dither, upperColor, lowerColor)); @@ -46,7 +47,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDither(this IImageProcessingContext source, IOrderedDither dither, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryOrderedDitherProcessor(dither), rectangle); @@ -62,7 +63,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryDither(this IImageProcessingContext source, IOrderedDither dither, TPixel upperColor, TPixel lowerColor, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryOrderedDitherProcessor(dither, upperColor, lowerColor), rectangle); diff --git a/src/ImageSharp/Processing/BinaryThresholdExtensions.cs b/src/ImageSharp/Processing/BinaryThresholdExtensions.cs index 31f81ba4b..aecb78484 100644 --- a/src/ImageSharp/Processing/BinaryThresholdExtensions.cs +++ b/src/ImageSharp/Processing/BinaryThresholdExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds binary thresholding extensions to the type. + /// Defines extension methods to apply binary thresholding on an + /// using Mutate/Clone. /// public static class BinaryThresholdExtensions { @@ -18,7 +19,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The threshold to apply binarization of the image. Must be between 0 and 1. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryThreshold(this IImageProcessingContext source, float threshold) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryThresholdProcessor(threshold)); @@ -32,7 +33,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryThreshold(this IImageProcessingContext source, float threshold, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryThresholdProcessor(threshold), rectangle); @@ -45,7 +46,7 @@ namespace SixLabors.ImageSharp.Processing /// The threshold to apply binarization of the image. Must be between 0 and 1. /// The color to use for pixels that are above the threshold. /// The color to use for pixels that are below the threshold - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryThreshold(this IImageProcessingContext source, float threshold, TPixel upperColor, TPixel lowerColor) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryThresholdProcessor(threshold, upperColor, lowerColor)); @@ -61,7 +62,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BinaryThreshold(this IImageProcessingContext source, float threshold, TPixel upperColor, TPixel lowerColor, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new BinaryThresholdProcessor(threshold, upperColor, lowerColor), rectangle); diff --git a/src/ImageSharp/Processing/BlackWhiteExtensions.cs b/src/ImageSharp/Processing/BlackWhiteExtensions.cs index 5dc2341e5..ee34cd99e 100644 --- a/src/ImageSharp/Processing/BlackWhiteExtensions.cs +++ b/src/ImageSharp/Processing/BlackWhiteExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of black and white toning to the type. + /// Defines extension methods that allow the application of black and white toning to an + /// using Mutate/Clone. /// public static class BlackWhiteExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Applies black and white toning to the image. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BlackWhite(this IImageProcessingContext source) => source.ApplyProcessor(new BlackWhiteProcessor()); @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BlackWhite(this IImageProcessingContext source, Rectangle rectangle) => source.ApplyProcessor(new BlackWhiteProcessor(), rectangle); } diff --git a/src/ImageSharp/Processing/BoxBlurExtensions.cs b/src/ImageSharp/Processing/BoxBlurExtensions.cs index bc6e06dd6..f3400c24e 100644 --- a/src/ImageSharp/Processing/BoxBlurExtensions.cs +++ b/src/ImageSharp/Processing/BoxBlurExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds box blurring extensions to the type. + /// Defines extensions methods to apply box blurring to an + /// using Mutate/Clone. /// public static class BoxBlurExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Applies a box blur to the image. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BoxBlur(this IImageProcessingContext source) => source.ApplyProcessor(new BoxBlurProcessor()); @@ -25,7 +26,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The 'radius' value representing the size of the area to sample. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BoxBlur(this IImageProcessingContext source, int radius) => source.ApplyProcessor(new BoxBlurProcessor(radius)); @@ -37,7 +38,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext BoxBlur(this IImageProcessingContext source, int radius, Rectangle rectangle) => source.ApplyProcessor(new BoxBlurProcessor(radius), rectangle); } diff --git a/src/ImageSharp/Processing/BrightnessExtensions.cs b/src/ImageSharp/Processing/BrightnessExtensions.cs index 4de4dc897..db8409176 100644 --- a/src/ImageSharp/Processing/BrightnessExtensions.cs +++ b/src/ImageSharp/Processing/BrightnessExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the alteration of the brightness component to the type. + /// Defines extensions that allow the alteration of the brightness component of an + /// using Mutate/Clone. /// public static class BrightnessExtensions { @@ -21,7 +22,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The proportion of the conversion. Must be greater than or equal to 0. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Brightness(this IImageProcessingContext source, float amount) => source.ApplyProcessor(new BrightnessProcessor(amount)); @@ -37,7 +38,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Brightness(this IImageProcessingContext source, float amount, Rectangle rectangle) => source.ApplyProcessor(new BrightnessProcessor(amount), rectangle); } diff --git a/src/ImageSharp/Processing/ColorBlindnessExtensions.cs b/src/ImageSharp/Processing/ColorBlindnessExtensions.cs index 000d47bd3..b8d503955 100644 --- a/src/ImageSharp/Processing/ColorBlindnessExtensions.cs +++ b/src/ImageSharp/Processing/ColorBlindnessExtensions.cs @@ -1,7 +1,6 @@ // Copyright (c) Six Labors and contributors. // Licensed under the Apache License, Version 2.0. -using SixLabors.ImageSharp.PixelFormats; using SixLabors.ImageSharp.Processing.Processors; using SixLabors.ImageSharp.Processing.Processors.Filters; using SixLabors.Primitives; @@ -9,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that simulate the effects of various color blindness disorders to the type. + /// Defines extensions that simulate the effects of various color blindness disorders on an + /// using Mutate/Clone. /// public static class ColorBlindnessExtensions { @@ -18,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The type of color blindness simulator to apply. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext ColorBlindness(this IImageProcessingContext source, ColorBlindnessMode colorBlindness) => source.ApplyProcessor(GetProcessor(colorBlindness)); @@ -30,7 +30,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext ColorBlindness(this IImageProcessingContext source, ColorBlindnessMode colorBlindnessMode, Rectangle rectangle) => source.ApplyProcessor(GetProcessor(colorBlindnessMode), rectangle); diff --git a/src/ImageSharp/Processing/ContrastExtensions.cs b/src/ImageSharp/Processing/ContrastExtensions.cs index b03844d93..bdfd7c98a 100644 --- a/src/ImageSharp/Processing/ContrastExtensions.cs +++ b/src/ImageSharp/Processing/ContrastExtensions.cs @@ -1,14 +1,14 @@ // Copyright (c) Six Labors and contributors. // Licensed under the Apache License, Version 2.0. -using SixLabors.ImageSharp.PixelFormats; using SixLabors.ImageSharp.Processing.Processors.Filters; using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the alteration of the contrast component to the type. + /// Defines extensions that allow the alteration of the contrast component of an + /// using Mutate/Clone. /// public static class ContrastExtensions { @@ -21,7 +21,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The proportion of the conversion. Must be greater than or equal to 0. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Contrast(this IImageProcessingContext source, float amount) => source.ApplyProcessor(new ContrastProcessor(amount)); @@ -37,7 +37,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Contrast(this IImageProcessingContext source, float amount, Rectangle rectangle) => source.ApplyProcessor(new ContrastProcessor(amount), rectangle); } diff --git a/src/ImageSharp/Processing/CropExtensions.cs b/src/ImageSharp/Processing/CropExtensions.cs index 6aaff5656..7ec85169e 100644 --- a/src/ImageSharp/Processing/CropExtensions.cs +++ b/src/ImageSharp/Processing/CropExtensions.cs @@ -7,7 +7,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of cropping operations to the type. + /// Defines extensions that allow the application of cropping operations on an + /// using Mutate/Clone. /// public static class CropExtensions { @@ -17,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing /// The image to resize. /// The target image width. /// The target image height. - /// The + /// The to allow chaining of operations. public static IImageProcessingContext Crop(this IImageProcessingContext source, int width, int height) => Crop(source, new Rectangle(0, 0, width, height)); @@ -28,7 +29,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to retain. /// - /// The + /// The to allow chaining of operations. public static IImageProcessingContext Crop(this IImageProcessingContext source, Rectangle cropRectangle) => source.ApplyProcessor(new CropProcessor(cropRectangle, source.GetCurrentSize())); } diff --git a/src/ImageSharp/Processing/DetectEdgesExtensions.cs b/src/ImageSharp/Processing/DetectEdgesExtensions.cs index 7527d601d..837b26910 100644 --- a/src/ImageSharp/Processing/DetectEdgesExtensions.cs +++ b/src/ImageSharp/Processing/DetectEdgesExtensions.cs @@ -8,7 +8,7 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds edge detection extensions to the type. + /// Defines edge detection extensions applicable on an using Mutate/Clone. /// public static class DetectEdgesExtensions { @@ -17,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// operating in grayscale mode. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext DetectEdges(this IImageProcessingContext source) => DetectEdges(source, new SobelProcessor(true)); @@ -29,7 +29,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext DetectEdges(this IImageProcessingContext source, Rectangle rectangle) => DetectEdges(source, rectangle, new SobelProcessor(true)); @@ -38,7 +38,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The filter for detecting edges. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext DetectEdges( this IImageProcessingContext source, EdgeDetectionOperators filter) => @@ -50,7 +50,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The filter for detecting edges. /// Whether to convert the image to grayscale first. Defaults to true. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext DetectEdges( this IImageProcessingContext source, EdgeDetectionOperators filter, @@ -66,7 +66,7 @@ namespace SixLabors.ImageSharp.Processing /// The structure that specifies the portion of the image object to alter. /// /// Whether to convert the image to grayscale first. Defaults to true. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext DetectEdges( this IImageProcessingContext source, EdgeDetectionOperators filter, @@ -79,7 +79,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The filter for detecting edges. - /// The . + /// The to allow chaining of operations. private static IImageProcessingContext DetectEdges(this IImageProcessingContext source, IImageProcessor filter) { return source.ApplyProcessor(filter); @@ -93,7 +93,7 @@ namespace SixLabors.ImageSharp.Processing /// The structure that specifies the portion of the image object to alter. /// /// The filter for detecting edges. - /// The . + /// The to allow chaining of operations. private static IImageProcessingContext DetectEdges( this IImageProcessingContext source, Rectangle rectangle, diff --git a/src/ImageSharp/Processing/DiffuseExtensions.cs b/src/ImageSharp/Processing/DiffuseExtensions.cs index 768d28116..4668363e9 100644 --- a/src/ImageSharp/Processing/DiffuseExtensions.cs +++ b/src/ImageSharp/Processing/DiffuseExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing.Dithering { /// - /// Adds diffusion extensions to the type. + /// Defines extension methods to apply diffusion to an + /// using Mutate/Clone. /// public static class DiffuseExtensions { @@ -17,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing.Dithering /// /// The pixel format. /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Diffuse(this IImageProcessingContext source) where TPixel : struct, IPixel => Diffuse(source, KnownDiffusers.FloydSteinberg, .5F); @@ -28,7 +29,7 @@ namespace SixLabors.ImageSharp.Processing.Dithering /// The pixel format. /// The image this method extends. /// The threshold to apply binarization of the image. Must be between 0 and 1. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Diffuse(this IImageProcessingContext source, float threshold) where TPixel : struct, IPixel => Diffuse(source, KnownDiffusers.FloydSteinberg, threshold); @@ -40,7 +41,7 @@ namespace SixLabors.ImageSharp.Processing.Dithering /// The image this method extends. /// The diffusion algorithm to apply. /// The threshold to apply binarization of the image. Must be between 0 and 1. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Diffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold) where TPixel : struct, IPixel => source.ApplyProcessor(new ErrorDiffusionPaletteProcessor(diffuser, threshold)); @@ -55,7 +56,7 @@ namespace SixLabors.ImageSharp.Processing.Dithering /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Diffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new ErrorDiffusionPaletteProcessor(diffuser, threshold), rectangle); @@ -68,7 +69,7 @@ namespace SixLabors.ImageSharp.Processing.Dithering /// The diffusion algorithm to apply. /// The threshold to apply binarization of the image. Must be between 0 and 1. /// The palette to select substitute colors from. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Diffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold, TPixel[] palette) where TPixel : struct, IPixel => source.ApplyProcessor(new ErrorDiffusionPaletteProcessor(diffuser, threshold, palette)); @@ -84,7 +85,7 @@ namespace SixLabors.ImageSharp.Processing.Dithering /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Diffuse(this IImageProcessingContext source, IErrorDiffuser diffuser, float threshold, TPixel[] palette, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new ErrorDiffusionPaletteProcessor(diffuser, threshold, palette), rectangle); diff --git a/src/ImageSharp/Processing/DitherExtensions.cs b/src/ImageSharp/Processing/DitherExtensions.cs index 795561e70..aeb975d1c 100644 --- a/src/ImageSharp/Processing/DitherExtensions.cs +++ b/src/ImageSharp/Processing/DitherExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds dithering extensions to the type. + /// Defines dithering extensions to apply on an + /// using Mutate/Clone. /// public static class DitherExtensions { @@ -17,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The pixel format. /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Dither(this IImageProcessingContext source) where TPixel : struct, IPixel => Dither(source, KnownDitherers.BayerDither4x4); @@ -28,7 +29,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The ordered ditherer. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Dither(this IImageProcessingContext source, IOrderedDither dither) where TPixel : struct, IPixel => source.ApplyProcessor(new OrderedDitherPaletteProcessor(dither)); @@ -40,7 +41,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The ordered ditherer. /// The palette to select substitute colors from. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Dither(this IImageProcessingContext source, IOrderedDither dither, TPixel[] palette) where TPixel : struct, IPixel => source.ApplyProcessor(new OrderedDitherPaletteProcessor(dither, palette)); @@ -54,7 +55,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Dither(this IImageProcessingContext source, IOrderedDither dither, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new OrderedDitherPaletteProcessor(dither), rectangle); @@ -69,7 +70,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Dither(this IImageProcessingContext source, IOrderedDither dither, TPixel[] palette, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new OrderedDitherPaletteProcessor(dither, palette), rectangle); diff --git a/src/ImageSharp/Processing/EntropyCropExtensions.cs b/src/ImageSharp/Processing/EntropyCropExtensions.cs index 34bc5daeb..de5296d83 100644 --- a/src/ImageSharp/Processing/EntropyCropExtensions.cs +++ b/src/ImageSharp/Processing/EntropyCropExtensions.cs @@ -6,7 +6,8 @@ using SixLabors.ImageSharp.Processing.Processors.Transforms; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of entropy cropping operations to the type. + /// Defines extensions that allow the application of entropy cropping operations on an + /// using Mutate/Clone. /// public static class EntropyCropExtensions { @@ -14,7 +15,7 @@ namespace SixLabors.ImageSharp.Processing /// Crops an image to the area of greatest entropy using a threshold for entropic density of .5F. /// /// The image to crop. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext EntropyCrop(this IImageProcessingContext source) => source.ApplyProcessor(new EntropyCropProcessor()); @@ -23,7 +24,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image to crop. /// The threshold for entropic density. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext EntropyCrop(this IImageProcessingContext source, float threshold) => source.ApplyProcessor(new EntropyCropProcessor(threshold)); } diff --git a/src/ImageSharp/Processing/FilterExtensions.cs b/src/ImageSharp/Processing/FilterExtensions.cs index 2a1c6bc7f..5a66502ce 100644 --- a/src/ImageSharp/Processing/FilterExtensions.cs +++ b/src/ImageSharp/Processing/FilterExtensions.cs @@ -9,7 +9,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of composable filters to the type. + /// Defines extensions that allow the application of composable filters to an + /// using Mutate/Clone. /// public static class FilterExtensions { @@ -18,7 +19,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The filter color matrix - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Filter(this IImageProcessingContext source, ColorMatrix matrix) => source.ApplyProcessor(new FilterProcessor(matrix)); @@ -30,7 +31,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Filter(this IImageProcessingContext source, ColorMatrix matrix, Rectangle rectangle) => source.ApplyProcessor(new FilterProcessor(matrix), rectangle); } diff --git a/src/ImageSharp/Processing/FlipExtensions.cs b/src/ImageSharp/Processing/FlipExtensions.cs index bc862972e..f6b3c0c37 100644 --- a/src/ImageSharp/Processing/FlipExtensions.cs +++ b/src/ImageSharp/Processing/FlipExtensions.cs @@ -6,7 +6,8 @@ using SixLabors.ImageSharp.Processing.Processors.Transforms; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of flipping operations to the type. + /// Defines extensions that allow the application of flipping operations on an + /// using Mutate/Clone. /// public static class FlipExtensions { @@ -15,7 +16,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image to rotate, flip, or both. /// The to perform the flip. - /// The + /// The to allow chaining of operations. public static IImageProcessingContext Flip(this IImageProcessingContext source, FlipMode flipMode) => source.ApplyProcessor(new FlipProcessor(flipMode)); } diff --git a/src/ImageSharp/Processing/GaussianBlurExtensions.cs b/src/ImageSharp/Processing/GaussianBlurExtensions.cs index 1dab05457..e527a14b7 100644 --- a/src/ImageSharp/Processing/GaussianBlurExtensions.cs +++ b/src/ImageSharp/Processing/GaussianBlurExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds Gaussian blurring extensions to the type. + /// Defines Gaussian blurring extensions to apply on an + /// using Mutate/Clone. /// public static class GaussianBlurExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Applies a Gaussian blur to the image. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext GaussianBlur(this IImageProcessingContext source) => source.ApplyProcessor(new GaussianBlurProcessor()); @@ -25,7 +26,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The 'sigma' value representing the weight of the blur. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext GaussianBlur(this IImageProcessingContext source, float sigma) => source.ApplyProcessor(new GaussianBlurProcessor(sigma)); @@ -37,7 +38,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext GaussianBlur(this IImageProcessingContext source, float sigma, Rectangle rectangle) => source.ApplyProcessor(new GaussianBlurProcessor(sigma), rectangle); } diff --git a/src/ImageSharp/Processing/GaussianSharpenExtensions.cs b/src/ImageSharp/Processing/GaussianSharpenExtensions.cs index 64aa7b5db..79f4a0cc3 100644 --- a/src/ImageSharp/Processing/GaussianSharpenExtensions.cs +++ b/src/ImageSharp/Processing/GaussianSharpenExtensions.cs @@ -7,7 +7,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds Gaussian sharpening extensions to the type. + /// Defines Gaussian sharpening extensions to apply on an + /// using Mutate/Clone. /// public static class GaussianSharpenExtensions { @@ -15,7 +16,7 @@ namespace SixLabors.ImageSharp.Processing /// Applies a Gaussian sharpening filter to the image. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext GaussianSharpen(this IImageProcessingContext source) => source.ApplyProcessor(new GaussianSharpenProcessor()); @@ -24,7 +25,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The 'sigma' value representing the weight of the blur. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext GaussianSharpen(this IImageProcessingContext source, float sigma) => source.ApplyProcessor(new GaussianSharpenProcessor(sigma)); @@ -36,7 +37,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext GaussianSharpen( this IImageProcessingContext source, float sigma, diff --git a/src/ImageSharp/Processing/GlowExtensions.cs b/src/ImageSharp/Processing/GlowExtensions.cs index 8b6e8ffc2..759fdccbe 100644 --- a/src/ImageSharp/Processing/GlowExtensions.cs +++ b/src/ImageSharp/Processing/GlowExtensions.cs @@ -9,7 +9,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of a radial glow to the type. + /// Defines extensions that allow the application of a radial glow on an + /// using Mutate/Clone. /// public static class GlowExtensions { @@ -18,7 +19,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The pixel format. /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source) where TPixel : struct, IPixel => Glow(source, GraphicsOptions.Default); @@ -29,7 +30,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The color to set as the glow. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, TPixel color) where TPixel : struct, IPixel { @@ -42,7 +43,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The the radius. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, float radius) where TPixel : struct, IPixel => Glow(source, GraphicsOptions.Default, radius); @@ -55,7 +56,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, Rectangle rectangle) where TPixel : struct, IPixel => source.Glow(GraphicsOptions.Default, rectangle); @@ -70,7 +71,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, TPixel color, float radius, Rectangle rectangle) where TPixel : struct, IPixel => source.Glow(GraphicsOptions.Default, color, ValueSize.Absolute(radius), rectangle); @@ -81,7 +82,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The options effecting things like blending. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, GraphicsOptions options) where TPixel : struct, IPixel => source.Glow(options, NamedColors.Black, ValueSize.PercentageOfWidth(0.5f)); @@ -93,7 +94,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The options effecting things like blending. /// The color to set as the glow. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, GraphicsOptions options, TPixel color) where TPixel : struct, IPixel => source.Glow(options, color, ValueSize.PercentageOfWidth(0.5f)); @@ -105,7 +106,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The options effecting things like blending. /// The the radius. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, GraphicsOptions options, float radius) where TPixel : struct, IPixel => source.Glow(options, NamedColors.Black, ValueSize.Absolute(radius)); @@ -119,7 +120,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, GraphicsOptions options, Rectangle rectangle) where TPixel : struct, IPixel => source.Glow(options, NamedColors.Black, ValueSize.PercentageOfWidth(0.5f), rectangle); @@ -135,7 +136,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Glow(this IImageProcessingContext source, GraphicsOptions options, TPixel color, float radius, Rectangle rectangle) where TPixel : struct, IPixel => source.Glow(options, color, ValueSize.Absolute(radius), rectangle); @@ -151,7 +152,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. private static IImageProcessingContext Glow(this IImageProcessingContext source, GraphicsOptions options, TPixel color, ValueSize radius, Rectangle rectangle) where TPixel : struct, IPixel => source.ApplyProcessor(new GlowProcessor(color, radius, options), rectangle); @@ -164,7 +165,7 @@ namespace SixLabors.ImageSharp.Processing /// The options effecting things like blending. /// The color to set as the glow. /// The the radius. - /// The . + /// The to allow chaining of operations. private static IImageProcessingContext Glow(this IImageProcessingContext source, GraphicsOptions options, TPixel color, ValueSize radius) where TPixel : struct, IPixel => source.ApplyProcessor(new GlowProcessor(color, radius, options)); diff --git a/src/ImageSharp/Processing/GrayscaleExtensions.cs b/src/ImageSharp/Processing/GrayscaleExtensions.cs index d68a385e4..a87341025 100644 --- a/src/ImageSharp/Processing/GrayscaleExtensions.cs +++ b/src/ImageSharp/Processing/GrayscaleExtensions.cs @@ -9,7 +9,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of grayscale toning to the type. + /// Defines extensions that allow the application of grayscale toning to an + /// using Mutate/Clone. /// public static class GrayscaleExtensions { diff --git a/src/ImageSharp/Processing/HistogramEqualizationExtension.cs b/src/ImageSharp/Processing/HistogramEqualizationExtension.cs index aae3e997f..01c14fc09 100644 --- a/src/ImageSharp/Processing/HistogramEqualizationExtension.cs +++ b/src/ImageSharp/Processing/HistogramEqualizationExtension.cs @@ -6,7 +6,7 @@ using SixLabors.ImageSharp.Processing.Processors.Normalization; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extension that allow the adjustment of the contrast of an image via its histogram. + /// Defines extension that allow the adjustment of the contrast of an image via its histogram. /// public static class HistogramEqualizationExtension { @@ -14,7 +14,7 @@ namespace SixLabors.ImageSharp.Processing /// Equalizes the histogram of an image to increases the contrast. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext HistogramEqualization(this IImageProcessingContext source) => HistogramEqualization(source, HistogramEqualizationOptions.Default); @@ -23,7 +23,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The histogram equalization options to use. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext HistogramEqualization( this IImageProcessingContext source, HistogramEqualizationOptions options) => diff --git a/src/ImageSharp/Processing/HueExtensions.cs b/src/ImageSharp/Processing/HueExtensions.cs index 17296e1db..3c1239da6 100644 --- a/src/ImageSharp/Processing/HueExtensions.cs +++ b/src/ImageSharp/Processing/HueExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the alteration of the hue component to the type. + /// Defines extensions that allow the alteration of the hue component of an + /// using Mutate/Clone. /// public static class HueExtensions { @@ -17,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The rotation angle in degrees to adjust the hue. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Hue(this IImageProcessingContext source, float degrees) => source.ApplyProcessor(new HueProcessor(degrees)); @@ -29,7 +30,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Hue(this IImageProcessingContext source, float degrees, Rectangle rectangle) => source.ApplyProcessor(new HueProcessor(degrees), rectangle); } diff --git a/src/ImageSharp/Processing/InvertExtensions.cs b/src/ImageSharp/Processing/InvertExtensions.cs index 828aaa1bb..c45f24c2e 100644 --- a/src/ImageSharp/Processing/InvertExtensions.cs +++ b/src/ImageSharp/Processing/InvertExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the inversion of colors to the type. + /// Defines extensions that allow the inversion of colors of an + /// using Mutate/Clone. /// public static class InvertExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Inverts the colors of the image. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Invert(this IImageProcessingContext source) => source.ApplyProcessor(new InvertProcessor(1F)); @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Invert(this IImageProcessingContext source, Rectangle rectangle) => source.ApplyProcessor(new InvertProcessor(1F), rectangle); } diff --git a/src/ImageSharp/Processing/KodachromeExtensions.cs b/src/ImageSharp/Processing/KodachromeExtensions.cs index 24bd51e01..810094a18 100644 --- a/src/ImageSharp/Processing/KodachromeExtensions.cs +++ b/src/ImageSharp/Processing/KodachromeExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the recreation of an old Kodachrome camera effect to the type. + /// Defines extensions that allow the recreation of an old Kodachrome camera effect on an + /// using Mutate/Clone. /// public static class KodachromeExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Alters the colors of the image recreating an old Kodachrome camera effect. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Kodachrome(this IImageProcessingContext source) => source.ApplyProcessor(new KodachromeProcessor()); @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Kodachrome(this IImageProcessingContext source, Rectangle rectangle) => source.ApplyProcessor(new KodachromeProcessor(), rectangle); } diff --git a/src/ImageSharp/Processing/LomographExtensions.cs b/src/ImageSharp/Processing/LomographExtensions.cs index a3fd3d3b5..dd7ab21ec 100644 --- a/src/ImageSharp/Processing/LomographExtensions.cs +++ b/src/ImageSharp/Processing/LomographExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the recreation of an old Lomograph camera effect to the type. + /// Defines extensions that allow the recreation of an old Lomograph camera effect on an + /// using Mutate/Clone. /// public static class LomographExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Alters the colors of the image recreating an old Lomograph camera effect. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Lomograph(this IImageProcessingContext source) => source.ApplyProcessor(new LomographProcessor()); @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Lomograph(this IImageProcessingContext source, Rectangle rectangle) => source.ApplyProcessor(new LomographProcessor(), rectangle); } diff --git a/src/ImageSharp/Processing/OilPaintExtensions.cs b/src/ImageSharp/Processing/OilPaintExtensions.cs index ee51b31fa..1aa98c8c1 100644 --- a/src/ImageSharp/Processing/OilPaintExtensions.cs +++ b/src/ImageSharp/Processing/OilPaintExtensions.cs @@ -7,7 +7,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds oil painting effect extensions to the type. + /// Defines oil painting effect extensions applicable on an + /// using Mutate/Clone. /// public static class OilPaintExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// set to 10 and 15 respectively. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext OilPaint(this IImageProcessingContext source) => OilPaint(source, 10, 15); /// @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext OilPaint(this IImageProcessingContext source, Rectangle rectangle) => OilPaint(source, 10, 15, rectangle); @@ -37,7 +38,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The number of intensity levels. Higher values result in a broader range of color intensities forming part of the result image. /// The number of neighboring pixels used in calculating each individual pixel value. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext OilPaint(this IImageProcessingContext source, int levels, int brushSize) => source.ApplyProcessor(new OilPaintingProcessor(levels, brushSize)); @@ -51,7 +52,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext OilPaint( this IImageProcessingContext source, int levels, diff --git a/src/ImageSharp/Processing/OpacityExtensions.cs b/src/ImageSharp/Processing/OpacityExtensions.cs index 6d9198648..ecf6ce783 100644 --- a/src/ImageSharp/Processing/OpacityExtensions.cs +++ b/src/ImageSharp/Processing/OpacityExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the alteration of the opacity component to the type. + /// Defines extensions that allow the alteration of the opacity component of an + /// using Mutate/Clone. /// public static class OpacityExtensions { @@ -17,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The proportion of the conversion. Must be between 0 and 1. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Opacity(this IImageProcessingContext source, float amount) => source.ApplyProcessor(new OpacityProcessor(amount)); @@ -29,7 +30,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Opacity(this IImageProcessingContext source, float amount, Rectangle rectangle) => source.ApplyProcessor(new OpacityProcessor(amount), rectangle); } diff --git a/src/ImageSharp/Processing/PadExtensions.cs b/src/ImageSharp/Processing/PadExtensions.cs index 0422f7c59..29f80b43f 100644 --- a/src/ImageSharp/Processing/PadExtensions.cs +++ b/src/ImageSharp/Processing/PadExtensions.cs @@ -7,7 +7,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of padding operations to the type. + /// Defines extensions that allow the application of padding operations on an + /// using Mutate/Clone. /// public static class PadExtensions { @@ -17,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing /// The source image to pad. /// The new width. /// The new height. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Pad(this IImageProcessingContext source, int width, int height) { var options = new ResizeOptions diff --git a/src/ImageSharp/Processing/PixelateExtensions.cs b/src/ImageSharp/Processing/PixelateExtensions.cs index d9f7f9be5..bf40af91a 100644 --- a/src/ImageSharp/Processing/PixelateExtensions.cs +++ b/src/ImageSharp/Processing/PixelateExtensions.cs @@ -7,7 +7,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds pixelation effect extensions to the type. + /// Defines pixelation effect extensions applicable on an + /// using Mutate/Clone. /// public static class PixelateExtensions { @@ -15,7 +16,7 @@ namespace SixLabors.ImageSharp.Processing /// Pixelates an image with the given pixel size. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Pixelate(this IImageProcessingContext source) => Pixelate(source, 4); /// @@ -23,7 +24,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The size of the pixels. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Pixelate(this IImageProcessingContext source, int size) => source.ApplyProcessor(new PixelateProcessor(size)); @@ -35,7 +36,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Pixelate( this IImageProcessingContext source, int size, diff --git a/src/ImageSharp/Processing/PolaroidExtensions.cs b/src/ImageSharp/Processing/PolaroidExtensions.cs index 4e7841168..eace46357 100644 --- a/src/ImageSharp/Processing/PolaroidExtensions.cs +++ b/src/ImageSharp/Processing/PolaroidExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the recreation of an old Polaroid camera effect to the type. + /// Defines extensions that allow the recreation of an old Polaroid camera effect on an + /// using Mutate/Clone. /// public static class PolaroidExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Alters the colors of the image recreating an old Polaroid camera effect. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Polaroid(this IImageProcessingContext source) => source.ApplyProcessor(new PolaroidProcessor()); @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Polaroid(this IImageProcessingContext source, Rectangle rectangle) => source.ApplyProcessor(new PolaroidProcessor(), rectangle); } diff --git a/src/ImageSharp/Processing/QuantizeExtensions.cs b/src/ImageSharp/Processing/QuantizeExtensions.cs index 5bd2f49bd..ad351afa9 100644 --- a/src/ImageSharp/Processing/QuantizeExtensions.cs +++ b/src/ImageSharp/Processing/QuantizeExtensions.cs @@ -7,7 +7,8 @@ using SixLabors.ImageSharp.Processing.Processors.Quantization; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of quantizing algorithms to the type. + /// Defines extensions that allow the application of quantizing algorithms on an + /// using Mutate/Clone. /// public static class QuantizeExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The pixel format. /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Quantize(this IImageProcessingContext source) where TPixel : struct, IPixel => Quantize(source, KnownQuantizers.Octree); @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The quantizer to apply to perform the operation. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Quantize(this IImageProcessingContext source, IQuantizer quantizer) where TPixel : struct, IPixel => source.ApplyProcessor(new QuantizeProcessor(quantizer)); diff --git a/src/ImageSharp/Processing/ResizeExtensions.cs b/src/ImageSharp/Processing/ResizeExtensions.cs index 57dbcb1d1..4578b4353 100644 --- a/src/ImageSharp/Processing/ResizeExtensions.cs +++ b/src/ImageSharp/Processing/ResizeExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of resize operations to the type. + /// Defines extensions that allow the application of resize operations on an + /// using Mutate/Clone. /// public static class ResizeExtensions { @@ -17,7 +18,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image to resize. /// The resize options. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width within the resize options will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, ResizeOptions options) => source.ApplyProcessor(new ResizeProcessor(options, source.GetCurrentSize())); @@ -27,7 +28,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image to resize. /// The target image size. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, Size size) => Resize(source, size.Width, size.Height, KnownResamplers.Bicubic, false); @@ -38,7 +39,7 @@ namespace SixLabors.ImageSharp.Processing /// The image to resize. /// The target image size. /// Whether to compress and expand the image color-space to gamma correct the image during processing. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, Size size, bool compand) => Resize(source, size.Width, size.Height, KnownResamplers.Bicubic, compand); @@ -49,7 +50,7 @@ namespace SixLabors.ImageSharp.Processing /// The image to resize. /// The target image width. /// The target image height. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, int width, int height) => Resize(source, width, height, KnownResamplers.Bicubic, false); @@ -61,7 +62,7 @@ namespace SixLabors.ImageSharp.Processing /// The target image width. /// The target image height. /// Whether to compress and expand the image color-space to gamma correct the image during processing. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, int width, int height, bool compand) => Resize(source, width, height, KnownResamplers.Bicubic, compand); @@ -73,7 +74,7 @@ namespace SixLabors.ImageSharp.Processing /// The target image width. /// The target image height. /// The to perform the resampling. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, int width, int height, IResampler sampler) => Resize(source, width, height, sampler, false); @@ -85,7 +86,7 @@ namespace SixLabors.ImageSharp.Processing /// The target image size. /// The to perform the resampling. /// Whether to compress and expand the image color-space to gamma correct the image during processing. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, Size size, IResampler sampler, bool compand) => Resize(source, size.Width, size.Height, sampler, new Rectangle(0, 0, size.Width, size.Height), compand); @@ -98,7 +99,7 @@ namespace SixLabors.ImageSharp.Processing /// The target image height. /// The to perform the resampling. /// Whether to compress and expand the image color-space to gamma correct the image during processing. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize(this IImageProcessingContext source, int width, int height, IResampler sampler, bool compand) => Resize(source, width, height, sampler, new Rectangle(0, 0, width, height), compand); @@ -118,7 +119,7 @@ namespace SixLabors.ImageSharp.Processing /// The structure that specifies the portion of the target image object to draw to. /// /// Whether to compress and expand the image color-space to gamma correct the image during processing. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize( this IImageProcessingContext source, @@ -141,7 +142,7 @@ namespace SixLabors.ImageSharp.Processing /// The structure that specifies the portion of the target image object to draw to. /// /// Whether to compress and expand the image color-space to gamma correct the image during processing. - /// The + /// The to allow chaining of operations. /// Passing zero for one of height or width will automatically preserve the aspect ratio of the original image or the nearest possible ratio. public static IImageProcessingContext Resize( this IImageProcessingContext source, diff --git a/src/ImageSharp/Processing/RotateExtensions.cs b/src/ImageSharp/Processing/RotateExtensions.cs index cb637a1b8..395462ae3 100644 --- a/src/ImageSharp/Processing/RotateExtensions.cs +++ b/src/ImageSharp/Processing/RotateExtensions.cs @@ -6,7 +6,8 @@ using SixLabors.ImageSharp.Processing.Processors.Transforms; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of rotate operations to the type. + /// Defines extensions that allow the application of rotate operations on an + /// using Mutate/Clone. /// public static class RotateExtensions { @@ -15,7 +16,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image to rotate. /// The to perform the rotation. - /// The + /// The to allow chaining of operations. public static IImageProcessingContext Rotate(this IImageProcessingContext source, RotateMode rotateMode) => Rotate(source, (float)rotateMode); @@ -24,7 +25,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image to rotate. /// The angle in degrees to perform the rotation. - /// The + /// The to allow chaining of operations. public static IImageProcessingContext Rotate(this IImageProcessingContext source, float degrees) => Rotate(source, degrees, KnownResamplers.Bicubic); @@ -34,7 +35,7 @@ namespace SixLabors.ImageSharp.Processing /// The image to rotate. /// The angle in degrees to perform the rotation. /// The to perform the resampling. - /// The + /// The to allow chaining of operations. public static IImageProcessingContext Rotate( this IImageProcessingContext source, float degrees, diff --git a/src/ImageSharp/Processing/RotateFlipExtensions.cs b/src/ImageSharp/Processing/RotateFlipExtensions.cs index 5030c942e..4d5d90c30 100644 --- a/src/ImageSharp/Processing/RotateFlipExtensions.cs +++ b/src/ImageSharp/Processing/RotateFlipExtensions.cs @@ -6,7 +6,8 @@ using SixLabors.ImageSharp.PixelFormats; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of rotate-flip operations to the type. + /// Defines extensions that allow the application of rotate-flip operations on an + /// using Mutate/Clone. /// public static class RotateFlipExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// The image to rotate, flip, or both. /// The to perform the rotation. /// The to perform the flip. - /// The + /// The to allow chaining of operations. public static IImageProcessingContext RotateFlip(this IImageProcessingContext source, RotateMode rotateMode, FlipMode flipMode) => source.Rotate(rotateMode).Flip(flipMode); } diff --git a/src/ImageSharp/Processing/SaturateExtensions.cs b/src/ImageSharp/Processing/SaturateExtensions.cs index fe2cf5f34..e9ba820b6 100644 --- a/src/ImageSharp/Processing/SaturateExtensions.cs +++ b/src/ImageSharp/Processing/SaturateExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the alteration of the saturation component to the type. + /// Defines extensions that allow the alteration of the saturation component of an + /// using Mutate/Clone. /// public static class SaturateExtensions { @@ -21,7 +22,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The proportion of the conversion. Must be greater than or equal to 0. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Saturate(this IImageProcessingContext source, float amount) => source.ApplyProcessor(new SaturateProcessor(amount)); @@ -37,7 +38,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Saturate(this IImageProcessingContext source, float amount, Rectangle rectangle) => source.ApplyProcessor(new SaturateProcessor(amount), rectangle); } diff --git a/src/ImageSharp/Processing/SepiaExtensions.cs b/src/ImageSharp/Processing/SepiaExtensions.cs index 5b23ec11a..5ee5151fa 100644 --- a/src/ImageSharp/Processing/SepiaExtensions.cs +++ b/src/ImageSharp/Processing/SepiaExtensions.cs @@ -8,7 +8,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of sepia toning to the type. + /// Defines extensions that allow the application of sepia toning on an + /// using Mutate/Clone. /// public static class SepiaExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// Applies sepia toning to the image. /// /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Sepia(this IImageProcessingContext source) => Sepia(source, 1F); @@ -25,7 +26,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image this method extends. /// The proportion of the conversion. Must be between 0 and 1. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Sepia(this IImageProcessingContext source, float amount) => source.ApplyProcessor(new SepiaProcessor(amount)); @@ -36,7 +37,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Sepia(this IImageProcessingContext source, Rectangle rectangle) => Sepia(source, 1F, rectangle); @@ -48,7 +49,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Sepia(this IImageProcessingContext source, float amount, Rectangle rectangle) => source.ApplyProcessor(new SepiaProcessor(amount), rectangle); } diff --git a/src/ImageSharp/Processing/SkewExtensions.cs b/src/ImageSharp/Processing/SkewExtensions.cs index 7f378d248..77a46af0d 100644 --- a/src/ImageSharp/Processing/SkewExtensions.cs +++ b/src/ImageSharp/Processing/SkewExtensions.cs @@ -6,7 +6,8 @@ using SixLabors.ImageSharp.Processing.Processors.Transforms; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of skew operations to the type. + /// Defines extensions that allow the application of skew operations on an + /// using Mutate/Clone. /// public static class SkewExtensions { @@ -16,7 +17,7 @@ namespace SixLabors.ImageSharp.Processing /// The image to skew. /// The angle in degrees to perform the skew along the x-axis. /// The angle in degrees to perform the skew along the y-axis. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Skew(this IImageProcessingContext source, float degreesX, float degreesY) => Skew(source, degreesX, degreesY, KnownResamplers.Bicubic); @@ -28,7 +29,7 @@ namespace SixLabors.ImageSharp.Processing /// The angle in degrees to perform the skew along the x-axis. /// The angle in degrees to perform the skew along the y-axis. /// The to perform the resampling. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Skew( this IImageProcessingContext source, float degreesX, diff --git a/src/ImageSharp/Processing/TransformExtensions.cs b/src/ImageSharp/Processing/TransformExtensions.cs index 35f374d01..7fffb71d2 100644 --- a/src/ImageSharp/Processing/TransformExtensions.cs +++ b/src/ImageSharp/Processing/TransformExtensions.cs @@ -9,7 +9,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of composable transform operations to the type. + /// Defines extensions that allow the application of composable transform operations on an + /// using Mutate/Clone. /// public static class TransformExtensions { @@ -30,7 +31,7 @@ namespace SixLabors.ImageSharp.Processing /// The . /// The affine transform builder. /// The to perform the resampling. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Transform( this IImageProcessingContext ctx, AffineTransformBuilder builder, @@ -44,7 +45,7 @@ namespace SixLabors.ImageSharp.Processing /// The source rectangle /// The affine transform builder. /// The to perform the resampling. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Transform( this IImageProcessingContext ctx, Rectangle sourceRectangle, @@ -64,7 +65,7 @@ namespace SixLabors.ImageSharp.Processing /// The transformation matrix. /// The size of the result image. /// The to perform the resampling. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Transform( this IImageProcessingContext ctx, Rectangle sourceRectangle, @@ -82,7 +83,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The image to transform. /// The affine transform builder. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Transform( this IImageProcessingContext source, ProjectiveTransformBuilder builder) => @@ -94,7 +95,7 @@ namespace SixLabors.ImageSharp.Processing /// The . /// The projective transform builder. /// The to perform the resampling. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Transform( this IImageProcessingContext ctx, ProjectiveTransformBuilder builder, @@ -108,7 +109,7 @@ namespace SixLabors.ImageSharp.Processing /// The source rectangle /// The projective transform builder. /// The to perform the resampling. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Transform( this IImageProcessingContext ctx, Rectangle sourceRectangle, @@ -128,7 +129,7 @@ namespace SixLabors.ImageSharp.Processing /// The transformation matrix. /// The size of the result image. /// The to perform the resampling. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Transform( this IImageProcessingContext ctx, Rectangle sourceRectangle, diff --git a/src/ImageSharp/Processing/VignetteExtensions.cs b/src/ImageSharp/Processing/VignetteExtensions.cs index 18dd8064c..63cdee3f8 100644 --- a/src/ImageSharp/Processing/VignetteExtensions.cs +++ b/src/ImageSharp/Processing/VignetteExtensions.cs @@ -9,7 +9,8 @@ using SixLabors.Primitives; namespace SixLabors.ImageSharp.Processing { /// - /// Adds extensions that allow the application of a radial glow to the type. + /// Defines extensions that allow the application of a radial glow to an + /// using Mutate/Clone. /// public static class VignetteExtensions { @@ -18,7 +19,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The pixel format. /// The image this method extends. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source) where TPixel : struct, IPixel => Vignette(source, GraphicsOptions.Default); @@ -29,7 +30,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The color to set as the vignette. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, TPixel color) where TPixel : struct, IPixel => Vignette(source, GraphicsOptions.Default, color); @@ -41,7 +42,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The the x-radius. /// The the y-radius. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, float radiusX, float radiusY) where TPixel : struct, IPixel => Vignette(source, GraphicsOptions.Default, radiusX, radiusY); @@ -54,7 +55,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, Rectangle rectangle) where TPixel : struct, IPixel => Vignette(source, GraphicsOptions.Default, rectangle); @@ -70,7 +71,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, TPixel color, float radiusX, float radiusY, Rectangle rectangle) where TPixel : struct, IPixel => source.Vignette(GraphicsOptions.Default, color, radiusX, radiusY, rectangle); @@ -81,7 +82,7 @@ namespace SixLabors.ImageSharp.Processing /// The pixel format. /// The image this method extends. /// The options effecting pixel blending. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options) where TPixel : struct, IPixel => source.VignetteInternal(options, NamedColors.Black, ValueSize.PercentageOfWidth(.5f), ValueSize.PercentageOfHeight(.5f)); @@ -93,7 +94,7 @@ namespace SixLabors.ImageSharp.Processing /// The image this method extends. /// The options effecting pixel blending. /// The color to set as the vignette. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, TPixel color) where TPixel : struct, IPixel => source.VignetteInternal(options, color, ValueSize.PercentageOfWidth(.5f), ValueSize.PercentageOfHeight(.5f)); @@ -106,7 +107,7 @@ namespace SixLabors.ImageSharp.Processing /// The options effecting pixel blending. /// The the x-radius. /// The the y-radius. - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, float radiusX, float radiusY) where TPixel : struct, IPixel => source.VignetteInternal(options, NamedColors.Black, radiusX, radiusY); @@ -120,7 +121,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, Rectangle rectangle) where TPixel : struct, IPixel => source.VignetteInternal(options, NamedColors.Black, ValueSize.PercentageOfWidth(.5f), ValueSize.PercentageOfHeight(.5f), rectangle); @@ -137,7 +138,7 @@ namespace SixLabors.ImageSharp.Processing /// /// The structure that specifies the portion of the image object to alter. /// - /// The . + /// The to allow chaining of operations. public static IImageProcessingContext Vignette(this IImageProcessingContext source, GraphicsOptions options, TPixel color, float radiusX, float radiusY, Rectangle rectangle) where TPixel : struct, IPixel => source.VignetteInternal(options, color, radiusX, radiusY, rectangle);