Skip to content

Files

Latest commit

 

History

History
68 lines (44 loc) · 2.57 KB

index.md

File metadata and controls

68 lines (44 loc) · 2.57 KB

Introduction

What is ImageSharp?

ImageSharp is a modern, fully featured, fully managed, cross-platform, 2D graphics library. Designed to simplify image processing, ImageSharp brings you an incredibly powerful yet beautifully simple API.

ImageSharp 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 operations.

Built against .NET 6, ImageSharp can be used in device, cloud, and embedded/IoT scenarios.

License

ImageSharp 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 is installed via NuGet with nightly builds available on MyGet.

PM > Install-Package SixLabors.ImageSharp -Version VERSION_NUMBER
dotnet add package SixLabors.ImageSharp --version VERSION_NUMBER
<PackageReference Include="SixLabors.ImageSharp" Version="VERSION_NUMBER" />
paket add SixLabors.ImageSharp --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, 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>