Class ResizeWebProcessor

Namespace

SixLabors.ImageSharp.Web.Processors

Assembly

SixLabors.ImageSharp.Web.dll

Allows the resizing of images.

public class ResizeWebProcessor : IImageWebProcessor

Inheritance

object

ResizeWebProcessor

Implements

IImageWebProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

Anchor

The command constant for the resize anchor position.

public const string Anchor = "ranchor"

Field Value

string

Color

The command constant for the resize padding background color.

public const string Color = "rcolor"

Field Value

string

Compand

The command constant for the resize compand mode.

public const string Compand = "compand"

Field Value

string

Height

The command constant for the resize height.

public const string Height = "height"

Field Value

string

Mode

The command constant for the resize mode.

public const string Mode = "rmode"

Field Value

string

Orient

The command constant for the resize orientation handling mode.

public const string Orient = "orient"

Field Value

string

Sampler

The command constant for the resize sampler.

public const string Sampler = "rsampler"

Field Value

string

Width

The command constant for the resize width.

public const string Width = "width"

Field Value

string

Xy

The command constant for the resize focal point coordinates.

public const string Xy = "rxy"

Field Value

string

Properties

Commands

Gets the collection of recognized command keys.

public IEnumerable<string> Commands { get; }

Property Value

IEnumerable<string>

Methods

Process(FormattedImage, ILogger, CommandCollection, CommandParser, CultureInfo)

Processes the image based on the given commands.

public FormattedImage Process(FormattedImage image, ILogger logger, CommandCollection commands, CommandParser parser, CultureInfo culture)

Parameters

image FormattedImage

The image to process.

logger ILogger

The type used for performing logging.

commands CommandCollection

The ordered collection containing the processing commands.

parser CommandParser

The command parser use for parting commands.

culture CultureInfo

The CultureInfo to use as the current parsing culture.

Returns

FormattedImage

The FormattedImage.

RequiresTrueColorPixelFormat(CommandCollection, CommandParser, CultureInfo)

Returns a value indicating whether the image to be processed should be decoded using a 32 bit True Color pixel format - 8 bits per color component plus an 8 bit alpha channel https://en.wikipedia.org/wiki/Color_depth#True_color_(24-bit).

This method is used to determine whether optimizations can be enabled to reduce memory consumption during processing.

public bool RequiresTrueColorPixelFormat(CommandCollection commands, CommandParser parser, CultureInfo culture)

Parameters

commands CommandCollection

The ordered collection containing the processing commands.

parser CommandParser

The command parser use for parting commands.

culture CultureInfo

The CultureInfo to use as the current parsing culture.

Returns

bool

The bool indicating whether a 32 bit True Color pixel format is required.