Class MagickImageInfo

Namespace

ImageMagick

Assembly

Magick.NET-Q8-AnyCPU.dll

Class that contains basic information about an image.

public sealed class MagickImageInfo : IMagickImageInfo<byte>, IMagickImageInfo

Inheritance

object

MagickImageInfo

Implements

IMagickImageInfo<byte>

IMagickImageInfo

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MagickImageInfo()

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo()

MagickImageInfo(ReadOnlySequence<byte>)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(ReadOnlySequence<byte> data)

Parameters

data ReadOnlySequence<byte>

The sequence of bytes to read the information from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(byte[])

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(byte[] data)

Parameters

data byte[]

The byte array to read the information from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(byte[], IMagickReadSettings<byte>?)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(byte[] data, IMagickReadSettings<byte>? readSettings)

Parameters

data byte[]

The byte array to read the information from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(byte[], uint, uint)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(byte[] data, uint offset, uint count)

Parameters

data byte[]

The byte array to read the information from.

offset uint

The offset at which to begin reading data.

count uint

The maximum number of bytes to read.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(byte[], uint, uint, IMagickReadSettings<byte>?)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(byte[] data, uint offset, uint count, IMagickReadSettings<byte>? readSettings)

Parameters

data byte[]

The byte array to read the information from.

offset uint

The offset at which to begin reading data.

count uint

The maximum number of bytes to read.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(FileInfo)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(FileInfo file)

Parameters

file FileInfo

The file to read the image from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(FileInfo, IMagickReadSettings<byte>?)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(FileInfo file, IMagickReadSettings<byte>? readSettings)

Parameters

file FileInfo

The file to read the image from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(Stream)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(Stream, IMagickReadSettings<byte>?)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(Stream stream, IMagickReadSettings<byte>? readSettings)

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(ReadOnlySpan<byte>)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(ReadOnlySpan<byte> data)

Parameters

data ReadOnlySpan<byte>

The span of bytes to read the information from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

MagickImageInfo(string)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(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.

MagickImageInfo(string, IMagickReadSettings<byte>?)

Initializes a new instance of the MagickImageInfo class.

public MagickImageInfo(string fileName, IMagickReadSettings<byte>? readSettings)

Parameters

fileName string

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

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Properties

ColorSpace

Gets the color space of the image.

public ColorSpace ColorSpace { get; }

Property Value

ColorSpace

Compression

Gets the compression method of the image.

public CompressionMethod Compression { get; }

Property Value

CompressionMethod

Density

Gets the density of the image.

public Density? Density { get; }

Property Value

Density

FileName

Gets the original file name of the image (only available if read from disk).

public string? FileName { get; }

Property Value

string

Format

Gets the format of the image.

public MagickFormat Format { get; }

Property Value

MagickFormat

Height

Gets the height of the image.

public uint Height { get; }

Property Value

uint

Interlace

Gets the type of interlacing.

public Interlace Interlace { get; }

Property Value

Interlace

Orientation

Gets the orientation of the image.

public OrientationType Orientation { get; }

Property Value

OrientationType

Quality

Gets the JPEG/MIFF/PNG compression level.

public uint Quality { get; }

Property Value

uint

Width

Gets the width of the image.

public uint Width { get; }

Property Value

uint

Methods

Read(ReadOnlySequence<byte>)

Read basic information about an image.

public void Read(ReadOnlySequence<byte> data)

Parameters

data ReadOnlySequence<byte>

The sequence of bytes to read the information from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(ReadOnlySequence<byte>, IMagickReadSettings<byte>?)

Read basic information about an image.

public void Read(ReadOnlySequence<byte> data, IMagickReadSettings<byte>? readSettings)

Parameters

data ReadOnlySequence<byte>

The sequence of bytes to read the information from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[])

Read basic information about an image.

public void Read(byte[] data)

Parameters

data byte[]

The byte array to read the information from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

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

Read basic information about an image.

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

Parameters

data byte[]

The byte array to read the information from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(byte[], uint, uint)

Read basic information about an image.

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

Parameters

data byte[]

The byte array to read the information from.

offset uint

The offset at which to begin reading data.

count uint

The maximum number of bytes to read.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

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

Read basic information about an image.

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

Parameters

data byte[]

The byte array to read the information from.

offset uint

The offset at which to begin reading data.

count uint

The maximum number of bytes to read.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(FileInfo)

Read basic information about an image.

public void Read(FileInfo file)

Parameters

file FileInfo

The file to read the image from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(FileInfo, IMagickReadSettings<byte>?)

Read basic information about an image.

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

Parameters

file FileInfo

The file to read the image from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(Stream)

Read basic information about an image.

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<byte>?)

Read basic information about an image.

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

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(ReadOnlySpan<byte>)

Read basic information about an image.

public void Read(ReadOnlySpan<byte> data)

Parameters

data ReadOnlySpan<byte>

The span of bytes to read the information from.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(ReadOnlySpan<byte>, IMagickReadSettings<byte>?)

Read basic information about an image.

public void Read(ReadOnlySpan<byte> data, IMagickReadSettings<byte>? readSettings)

Parameters

data ReadOnlySpan<byte>

The span of bytes to read the information from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

Read(string)

Read basic information about an image.

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<byte>?)

Read basic information about an image.

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

Parameters

fileName string

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

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(ReadOnlySequence<byte>)

Read basic information about an image with multiple frames/pages.

public static IReadOnlyList<IMagickImageInfo> ReadCollection(ReadOnlySequence<byte> data)

Parameters

data ReadOnlySequence<byte>

The sequence of bytes to read the information from.

Returns

IReadOnlyList<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(byte[])

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(byte[] data)

Parameters

data byte[]

The byte array to read the information from.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(byte[], IMagickReadSettings<byte>?)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(byte[] data, IMagickReadSettings<byte>? readSettings)

Parameters

data byte[]

The byte array to read the information from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(byte[], uint, uint)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(byte[] data, uint offset, uint count)

Parameters

data byte[]

The byte array to read the information from.

offset uint

The offset at which to begin reading data.

count uint

The maximum number of bytes to read.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(byte[], uint, uint, IMagickReadSettings<byte>?)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(byte[] data, uint offset, uint count, IMagickReadSettings<byte>? readSettings)

Parameters

data byte[]

The byte array to read the information from.

offset uint

The offset at which to begin reading data.

count uint

The maximum number of bytes to read.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(FileInfo)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(FileInfo file)

Parameters

file FileInfo

The file to read the frames from.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(FileInfo, IMagickReadSettings<byte>?)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(FileInfo file, IMagickReadSettings<byte>? readSettings)

Parameters

file FileInfo

The file to read the frames from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(Stream)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(Stream stream)

Parameters

stream Stream

The stream to read the image data from.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(Stream, IMagickReadSettings<byte>?)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(Stream stream, IMagickReadSettings<byte>? readSettings)

Parameters

stream Stream

The stream to read the image data from.

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(ReadOnlySpan<byte>)

Read basic information about an image with multiple frames/pages.

public static IReadOnlyList<IMagickImageInfo> ReadCollection(ReadOnlySpan<byte> data)

Parameters

data ReadOnlySpan<byte>

The span of bytes to read the information from.

Returns

IReadOnlyList<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(string)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(string fileName)

Parameters

fileName string

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

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.

ReadCollection(string, IMagickReadSettings<byte>?)

Read basic information about an image with multiple frames/pages.

public static IEnumerable<IMagickImageInfo> ReadCollection(string fileName, IMagickReadSettings<byte>? readSettings)

Parameters

fileName string

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

readSettings IMagickReadSettings<byte>

The settings to use when reading the image.

Returns

IEnumerable<IMagickImageInfo>

A ImageMagick.IMagickImageInfo iteration.

Exceptions

ImageMagick.MagickException

Thrown when an error is raised by ImageMagick.