Class FormatWebProcessor
Allows the changing of image formats.
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Web.Processors
Assembly: SixLabors.ImageSharp.Web.dll
Syntax
public class FormatWebProcessor : IImageWebProcessor
Constructors
| Edit this page View SourceFormatWebProcessor(IOptions<ImageSharpMiddlewareOptions>)
Initializes a new instance of the FormatWebProcessor class.
Declaration
public FormatWebProcessor(IOptions<ImageSharpMiddlewareOptions> options)
Parameters
Type | Name | Description |
---|---|---|
IOptions<ImageSharpMiddlewareOptions> | options | The middleware configuration options. |
Fields
| Edit this page View SourceFormat
The command constant for format.
Declaration
public const string Format = "format"
Field Value
Type | Description |
---|---|
string |
Properties
| Edit this page View SourceCommands
Gets the collection of recognized command keys.
Declaration
public IEnumerable<string> Commands { get; }
Property Value
Type | Description |
---|---|
IEnumerable<string> |
Methods
| Edit this page View SourceProcess(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. |