Class BackgroundColorWebProcessor

Allows setting of the background color.

public class BackgroundColorWebProcessor : IImageWebProcessor

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

The command for changing the background color.

public const string Color = "bgcolor"

Gets the collection of recognized command keys.

public IEnumerable<string> Commands { get; }

Processes the image based on the given commands.

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

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 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)

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.

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