Class ExrEncoder

Namespace

SixLabors.ImageSharp.Formats.Exr

Assembly

SixLabors.ImageSharp.dll

Image encoder for writing an image to a stream in the OpenExr Format.

public sealed class ExrEncoder : ImageEncoder, IImageEncoder

Inheritance

object

ImageEncoder

ExrEncoder

Implements

IImageEncoder

Inherited Members

ImageEncoder.SkipMetadata

ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream)

ImageEncoder.EncodeAsync<TPixel>(Image<TPixel>, Stream, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Compression

Gets the compression type to use.

public ExrCompression? Compression { get; init; }

Property Value

ExrCompression?

PixelType

Gets or sets the pixel type of the image.

public ExrPixelType? PixelType { get; set; }

Property Value

ExrPixelType?

Methods

Encode<TPixel>(Image<TPixel>, Stream, CancellationToken)

Encodes the image to the specified stream from the Image<TPixel>.

protected override void Encode<TPixel>(Image<TPixel> image, Stream stream, CancellationToken cancellationToken) where TPixel : unmanaged, IPixel<TPixel>

Parameters

image Image<TPixel>

The Image<TPixel> to encode from.

stream Stream

The Stream to encode the image data to.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Type Parameters

TPixel

The pixel format.

Remarks

This method is designed to support the ImageSharp internal infrastructure and is not recommended for direct use.