Class MagickImageCollectionFactory

Namespace

ImageMagick

Assembly

Magick.NET-Q16-AnyCPU.dll

Class that can be used to create ImageMagick.IMagickImageCollection<> instances.

public sealed class MagickImageCollectionFactory : IMagickImageCollectionFactory<ushort>

Inheritance

object

MagickImageCollectionFactory

Implements

IMagickImageCollectionFactory<ushort>

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MagickImageCollectionFactory()

public MagickImageCollectionFactory()

Methods

Create()

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create()

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Create(byte[])

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(byte[] data)

Parameters

data byte[]

The byte array to read the image data from.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(byte[], IMagickReadSettings<ushort>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(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.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(byte[], int, int)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(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.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

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

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(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.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(IEnumerable<IMagickImage<ushort>>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(IEnumerable<IMagickImage<ushort>> images)

Parameters

images IEnumerable<IMagickImage<ushort>>

The images to add to the collection.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(FileInfo)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(FileInfo file)

Parameters

file FileInfo

The file to read the image from.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(FileInfo, IMagickReadSettings<ushort>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(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.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(Stream)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(Stream, IMagickReadSettings<ushort>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(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

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(string)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(string fileName)

Parameters

fileName string

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

Returns

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Create(string, IMagickReadSettings<ushort>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public IMagickImageCollection<ushort> Create(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

IMagickImageCollection<ushort>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(FileInfo)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(FileInfo file)

Parameters

file FileInfo

The file to read the image from.

Returns

Task<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(FileInfo, IMagickReadSettings<ushort>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(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.

Returns

Task<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(FileInfo, IMagickReadSettings<ushort>, CancellationToken)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(FileInfo file, IMagickReadSettings<ushort> readSettings, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to read the image from.

readSettings IMagickReadSettings<ushort>

The settings to use when reading the image.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(FileInfo, CancellationToken)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(FileInfo file, CancellationToken cancellationToken)

Parameters

file FileInfo

The file to read the image from.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(Stream)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Returns

Task<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(Stream, IMagickReadSettings<ushort>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(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<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(Stream, IMagickReadSettings<ushort>, CancellationToken)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(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<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(Stream, CancellationToken)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(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<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(string)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(string fileName)

Parameters

fileName string

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

Returns

Task<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(string, IMagickReadSettings<ushort>)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(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<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(string, IMagickReadSettings<ushort>, CancellationToken)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(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<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

CreateAsync(string, CancellationToken)

Initializes a new instance that implements ImageMagick.IMagickImageCollection<>.

public Task<IMagickImageCollection<ushort>> CreateAsync(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<IMagickImageCollection<ushort>>

A new ImageMagick.IMagickImageCollection<> instance.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.