Class FormattedImage

A class encapsulating an image with a particular file encoding.

Inheritance

object

FormattedImage

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Web

Assembly: SixLabors.ImageSharp.Web.dll

Syntax

public sealed class FormattedImage : IDisposable

Constructors

FormattedImage(Image, IImageFormat)

Initializes a new instance of the FormattedImage class.

Declaration

public FormattedImage(Image image, IImageFormat format)

Parameters

Type	Name	Description
Image	image	The image.
IImageFormat	format	The format.

Properties

Encoder

Gets or sets the encoder.

Declaration

public IImageEncoder Encoder { get; set; }

Property Value

Type	Description
IImageEncoder

Format

Gets or sets the format.

Declaration

public IImageFormat Format { get; set; }

Property Value

Type	Description
IImageFormat

Image

Gets the decoded image.

Declaration

public Image Image { get; }

Property Value

Type	Description
Image

Methods

Dispose()

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

Declaration

public void Dispose()

TryGetExifOrientation(out ushort)

Gets the EXIF orientation metadata for the FormattedImage.

Declaration

public bool TryGetExifOrientation(out ushort value)

Parameters

Type	Name	Description
ushort	value	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

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

Implements

IDisposable

See Also

IDisposable