Class MagickFormatInfo

Namespace

ImageMagick

Assembly

Magick.NET-Q8-AnyCPU.dll

Class that contains information about an image format.

public sealed class MagickFormatInfo : IMagickFormatInfo, IEquatable<IMagickFormatInfo?>

Inheritance

object

MagickFormatInfo

Implements

IMagickFormatInfo

IEquatable<IMagickFormatInfo>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Properties

CanReadMultithreaded

Gets a value indicating whether the format can be read multithreaded.

public bool CanReadMultithreaded { get; }

Property Value

bool

CanWriteMultithreaded

Gets a value indicating whether the format can be written multithreaded.

public bool CanWriteMultithreaded { get; }

Property Value

bool

Description

Gets the description of the format.

public string? Description { get; }

Property Value

string

Format

Gets the format.

public MagickFormat Format { get; }

Property Value

MagickFormat

MimeType

Gets the mime type.

public string? MimeType { get; }

Property Value

string

ModuleFormat

Gets the module.

public MagickFormat ModuleFormat { get; }

Property Value

MagickFormat

SupportsMultipleFrames

Gets a value indicating whether the format supports multiple frames.

public bool SupportsMultipleFrames { get; }

Property Value

bool

SupportsReading

Gets a value indicating whether the format can be read.

public bool SupportsReading { get; }

Property Value

bool

SupportsWriting

Gets a value indicating whether the format can be written.

public bool SupportsWriting { get; }

Property Value

bool

Methods

Create(MagickFormat?)

Returns the format information of the specified format.

public static IMagickFormatInfo? Create(MagickFormat? format)

Parameters

format MagickFormat

The image format.

Returns

IMagickFormatInfo

The format information.

Create(ReadOnlySequence<byte>)

Returns the format information. The header of the image in the sequence of bytes is used to determine the format.

public static MagickFormatInfo? Create(ReadOnlySequence<byte> data)

Parameters

data ReadOnlySequence<byte>

The sequence of bytes to read the image header from.

Returns

MagickFormatInfo

The format information.

Create(byte[])

Returns the format information. The header of the image in the array of bytes is used to determine the format. Null will be returned when the format could not be determined.

public static IMagickFormatInfo? Create(byte[] data)

Parameters

data byte[]

The array of bytes to read the image header from.

Returns

IMagickFormatInfo

The format information.

Create(FileInfo)

Returns the format information. The extension of the supplied file is used to determine the format.

public static IMagickFormatInfo? Create(FileInfo file)

Parameters

file FileInfo

The file to check.

Returns

IMagickFormatInfo

The format information.

Create(ReadOnlySpan<byte>)

Returns the format information. The header of the image in the span of bytes is used to determine the format.

public static MagickFormatInfo? Create(ReadOnlySpan<byte> data)

Parameters

data ReadOnlySpan<byte>

The span of bytes to read the image header from.

Returns

MagickFormatInfo

The format information.

Create(string)

Returns the format information. The extension of the supplied file name is used to determine the format.

public static IMagickFormatInfo? Create(string fileName)

Parameters

fileName string

The name of the file to check.

Returns

IMagickFormatInfo

The format information.

Equals(IMagickFormatInfo?)

Determines whether the specified ImageMagick.IMagickFormatInfo is equal to the current MagickFormatInfo.

public bool Equals(IMagickFormatInfo? other)

Parameters

other IMagickFormatInfo

The ImageMagick.IMagickFormatInfo to compare this MagickFormatInfo with.

Returns

bool

True when the specified ImageMagick.IMagickFormatInfo is equal to the current MagickFormatInfo.

Equals(object?)

Determines whether the specified object is equal to the current MagickFormatInfo.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare this MagickFormatInfo with.

Returns

bool

True when the specified object is equal to the current MagickFormatInfo.

GetHashCode()

Serves as a hash of this type.

public override int GetHashCode()

Returns

int

A hash code for the current instance.

ToString()

Returns a string that represents the current format.

public override string ToString()

Returns

string

A string that represents the current format.

Unregister()

Unregisters this format.

public bool Unregister()

Returns

bool

True when the format was found and unregistered.