Class MagickImageCollection

Namespace

ImageMagick

Assembly

Magick.NET-Q16-AnyCPU.dll

Represents the collection of images.

public sealed class MagickImageCollection : IMagickImageCollection<ushort>, IMagickImageCollection, IDisposable, IList<IMagickImage<ushort>>, ICollection<IMagickImage<ushort>>, IEnumerable<IMagickImage<ushort>>, IEnumerable

Inheritance

object

MagickImageCollection

Implements

IMagickImageCollection<ushort>

IMagickImageCollection

IDisposable

IList<IMagickImage<ushort>>

ICollection<IMagickImage<ushort>>

IEnumerable<IMagickImage<ushort>>

IEnumerable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MagickImageCollection()

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection()

MagickImageCollection(byte[])

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(byte[] data)

Parameters

data byte[]

The byte array to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(byte[], IMagickReadSettings<ushort>)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(byte[] data, IMagickReadSettings<ushort> readSettings)

Parameters

data byte[]

The byte array to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(byte[], MagickFormat)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(byte[] data, MagickFormat format)

Parameters

data byte[]

The byte array to read the image data from.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(byte[], int, int)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(byte[] data, int offset, int count)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(byte[], int, int, IMagickReadSettings<ushort>)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(byte[] data, int offset, int count, IMagickReadSettings<ushort> readSettings)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(byte[], int, int, MagickFormat)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(byte[] data, int offset, int count, MagickFormat format)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(IEnumerable<IMagickImage<ushort>>)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(IEnumerable<IMagickImage<ushort>> images)

Parameters

images IEnumerable<IMagickImage<ushort>>

The images to add to the collection.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(FileInfo)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(FileInfo file)

Parameters

file FileInfo

The file to read the image from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(FileInfo, IMagickReadSettings<ushort>)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(FileInfo file, IMagickReadSettings<ushort> readSettings)

Parameters

file FileInfo

The file to read the image from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(FileInfo, MagickFormat)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(FileInfo file, MagickFormat format)

Parameters

file FileInfo

The file to read the image from.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(Stream)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(Stream, IMagickReadSettings<ushort>)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(Stream stream, IMagickReadSettings<ushort> readSettings)

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(Stream, MagickFormat)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(Stream stream, MagickFormat format)

Parameters

stream Stream

The stream to read the image data from.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(string)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(string, IMagickReadSettings<ushort>)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(string fileName, IMagickReadSettings<ushort> readSettings)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageCollection(string, MagickFormat)

Initializes a new instance of the MagickImageCollection class.

public MagickImageCollection(string fileName, MagickFormat format)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Properties

Count

Gets the number of images in the collection.

public int Count { get; }

Property Value

int

IsReadOnly

Gets a value indicating whether the collection is read-only.

public bool IsReadOnly { get; }

Property Value

bool

this[int]

Gets or sets the image at the specified index.

public IMagickImage<ushort> this[int index] { get; set; }

Parameters

index int

The index of the image to get.

Property Value

IMagickImage<ushort>

Methods

Add(IMagickImage<ushort>)

Adds an image to the collection.

public void Add(IMagickImage<ushort> item)

Parameters

item IMagickImage<ushort>

The image to add.

Add(string)

Adds an image with the specified file name to the collection.

public void Add(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AddRange(byte[])

Adds the image(s) from the specified byte array to the collection.

public void AddRange(byte[] data)

Parameters

data byte[]

The byte array to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AddRange(byte[], IMagickReadSettings<ushort>?)

Adds the image(s) from the specified byte array to the collection.

public void AddRange(byte[] data, IMagickReadSettings<ushort>? readSettings)

Parameters

data byte[]

The byte array to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AddRange(IEnumerable<IMagickImage<ushort>>)

Adds the specified images to this collection.

public void AddRange(IEnumerable<IMagickImage<ushort>> images)

Parameters

images IEnumerable<IMagickImage<ushort>>

The images to add to the collection.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AddRange(Stream)

Adds the image(s) from the specified stream to the collection.

public void AddRange(Stream stream)

Parameters

stream Stream

The stream to read the images from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AddRange(Stream, IMagickReadSettings<ushort>?)

Adds the image(s) from the specified stream to the collection.

public void AddRange(Stream stream, IMagickReadSettings<ushort>? readSettings)

Parameters

stream Stream

The stream to read the images from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AddRange(string)

Adds the image(s) from the specified file name to the collection.

public void AddRange(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AddRange(string, IMagickReadSettings<ushort>?)

Adds the image(s) from the specified file name to the collection.

public void AddRange(string fileName, IMagickReadSettings<ushort>? readSettings)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AppendHorizontally()

Creates a single image, by appending all the images in the collection horizontally (+append).

public IMagickImage<ushort> AppendHorizontally()

Returns

IMagickImage<ushort>

A single image, by appending all the images in the collection horizontally (+append).

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

AppendVertically()

Creates a single image, by appending all the images in the collection vertically (-append).

public IMagickImage<ushort> AppendVertically()

Returns

IMagickImage<ushort>

A single image, by appending all the images in the collection vertically (-append).

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Clear()

Removes all images from the collection.

public void Clear()

Clone()

Creates a clone of the current image collection.

public IMagickImageCollection<ushort> Clone()

Returns

IMagickImageCollection<ushort>

A clone of the current image collection.

Coalesce()

Merge a sequence of images. This is useful for GIF animation sequences that have page offsets and disposal methods.

public void Coalesce()

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Combine()

Combines the images into a single image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.

public IMagickImage<ushort> Combine()

Returns

IMagickImage<ushort>

The images combined into a single image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Combine(ColorSpace)

Combines the images into a single image. The grayscale value of the pixels of each image in the sequence is assigned in order to the specified channels of the combined image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.

public IMagickImage<ushort> Combine(ColorSpace colorSpace)

Parameters

colorSpace ColorSpace

The image colorspace.

Returns

IMagickImage<ushort>

The images combined into a single image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Complex(IComplexSettings)

Perform complex mathematics on an image sequence.

public void Complex(IComplexSettings complexSettings)

Parameters

complexSettings IComplexSettings

The complex settings.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Contains(IMagickImage<ushort>)

Determines whether the collection contains the specified image.

public bool Contains(IMagickImage<ushort> item)

Parameters

item IMagickImage<ushort>

The image to check.

Returns

bool

True when the collection contains the specified image.

CopyTo(IMagickImage<ushort>[], int)

Copies the images to an Array, starting at a particular Array index.

public void CopyTo(IMagickImage<ushort>[] array, int arrayIndex)

Parameters

array IMagickImage<ushort>[]

The one-dimensional Array that is the destination.

arrayIndex int

The zero-based index in 'destination' at which copying begins.

Deconstruct()

Break down an image sequence into constituent parts. This is useful for creating GIF or MNG animation sequences.

public void Deconstruct()

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Dispose()

Disposes the MagickImageCollection instance.

public void Dispose()

Evaluate(EvaluateOperator)

Evaluate image pixels into a single image. All the images in the collection must be the same size in pixels.

public IMagickImage<ushort> Evaluate(EvaluateOperator evaluateOperator)

Parameters

evaluateOperator EvaluateOperator

The operator.

Returns

IMagickImage<ushort>

The resulting image of the evaluation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

~MagickImageCollection()

Finalizes an instance of the MagickImageCollection class.

protected ~MagickImageCollection()

Flatten()

Flatten this collection into a single image. Use the virtual canvas size of first image. Images which fall outside this canvas is clipped. This can be used to 'fill out' a given virtual canvas.

public IMagickImage<ushort> Flatten()

Returns

IMagickImage<ushort>

The resulting image of the flatten operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Flatten(IMagickColor<ushort>)

Flatten this collection into a single image. This is useful for combining Photoshop layers into a single image.

public IMagickImage<ushort> Flatten(IMagickColor<ushort> backgroundColor)

Parameters

backgroundColor IMagickColor<ushort>

The background color of the output image.

Returns

IMagickImage<ushort>

The resulting image of the flatten operation.

Fx(string)

Applies a mathematical expression to the images and returns the result.

public IMagickImage<ushort> Fx(string expression)

Parameters

expression string

The expression to apply.

Returns

IMagickImage<ushort>

The resulting image of the fx operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Fx(string, Channels)

Applies a mathematical expression to the images and returns the result.

public IMagickImage<ushort> Fx(string expression, Channels channels)

Parameters

expression string

The expression to apply.

channels Channels

The channel(s) to apply the expression to.

Returns

IMagickImage<ushort>

The resulting image of the fx operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

GetEnumerator()

Returns an enumerator that iterates through the images.

public IEnumerator<IMagickImage<ushort>> GetEnumerator()

Returns

IEnumerator<IMagickImage<ushort>>

An enumerator that iterates through the images.

IndexOf(IMagickImage<ushort>)

Determines the index of the specified image.

public int IndexOf(IMagickImage<ushort> item)

Parameters

item IMagickImage<ushort>

The image to check.

Returns

int

The index of the specified image.

Insert(int, IMagickImage<ushort>)

Inserts an image into the collection.

public void Insert(int index, IMagickImage<ushort> item)

Parameters

index int

The index to insert the image.

item IMagickImage<ushort>

The image to insert.

Insert(int, string)

Inserts an image with the specified file name into the collection.

public void Insert(int index, string fileName)

Parameters

index int

The index to insert the image.

fileName string

The fully qualified name of the image file, or the relative image file name.

Map(IMagickImage<ushort>)

Remap image colors with closest color from reference image.

public void Map(IMagickImage<ushort> image)

Parameters

image IMagickImage<ushort>

The image to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Map(IMagickImage<ushort>, IQuantizeSettings)

Remap image colors with closest color from reference image.

public void Map(IMagickImage<ushort> image, IQuantizeSettings settings)

Parameters

image IMagickImage<ushort>

The image to use.

settings IQuantizeSettings

Quantize settings.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Merge()

Merge all layers onto a canvas just large enough to hold all the actual images. The virtual canvas of the first image is preserved but otherwise ignored.

public IMagickImage<ushort> Merge()

Returns

IMagickImage<ushort>

The resulting image of the merge operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Montage(IMontageSettings<ushort>)

Create a composite image by combining the images with the specified settings.

public IMagickImage<ushort> Montage(IMontageSettings<ushort> settings)

Parameters

settings IMontageSettings<ushort>

The settings to use.

Returns

IMagickImage<ushort>

The resulting image of the montage operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Morph(int)

The Morph method requires a minimum of two images. The first image is transformed into the second by a number of intervening images as specified by frames.

public void Morph(int frames)

Parameters

frames int

The number of in-between images to generate.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Mosaic()

Start with the virtual canvas of the first image, enlarging left and right edges to contain all images. Images with negative offsets will be clipped.

public IMagickImage<ushort> Mosaic()

Returns

IMagickImage<ushort>

The resulting image of the mosaic operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Optimize()

Compares each image the GIF disposed forms of the previous image in the sequence. From this it attempts to select the smallest cropped image to replace each frame, while preserving the results of the GIF animation.

public void Optimize()

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

OptimizePlus()

OptimizePlus is exactly as Optimize, but may also add or even remove extra frames in the animation, if it improves the total number of pixels in the resulting GIF animation.

public void OptimizePlus()

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

OptimizeTransparency()

Compares each image the GIF disposed forms of the previous image in the sequence. Any pixel that does not change the displayed result is replaced with transparency.

public void OptimizeTransparency()

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(byte[])

Read only metadata and not the pixel data from all image frames.

public void Ping(byte[] data)

Parameters

data byte[]

The byte array to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(byte[], IMagickReadSettings<ushort>?)

Read only metadata and not the pixel data from all image frames.

public void Ping(byte[] data, IMagickReadSettings<ushort>? readSettings)

Parameters

data byte[]

The byte array to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(byte[], int, int)

Reads only metadata and not the pixel data from all image frames.

public void Ping(byte[] data, int offset, int count)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(byte[], int, int, IMagickReadSettings<ushort>?)

Reads only metadata and not the pixel data from all image frames.

public void Ping(byte[] data, int offset, int count, IMagickReadSettings<ushort>? readSettings)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(FileInfo)

Read only metadata and not the pixel data from all image frames.

public void Ping(FileInfo file)

Parameters

file FileInfo

The file to read the frames from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(FileInfo, IMagickReadSettings<ushort>?)

Read only metadata and not the pixel data from all image frames.

public void Ping(FileInfo file, IMagickReadSettings<ushort>? readSettings)

Parameters

file FileInfo

The file to read the frames from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(Stream)

Read only metadata and not the pixel data from all image frames.

public void Ping(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(Stream, IMagickReadSettings<ushort>?)

Read only metadata and not the pixel data from all image frames.

public void Ping(Stream stream, IMagickReadSettings<ushort>? readSettings)

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(string)

Read only metadata and not the pixel data from all image frames.

public void Ping(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Ping(string, IMagickReadSettings<ushort>?)

Read only metadata and not the pixel data from all image frames.

public void Ping(string fileName, IMagickReadSettings<ushort>? readSettings)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Polynomial(double[])

Returns a new image where each pixel is the sum of the pixels in the image sequence after applying its corresponding terms (coefficient and degree pairs).

public IMagickImage<ushort> Polynomial(double[] terms)

Parameters

terms double[]

The list of polynomial coefficients and degree pairs and a constant.

Returns

IMagickImage<ushort>

A new image where each pixel is the sum of the pixels in the image sequence after applying its corresponding terms (coefficient and degree pairs).

Quantize()

Quantize images (reduce number of colors).

public IMagickErrorInfo? Quantize()

Returns

IMagickErrorInfo

The resulting image of the quantize operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Quantize(IQuantizeSettings)

Quantize images (reduce number of colors).

public IMagickErrorInfo? Quantize(IQuantizeSettings settings)

Parameters

settings IQuantizeSettings

Quantize settings.

Returns

IMagickErrorInfo

The resulting image of the quantize operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

RePage()

Resets the page property of every image in the collection.

public void RePage()

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[])

Read all image frames.

public void Read(byte[] data)

Parameters

data byte[]

The byte array to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[], IMagickReadSettings<ushort>?)

Read all image frames.

public void Read(byte[] data, IMagickReadSettings<ushort>? readSettings)

Parameters

data byte[]

The byte array to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[], MagickFormat)

Read all image frames.

public void Read(byte[] data, MagickFormat format)

Parameters

data byte[]

The byte array to read the image data from.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[], int, int)

Read all image frames.

public void Read(byte[] data, int offset, int count)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[], int, int, IMagickReadSettings<ushort>?)

Read all image frames.

public void Read(byte[] data, int offset, int count, IMagickReadSettings<ushort>? readSettings)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[], int, int, MagickFormat)

Read all image frames.

public void Read(byte[] data, int offset, int count, MagickFormat format)

Parameters

data byte[]

The byte array to read the image data from.

offset int

The offset at which to begin reading data.

count int

The maximum number of bytes to read.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(FileInfo)

Read all image frames.

public void Read(FileInfo file)

Parameters

file FileInfo

The file to read the frames from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(FileInfo, IMagickReadSettings<ushort>?)

Read all image frames.

public void Read(FileInfo file, IMagickReadSettings<ushort>? readSettings)

Parameters

file FileInfo

The file to read the frames from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(FileInfo, MagickFormat)

Read all image frames.

public void Read(FileInfo file, MagickFormat format)

Parameters

file FileInfo

The file to read the frames from.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(Stream)

Read all image frames.

public void Read(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(Stream, IMagickReadSettings<ushort>?)

Read all image frames.

public void Read(Stream stream, IMagickReadSettings<ushort>? readSettings)

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(Stream, MagickFormat)

Read all image frames.

public void Read(Stream stream, MagickFormat format)

Parameters

stream Stream

The stream to read the image data from.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(string)

Read all image frames.

public void Read(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(string, IMagickReadSettings<ushort>?)

Read all image frames.

public void Read(string fileName, IMagickReadSettings<ushort>? readSettings)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(string, MagickFormat)

Read all image frames.

public void Read(string fileName, MagickFormat format)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(FileInfo)

Read all image frames.

public Task ReadAsync(FileInfo file)

Parameters

file FileInfo

The file to read the frames from.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(FileInfo, IMagickReadSettings<ushort>?)

Read all image frames.

public Task ReadAsync(FileInfo file, IMagickReadSettings<ushort>? readSettings)

Parameters

file FileInfo

The file to read the frames from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(FileInfo, IMagickReadSettings<ushort>?, CancellationToken)

Read all image frames.

public Task ReadAsync(FileInfo file, IMagickReadSettings<ushort>? readSettings, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to read the frames from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(FileInfo, MagickFormat)

Read all image frames.

public Task ReadAsync(FileInfo file, MagickFormat format)

Parameters

file FileInfo

The file to read the frames from.

format MagickFormat

The format to use.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(FileInfo, MagickFormat, CancellationToken)

Read all image frames.

public Task ReadAsync(FileInfo file, MagickFormat format, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to read the frames from.

format MagickFormat

The format to use.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(FileInfo, CancellationToken)

Read all image frames.

public Task ReadAsync(FileInfo file, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to read the frames from.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(Stream)

Read all image frames.

public Task ReadAsync(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(Stream, IMagickReadSettings<ushort>?)

Read all image frames.

public Task ReadAsync(Stream stream, IMagickReadSettings<ushort>? readSettings)

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(Stream, IMagickReadSettings<ushort>?, CancellationToken)

Read all image frames.

public Task ReadAsync(Stream stream, IMagickReadSettings<ushort>? readSettings, CancellationToken cancellationToken)

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(Stream, MagickFormat)

Read all image frames.

public Task ReadAsync(Stream stream, MagickFormat format)

Parameters

stream Stream

The stream to read the image data from.

format MagickFormat

The format to use.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(Stream, MagickFormat, CancellationToken)

Read all image frames.

public Task ReadAsync(Stream stream, MagickFormat format, CancellationToken cancellationToken)

Parameters

stream Stream

The stream to read the image data from.

format MagickFormat

The format to use.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(Stream, CancellationToken)

Read all image frames.

public Task ReadAsync(Stream stream, CancellationToken cancellationToken)

Parameters

stream Stream

The stream to read the image data from.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(string)

Read all image frames.

public Task ReadAsync(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(string, IMagickReadSettings<ushort>?)

Read all image frames.

public Task ReadAsync(string fileName, IMagickReadSettings<ushort>? readSettings)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(string, IMagickReadSettings<ushort>?, CancellationToken)

Read all image frames.

public Task ReadAsync(string fileName, IMagickReadSettings<ushort>? readSettings, CancellationToken cancellationToken)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(string, MagickFormat)

Read all image frames.

public Task ReadAsync(string fileName, MagickFormat format)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

format MagickFormat

The format to use.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(string, MagickFormat, CancellationToken)

Read all image frames.

public Task ReadAsync(string fileName, MagickFormat format, CancellationToken cancellationToken)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

format MagickFormat

The format to use.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadAsync(string, CancellationToken)

Read all image frames.

public Task ReadAsync(string fileName, CancellationToken cancellationToken)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Remove(IMagickImage<ushort>)

Removes the first occurrence of the specified image from the collection.

public bool Remove(IMagickImage<ushort> item)

Parameters

item IMagickImage<ushort>

The image to remove.

Returns

bool

True when the image was found and removed.

RemoveAt(int)

Removes the image at the specified index from the collection.

public void RemoveAt(int index)

Parameters

index int

The index of the image to remove.

Reverse()

Reverses the order of the images in the collection.

public void Reverse()

SmushHorizontal(int)

Smush images from list into single image in horizontal direction.

public IMagickImage<ushort> SmushHorizontal(int offset)

Parameters

offset int

Minimum distance in pixels between images.

Returns

IMagickImage<ushort>

The resulting image of the smush operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

SmushVertical(int)

Smush images from list into single image in vertical direction.

public IMagickImage<ushort> SmushVertical(int offset)

Parameters

offset int

Minimum distance in pixels between images.

Returns

IMagickImage<ushort>

The resulting image of the smush operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ToBase64()

Converts this instance to a base64 string.

public string ToBase64()

Returns

string

A base64 string.

ToBase64(IWriteDefines)

Converts this instance to a base64 string.

public string ToBase64(IWriteDefines defines)

Parameters

defines IWriteDefines

The defines to set.

Returns

string

A base64 string.

ToBase64(MagickFormat)

Converts this instance to a base64 string.

public string ToBase64(MagickFormat format)

Parameters

format MagickFormat

The format to use.

Returns

string

A base64 string.

ToByteArray()

Converts this instance to a byte array.

public byte[] ToByteArray()

Returns

byte[]

A byte array.

ToByteArray(IWriteDefines)

Converts this instance to a byte array.

public byte[] ToByteArray(IWriteDefines defines)

Parameters

defines IWriteDefines

The defines to set.

Returns

byte[]

A byte array.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ToByteArray(MagickFormat)

Converts this instance to a byte array.

public byte[] ToByteArray(MagickFormat format)

Parameters

format MagickFormat

The format to use.

Returns

byte[]

A byte array.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

TrimBounds()

Determine the overall bounds of all the image layers just as in Merge(), then adjust the the canvas and offsets to be relative to those bounds, without overlaying the images.

public void TrimBounds()

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(FileInfo)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(FileInfo file)

Parameters

file FileInfo

The file to write the image to.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(FileInfo, IWriteDefines)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(FileInfo file, IWriteDefines defines)

Parameters

file FileInfo

The file to write the image to.

defines IWriteDefines

The defines to set.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(FileInfo, MagickFormat)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(FileInfo file, MagickFormat format)

Parameters

file FileInfo

The file to write the image to.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(Stream)

Writes the imagse to the specified stream. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(Stream stream)

Parameters

stream Stream

The stream to write the images to.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(Stream, IWriteDefines)

Writes the imagse to the specified stream. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(Stream stream, IWriteDefines defines)

Parameters

stream Stream

The stream to write the images to.

defines IWriteDefines

The defines to set.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(Stream, MagickFormat)

Writes the image to the specified stream.

public void Write(Stream stream, MagickFormat format)

Parameters

stream Stream

The stream to write the image data to.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(string)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(string, IWriteDefines)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(string fileName, IWriteDefines defines)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

defines IWriteDefines

The defines to set.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Write(string, MagickFormat)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public void Write(string fileName, MagickFormat format)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

format MagickFormat

The format to use.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(FileInfo)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(FileInfo file)

Parameters

file FileInfo

The file to write the image to.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(FileInfo, IWriteDefines)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(FileInfo file, IWriteDefines defines)

Parameters

file FileInfo

The file to write the image to.

defines IWriteDefines

The defines to set.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(FileInfo, IWriteDefines, CancellationToken)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(FileInfo file, IWriteDefines defines, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to write the image to.

defines IWriteDefines

The defines to set.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(FileInfo, MagickFormat)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(FileInfo file, MagickFormat format)

Parameters

file FileInfo

The file to write the image to.

format MagickFormat

The format to use.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(FileInfo, MagickFormat, CancellationToken)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(FileInfo file, MagickFormat format, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to write the image to.

format MagickFormat

The format to use.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(FileInfo, CancellationToken)

Writes the images to the specified file. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(FileInfo file, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to write the image to.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(Stream)

Writes the imagse to the specified stream. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(Stream stream)

Parameters

stream Stream

The stream to write the images to.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(Stream, IWriteDefines)

Writes the imagse to the specified stream. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(Stream stream, IWriteDefines defines)

Parameters

stream Stream

The stream to write the images to.

defines IWriteDefines

The defines to set.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(Stream, IWriteDefines, CancellationToken)

Writes the imagse to the specified stream. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(Stream stream, IWriteDefines defines, CancellationToken cancellationToken)

Parameters

stream Stream

The stream to write the images to.

defines IWriteDefines

The defines to set.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(Stream, MagickFormat)

Writes the image to the specified stream.

public Task WriteAsync(Stream stream, MagickFormat format)

Parameters

stream Stream

The stream to write the image data to.

format MagickFormat

The format to use.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(Stream, MagickFormat, CancellationToken)

Writes the image to the specified stream.

public Task WriteAsync(Stream stream, MagickFormat format, CancellationToken cancellationToken)

Parameters

stream Stream

The stream to write the image data to.

format MagickFormat

The format to use.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(Stream, CancellationToken)

Writes the imagse to the specified stream. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(Stream stream, CancellationToken cancellationToken)

Parameters

stream Stream

The stream to write the images to.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(string)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(string fileName)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(string, IWriteDefines)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(string fileName, IWriteDefines defines)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

defines IWriteDefines

The defines to set.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(string, IWriteDefines, CancellationToken)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(string fileName, IWriteDefines defines, CancellationToken cancellationToken)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

defines IWriteDefines

The defines to set.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(string, MagickFormat)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(string fileName, MagickFormat format)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

format MagickFormat

The format to use.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(string, MagickFormat, CancellationToken)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(string fileName, MagickFormat format, CancellationToken cancellationToken)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

format MagickFormat

The format to use.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

WriteAsync(string, CancellationToken)

Writes the images to the specified file name. If the output image's file format does not allow multi-image files multiple files will be written.

public Task WriteAsync(string fileName, CancellationToken cancellationToken)

Parameters

fileName string

The fully qualified name of the image file, or the relative image file name.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Events

Warning

Event that will we raised when a warning is raised by ImageMagick.

public event EventHandler<WarningEventArgs> Warning

Event Type

EventHandler<WarningEventArgs>