mirror of https://github.com/SixLabors/ImageSharp
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
87 lines
4.0 KiB
87 lines
4.0 KiB
// <copyright file="IImageProcessor.cs" company="James Jackson-South">
|
|
// Copyright (c) James Jackson-South and contributors.
|
|
// Licensed under the Apache License, Version 2.0.
|
|
// </copyright>
|
|
|
|
using System.Threading.Tasks;
|
|
|
|
namespace ImageProcessorCore.Processors
|
|
{
|
|
/// <summary>
|
|
/// A delegate which is called as progress is made processing an image.
|
|
/// </summary>
|
|
/// <param name="sender">The source of the event.</param>
|
|
/// <param name="e">An object that contains the event data.</param>
|
|
public delegate void ProgressEventHandler(object sender, ProgressEventArgs e);
|
|
|
|
/// <summary>
|
|
/// Encapsulates methods to alter the pixels of an image.
|
|
/// </summary>
|
|
/// <typeparam name="T">The pixel format.</typeparam>
|
|
/// <typeparam name="TP">The packed format. <example>long, float.</example></typeparam>
|
|
public interface IImageProcessor<T, TP>
|
|
where T : IPackedVector<TP>
|
|
where TP : struct
|
|
{
|
|
/// <summary>
|
|
/// Event fires when each row of the source image has been processed.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This event may be called from threads other than the client thread, and from multiple threads simultaneously.
|
|
/// Individual row notifications may arrived out of order.
|
|
/// </remarks>
|
|
event ProgressEventHandler OnProgress;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the parallel options for processing tasks in parallel.
|
|
/// </summary>
|
|
ParallelOptions ParallelOptions { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets a value indicating whether to compress
|
|
/// or expand individual pixel colors the value on processing.
|
|
/// </summary>
|
|
bool Compand { get; set; }
|
|
|
|
/// <summary>
|
|
/// Applies the process to the specified portion of the specified <see cref="ImageBase{T, TP}"/>.
|
|
/// </summary>
|
|
/// <param name="target">Target image to apply the process to.</param>
|
|
/// <param name="source">The source image. Cannot be null.</param>
|
|
/// <param name="sourceRectangle">
|
|
/// The <see cref="Rectangle"/> structure that specifies the portion of the image object to draw.
|
|
/// </param>
|
|
/// <remarks>
|
|
/// The method keeps the source image unchanged and returns the
|
|
/// the result of image processing filter as new image.
|
|
/// </remarks>
|
|
/// <exception cref="System.ArgumentNullException">
|
|
/// <paramref name="target"/> is null or <paramref name="source"/> is null.
|
|
/// </exception>
|
|
/// <exception cref="System.ArgumentException">
|
|
/// <paramref name="sourceRectangle"/> doesnt fit the dimension of the image.
|
|
/// </exception>
|
|
void Apply(ImageBase<T, TP> target, ImageBase<T, TP> source, Rectangle sourceRectangle);
|
|
|
|
/// <summary>
|
|
/// Applies the process to the specified portion of the specified <see cref="ImageBase{T, TP}"/> at the specified
|
|
/// location and with the specified size.
|
|
/// </summary>
|
|
/// <param name="target">Target image to apply the process to.</param>
|
|
/// <param name="source">The source image. Cannot be null.</param>
|
|
/// <param name="width">The target width.</param>
|
|
/// <param name="height">The target height.</param>
|
|
/// <param name="targetRectangle">
|
|
/// The <see cref="Rectangle"/> structure that specifies the location and size of the drawn image.
|
|
/// The image is scaled to fit the rectangle.
|
|
/// </param>
|
|
/// <param name="sourceRectangle">
|
|
/// The <see cref="Rectangle"/> structure that specifies the portion of the image object to draw.
|
|
/// </param>
|
|
/// <remarks>
|
|
/// The method keeps the source image unchanged and returns the
|
|
/// the result of image process as new image.
|
|
/// </remarks>
|
|
void Apply(ImageBase<T, TP> target, ImageBase<T, TP> source, int width, int height, Rectangle targetRectangle, Rectangle sourceRectangle);
|
|
}
|
|
}
|
|
|