Struct OrderedDither

An ordered dithering matrix with equal sides of arbitrary length

Implements

IDither

IEquatable<OrderedDither>

IEquatable<IDither>

Inherited Members

ValueType.ToString()

Object.Equals(Object, Object)

Object.GetType()

Object.ReferenceEquals(Object, Object)

Namespace: SixLabors.ImageSharp.Processing.Processors.Dithering

Assembly: SixLabors.ImageSharp.dll

Syntax

public readonly struct OrderedDither : IDither, IEquatable<OrderedDither>, IEquatable<IDither>

Constructors

OrderedDither(UInt32)

Initializes a new instance of the OrderedDither struct.

Declaration

public OrderedDither(uint length)

Parameters

Type	Name	Description
UInt32	length	The length of the matrix sides

Fields

Bayer2x2

Applies order dithering using the 2x2 Bayer dithering matrix.

Declaration

public static OrderedDither Bayer2x2

Field Value

Type	Description
OrderedDither

Bayer4x4

Applies order dithering using the 4x4 Bayer dithering matrix.

Declaration

public static OrderedDither Bayer4x4

Field Value

Type	Description
OrderedDither

Bayer8x8

Applies order dithering using the 8x8 Bayer dithering matrix.

Declaration

public static OrderedDither Bayer8x8

Field Value

Type	Description
OrderedDither

Ordered3x3

Applies order dithering using the 3x3 ordered dithering matrix.

Declaration

public static OrderedDither Ordered3x3

Field Value

Type	Description
OrderedDither

Methods

ApplyPaletteDither<TPaletteDitherImageProcessor, TPixel>(in TPaletteDitherImageProcessor, ImageFrame<TPixel>, Rectangle)

Transforms the image frame applying a dither matrix. This method should be treated as destructive, altering the input pixels.

Declaration

public readonly void ApplyPaletteDither<TPaletteDitherImageProcessor, TPixel>(in TPaletteDitherImageProcessor processor, ImageFrame<TPixel> source, Rectangle bounds)
    where TPaletteDitherImageProcessor : struct, IPaletteDitherImageProcessor<TPixel> where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
TPaletteDitherImageProcessor	processor	The palette dithering processor.
ImageFrame<TPixel>	source	The source image.
Rectangle	bounds	The region of interest bounds.

Type Parameters

Name	Description
TPaletteDitherImageProcessor	The type of palette dithering processor.
TPixel	The pixel format.

ApplyQuantizationDither<TFrameQuantizer, TPixel>(ref TFrameQuantizer, ImageFrame<TPixel>, IndexedImageFrame<TPixel>, Rectangle)

Transforms the quantized image frame applying a dither matrix. This method should be treated as destructive, altering the input pixels.

Declaration

public readonly void ApplyQuantizationDither<TFrameQuantizer, TPixel>(ref TFrameQuantizer quantizer, ImageFrame<TPixel> source, IndexedImageFrame<TPixel> destination, Rectangle bounds)
    where TFrameQuantizer : struct, IQuantizer<TPixel> where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
TFrameQuantizer	quantizer	The frame quantizer.
ImageFrame<TPixel>	source	The source image.
IndexedImageFrame<TPixel>	destination	The destination quantized frame.
Rectangle	bounds	The region of interest bounds.

Type Parameters

Name	Description
TFrameQuantizer	The type of frame quantizer.
TPixel	The pixel format.

Equals(IDither)

Declaration

public readonly bool Equals(IDither other)

Parameters

Type	Name	Description
IDither	other

Returns

Type	Description
Boolean

Equals(OrderedDither)

Declaration

public readonly bool Equals(OrderedDither other)

Parameters

Type	Name	Description
OrderedDither	other

Returns

Type	Description
Boolean

Equals(Object)

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

Operators

Equality(IDither, OrderedDither)

Compares the two OrderedDither instances to determine whether they are equal.

Declaration

public static bool operator ==(IDither left, OrderedDither right)

Parameters

Type	Name	Description
IDither	left	The first source instance.
OrderedDither	right	The second source instance.

Returns

Type	Description
Boolean	The Boolean.

Equality(OrderedDither, IDither)

Compares the two OrderedDither instances to determine whether they are equal.

Declaration

public static bool operator ==(OrderedDither left, IDither right)

Parameters

Type	Name	Description
OrderedDither	left	The first source instance.
IDither	right	The second source instance.

Returns

Type	Description
Boolean	The Boolean.

Equality(OrderedDither, OrderedDither)

Compares the two OrderedDither instances to determine whether they are equal.

Declaration

public static bool operator ==(OrderedDither left, OrderedDither right)

Parameters

Type	Name	Description
OrderedDither	left	The first source instance.
OrderedDither	right	The second source instance.

Returns

Type	Description
Boolean	The Boolean.

Inequality(IDither, OrderedDither)

Compares the two OrderedDither instances to determine whether they are unequal.

Declaration

public static bool operator !=(IDither left, OrderedDither right)

Parameters

Type	Name	Description
IDither	left	The first source instance.
OrderedDither	right	The second source instance.

Returns

Type	Description
Boolean	The Boolean.

Inequality(OrderedDither, IDither)

Compares the two OrderedDither instances to determine whether they are unequal.

Declaration

public static bool operator !=(OrderedDither left, IDither right)

Parameters

Type	Name	Description
OrderedDither	left	The first source instance.
IDither	right	The second source instance.

Returns

Type	Description
Boolean	The Boolean.

Inequality(OrderedDither, OrderedDither)

Compares the two OrderedDither instances to determine whether they are unequal.

Declaration

public static bool operator !=(OrderedDither left, OrderedDither right)

Parameters

Type	Name	Description
OrderedDither	left	The first source instance.
OrderedDither	right	The second source instance.

Returns

Type	Description
Boolean	The Boolean.

Implements

IDither

System.IEquatable<T>

System.IEquatable<T>