Class BackgroundColorWebProcessor

Allows setting of the background color.

Inheritance

object

BackgroundColorWebProcessor

Implements

IImageWebProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Web.Processors

Assembly: SixLabors.ImageSharp.Web.dll

Syntax

public class BackgroundColorWebProcessor : IImageWebProcessor

Fields

Color

The command for changing the background color.

Declaration

public const string Color = "bgcolor"

Field Value

Type	Description
string

Properties

Commands

Gets the collection of recognized command keys.

Declaration

public IEnumerable<string> Commands { get; }

Property Value

Type	Description
IEnumerable<string>

Methods

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

Processes the image based on the given commands.

Declaration

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

Parameters

Type	Name	Description
FormattedImage	image	The image to process.
ILogger	logger	The type used for performing logging.
CommandCollection	commands	The ordered collection containing the processing commands.
CommandParser	parser	The command parser use for parting commands.
CultureInfo	culture	The CultureInfo to use as the current parsing culture.

Returns

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

Declaration

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

Parameters

Type	Name	Description
CommandCollection	commands	The ordered collection containing the processing commands.
CommandParser	parser	The command parser use for parting commands.
CultureInfo	culture	The CultureInfo to use as the current parsing culture.

Returns

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

Implements

IImageWebProcessor