Skip to content
Permalink
main
Switch branches/tags
Go to file
2 contributors

Users who have contributed to this file

@dlemstra @coldwarrior5

Documentation

Installation

You have two options to get the Magick.NET binaries in your project:

  • Use NuGet:
    • Right click on the references of your project and choose 'Manage NuGet packages'.
    • Search for Magick.NET and choose the package that uses the platform of your choice: x86/x64 or AnyCPU.
  • Build Magick.NET yourself:
    • Instructions on how to build Magick.NET can be found here.

If you want to be able to read an AI/EPS/PDF/PS file you need to install Ghostscript.

Q8, Q16 or Q16-HDRI?

Versions with Q8 in the name are 8 bits-per-pixel component (e.g. 8-bit red, 8-bit green, etc.), whereas, Q16 are 16 bits-per-pixel component. A Q16 version permits you to read or write 16-bit images without losing precision but requires twice as much resources as the Q8 version. The Q16-HDRI version uses twice the amount of memory as the Q16. It is more precise because it uses a floating point (32 bits-per-pixel component) and it allows out-of-bound pixels (less than 0 and more than 65535). The Q8 version is the recommended version. If you need to read/write images with a better quality you should use the Q16 version instead.

AnyCPU

The AnyCPU version of Magick.NET is designed to allow your application to be used in a 32 bit or a 64 bit environment. When one of the classes in the library is used it will detect if the application pool is 32 or 64 bit. It will then read the x86 or the x64 version of the dll from an embedded resource. This resource is written to a temporary directory to improve the start up time the next it is used. You can change the directory that is used with the CacheDirectory property of the MagickAnyCPU class when the default directory is causing issues in your production environment.

MagickAnyCPU.CacheDirectory = @"C:\MyProgram\MyTempDir";

If you are planning to read RAW files you should configure the folder and copy the dcraw executable to that folder. If you don't want to do this you will need to add the folder that contains the executable to your %PATH%. More information about reading RAW files can be found here: Read raw image from camera.

.NET Standard / .NET Core

Starting with version 7.0.0.0102 support for .NET Standard was added. This used to be a separate NuGet package but starting with 7.0.6.0 this became part of the normal NuGet package. On Windows this works without any extra steps but on Linux this will require some extra work. Instructions for the cross-platform build can be found here.

ImageMagick 7

Magick.NET is linked with ImageMagick 7. Most examples on the Internet use ImageMagick 6 so there could be some minor differences in syntax. The biggest difference between 6 and 7 is that the latter uses Alpha instead of Opacity. You can find some more information about ImageMagick 7 here: https://imagemagick.org/script/porting.php.

Default memory limit

On Windows ImageMagick uses only 50% of the available memory by default for pixel cache. If the application where Magick.NET is being used is the only application that uses memory it would be wise to make that limit higher. This can be done by calling ResourceLimits.LimitMemory with the percentage of total memory that should be used. The maximum value that should be used would be around 80/90%. When ImageMagick reaches the memory limit, it will not stop functioning. Instead it will use temporary page files to compensate for the memory limit.

OpenMP

Magick.NET does not use OpenMP because the C++ Redistributable is statically linked and the OpenMP library cannot be statically linked. OpenMP is used to perform multithreaded operation on an image to increase the performance. The best use case for this would be a standalone desktop application. Starting with Magick.NET 7.0.7.700 there are extra packages for the x64 build of Magick.NET that have OpenMP support.

Ghostscript

You only need to install Ghostscript if you want to convert EPS/PDF/PS files. Make sure you only install the version of GhostScript with the same platform. If you use the 64-bit version of Magick.NET you should also install the 64-bit version of Ghostscript. You can use the 32-bit version together with the 64-version but you will get a better performance if you keep the platforms the same. Ghostscript can be downloaded here: https://ghostscript.com/releases/gsdnld.html. If you don't want to install Ghostscript on your machine you can copy gsdll32.dll/gsdl64.dll and gswin32c.exe/gswin64c.exe to your server and tell Magick.NET where the file is located with the code below.

MagickNET.SetGhostscriptDirectory(@"C:\MyProgram\Ghostscript");

Be aware that you need a license if you want to use Ghostscript commercially.

Initialization

Magick.NET uses ImageMagick and this will be initialized the first time you using something that uses ImageMagick. You can however decide to initialize ImageMagick on startup of your application and for example use your own xml configuration files. Documentation about the initialization can be found here.

Temporary directory

ImageMagick sometimes needs to write temporary files to the hard drive. The default folder for this is %TEMP% but the folder can be changed with the following code:

MagickNET.SetTempDirectory(@"C:\MyProgram\MyTempFiles");

Examples

Below here you can find some examples on how to use Magick.NET. Because Magick.NET comes with a xml documentation file IntelliSense will also provide you with some help on how to use Magick.NET.

More documentation

For some great ImageMagick examples please visit the following page: https://imagemagick.org/Usage. Create a new issue if you need help to change one of these examples into code.