Class DecoderOptions

Provides general configuration options for decoding image formats.

Inheritance

object

DecoderOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Formats

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class DecoderOptions

Properties

Configuration

Gets a custom configuration instance to be used by the image processing pipeline.

Declaration

public Configuration Configuration { get; init; }

Property Value

Type	Description
Configuration

MaxFrames

Gets the maximum number of image frames to decode, inclusive.

Declaration

public uint MaxFrames { get; init; }

Property Value

Type	Description
uint

Sampler

Gets the sampler to use when resizing during decoding.

Declaration

public IResampler Sampler { get; init; }

Property Value

Type	Description
IResampler

SkipMetadata

Gets a value indicating whether to ignore encoded metadata when decoding.

Declaration

public bool SkipMetadata { get; init; }

Property Value

Type	Description
bool

TargetSize

Gets the target size to decode the image into. Scaling should use an operation equivalent to Max.

Declaration

public Size? TargetSize { get; init; }

Property Value

Type	Description
Size?