Class FormattedImage

A class encapsulating an image with a particular file encoding.

Inheritance
Object
FormattedImage
Namespace: SixLabors.ImageSharp.Web
Assembly: SixLabors.ImageSharp.Web.dll
Syntax
public sealed class FormattedImage : IDisposable

Constructors

| Improve this Doc View Source

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

| Improve this Doc View Source

Encoder

Gets or sets the encoder.

Declaration
public IImageEncoder Encoder { get; set; }
Property Value
Type Description
IImageEncoder
| Improve this Doc View Source

Format

Gets or sets the format.

Declaration
public IImageFormat Format { get; set; }
Property Value
Type Description
IImageFormat
| Improve this Doc View Source

Image

Gets the decoded image.

Declaration
public Image Image { get; }
Property Value
Type Description
Image

Methods

| Improve this Doc View Source

Dispose()

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

Declaration
public void Dispose()
| Improve this Doc View Source

TryGetExifOrientation(out UInt16)

Gets the EXIF orientation metata for the FormattedImage.

Declaration
public bool TryGetExifOrientation(out ushort value)
Parameters
Type Name Description
UInt16 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 for comparison.
Returns
Type Description
Boolean

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