Class FormattedImage

Namespace

SixLabors.ImageSharp.Web

Assembly

SixLabors.ImageSharp.Web.dll

A class encapsulating an image with a particular file encoding.

public sealed class FormattedImage : IDisposable

Inheritance

object

FormattedImage

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FormattedImage(Image, IImageFormat)

Initializes a new instance of the FormattedImage class.

public FormattedImage(Image image, IImageFormat format)

Parameters

image Image

The image.

format IImageFormat

The format.

Properties

Encoder

Gets or sets the encoder.

public IImageEncoder Encoder { get; set; }

Property Value

IImageEncoder

Format

Gets or sets the format.

public IImageFormat Format { get; set; }

Property Value

IImageFormat

Image

Gets the decoded image.

public Image Image { get; }

Property Value

Image

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

TryGetExifOrientation(out ushort)

Gets the EXIF orientation metadata for the FormattedImage.

public bool TryGetExifOrientation(out ushort value)

Parameters

value ushort

When this method returns, contains the value parsed from decoded EXIF metadata; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized. Use ExifOrientationMode for comparison.

Returns

bool

true if the FormattedImage contains EXIF orientation metadata for Orientation; otherwise, false.

See Also

IDisposable