Class JpegEncoderOptions

JPEG encoder options.

Inheritance
System.Object
JpegEncoderOptions
Namespace: PhotoSauce.MagicScaler
Assembly: PhotoSauce.MagicScaler.dll
Syntax
public sealed class JpegEncoderOptions : ValueType, ILossyEncoderOptions, IPlanarEncoderOptions, IEncoderOptions

Constructors

JpegEncoderOptions(Int32, ChromaSubsampleMode, Boolean)

JPEG encoder options.

Declaration
public JpegEncoderOptions(int Quality, ChromaSubsampleMode Subsample, bool SuppressApp0)
Parameters
Type Name Description
System.Int32 Quality

The desired image quality in the range of 0-100, where 1 is minimum quality and 100 is maximum quality. A value of 0 indicates quality should be set automatically.
ChromaSubsampleMode Subsample

The type of chroma subsampling to use when encoding.
System.Boolean SuppressApp0

True to skip writing the JFIF APP0 metadata header, false to include it.

Properties

Default

Default JPEG encoder options.

Declaration
public static JpegEncoderOptions Default { get; }
Property Value
Type Description
JpegEncoderOptions

Quality

The desired image quality in the range of 0-100, where 1 is minimum quality and 100 is maximum quality. A value of 0 indicates quality should be set automatically.

Declaration
public int Quality { get; set; }
Property Value
Type Description
System.Int32

Subsample

The type of chroma subsampling to use when encoding.

Declaration
public ChromaSubsampleMode Subsample { get; set; }
Property Value
Type Description
ChromaSubsampleMode

SuppressApp0

True to skip writing the JFIF APP0 metadata header, false to include it.

Declaration
public bool SuppressApp0 { get; set; }
Property Value
Type Description
System.Boolean

Methods

Deconstruct(out Int32, out ChromaSubsampleMode, out Boolean)

Declaration
public void Deconstruct(out int Quality, out ChromaSubsampleMode Subsample, out bool SuppressApp0)
Parameters
Type Name Description
System.Int32 Quality
ChromaSubsampleMode Subsample
System.Boolean SuppressApp0

Equals(JpegEncoderOptions)

Declaration
public bool Equals(JpegEncoderOptions other)
Parameters
Type Name Description
JpegEncoderOptions other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Equality(JpegEncoderOptions, JpegEncoderOptions)

Declaration
public static bool operator ==(JpegEncoderOptions left, JpegEncoderOptions right)
Parameters
Type Name Description
JpegEncoderOptions left
JpegEncoderOptions right
Returns
Type Description
System.Boolean

Inequality(JpegEncoderOptions, JpegEncoderOptions)

Declaration
public static bool operator !=(JpegEncoderOptions left, JpegEncoderOptions right)
Parameters
Type Name Description
JpegEncoderOptions left
JpegEncoderOptions right
Returns
Type Description
System.Boolean

Implements

System.IEquatable<>