Introduction

What is ImageSharp.Web?

ImageSharp.Web is a high performance ASP.NET 6 Middleware built on top of ImageSharp that allows the processing and caching of image requests via a simple API.

ImageSharp.Web is designed from the ground up to be flexible and extensible. The library provides API endpoints for common image processing operations and the building blocks to allow for the development of additional extensions to add image sources, caching mechanisms or even your own processing API.

License

ImageSharp.Web is licensed under the terms of the Six Labors Split License, Version 1.0. See https://sixlabors.com/pricing for commercial licensing details.

Installation

ImageSharp.Web is installed via NuGet with nightly builds available on MyGet.

• Package Manager
• .NET CLI
• PackageReference
• Paket CLI

PM > Install-Package SixLabors.ImageSharp.Web -Version VERSION_NUMBER

Warning

Prerelease versions installed via the Visual Studio NuGet Package Manager require the "include prerelease" checkbox to be checked.

Implicit Usings

The UseImageSharp property controls whether implicit global using directives for ImageSharp are included in your C# project. This feature is available in projects targeting .NET 6 or later with C# 10 or later.

When enabled, a predefined set of global using directives for common ImageSharp namespaces (such as SixLabors.ImageSharp, SixLabors.ImageSharp.Processing, SixLabors.ImageSharp.Web etc.) is automatically added to the compilation. This eliminates the need to manually add using statements in every file.

To enable implicit ImageSharp usings, set the property in your project file:

<PropertyGroup>
  <UseImageSharp>true</UseImageSharp>
</PropertyGroup>

To disable the feature, either remove the property or set it to false:

<PropertyGroup>
  <UseImageSharp>false</UseImageSharp>
</PropertyGroup>