Class GifEncoderOptions

GIF encoder options.

Inheritance
System.Object
GifEncoderOptions
Namespace: PhotoSauce.MagicScaler
Assembly: PhotoSauce.MagicScaler.dll
Syntax
public sealed class GifEncoderOptions : ValueType, IIndexedEncoderOptions, IEncoderOptions

Constructors

GifEncoderOptions(Int32, Int32[], DitherMode)

GIF encoder options.

Declaration
public GifEncoderOptions(int MaxPaletteSize, int[] PredefinedPalette, DitherMode Dither)
Parameters
Type Name Description
System.Int32 MaxPaletteSize

The maximum number of entries in the target palette. Actual palette may have fewer entries if the image contains fewer colors.
System.Int32[] PredefinedPalette

The palette to use when quantizing the image. If null, a custom palette will be created from the image.
DitherMode Dither

Controls dithering when palette has fewer colors than the image.

Properties

Default

Default GIF encoder options.

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

Dither

Controls dithering when palette has fewer colors than the image.

Declaration
public DitherMode Dither { get; set; }
Property Value
Type Description
DitherMode

MaxPaletteSize

The maximum number of entries in the target palette. Actual palette may have fewer entries if the image contains fewer colors.

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

PredefinedPalette

The palette to use when quantizing the image. If null, a custom palette will be created from the image.

Declaration
public int[] PredefinedPalette { get; set; }
Property Value
Type Description
System.Int32[]

Methods

Deconstruct(out Int32, out Int32[], out DitherMode)

Declaration
public void Deconstruct(out int MaxPaletteSize, out int[] PredefinedPalette, out DitherMode Dither)
Parameters
Type Name Description
System.Int32 MaxPaletteSize
System.Int32[] PredefinedPalette
DitherMode Dither

Equals(GifEncoderOptions)

Declaration
public bool Equals(GifEncoderOptions other)
Parameters
Type Name Description
GifEncoderOptions 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(GifEncoderOptions, GifEncoderOptions)

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

Inequality(GifEncoderOptions, GifEncoderOptions)

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

Implements

System.IEquatable<>