Struct ErrorDither

An error diffusion dithering implementation.

Implements

IDither

IEquatable<ErrorDither>

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 ErrorDither : IDither, IEquatable<ErrorDither>, IEquatable<IDither>

Constructors

| Improve this Doc View Source

ErrorDither(in DenseMatrix<Single>, Int32)

Initializes a new instance of the ErrorDither struct.

Declaration

public ErrorDither(in DenseMatrix<float> matrix, int offset)

Parameters

Type	Name	Description
DenseMatrix<Single>	matrix	The diffusion matrix.
Int32	offset	The starting offset within the matrix.

Fields

| Improve this Doc View Source

Atkinson

Applies error diffusion based dithering using the Atkinson image dithering algorithm.

Declaration

public static ErrorDither Atkinson

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

Burkes

Applies error diffusion based dithering using the Burks image dithering algorithm.

Declaration

public static ErrorDither Burkes

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

FloydSteinberg

Applies error diffusion based dithering using the Floyd–Steinberg image dithering algorithm.

Declaration

public static ErrorDither FloydSteinberg

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

JarvisJudiceNinke

Applies error diffusion based dithering using the Jarvis, Judice, Ninke image dithering algorithm.

Declaration

public static ErrorDither JarvisJudiceNinke

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

Sierra2

Applies error diffusion based dithering using the Sierra2 image dithering algorithm.

Declaration

public static ErrorDither Sierra2

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

Sierra3

Applies error diffusion based dithering using the Sierra3 image dithering algorithm.

Declaration

public static ErrorDither Sierra3

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

SierraLite

Applies error diffusion based dithering using the Sierra Lite image dithering algorithm.

Declaration

public static ErrorDither SierraLite

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

StevensonArce

Applies error diffusion based dithering using the Stevenson-Arce image dithering algorithm.

Declaration

public static ErrorDither StevensonArce

Field Value

Type	Description
ErrorDither

| Improve this Doc View Source

Stucki

Applies error diffusion based dithering using the Stucki image dithering algorithm.

Declaration

public static ErrorDither Stucki

Field Value

Type	Description
ErrorDither

Methods

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

Equals(ErrorDither)

Declaration

public readonly bool Equals(ErrorDither other)

Parameters

Type	Name	Description
ErrorDither	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(IDither)

Declaration

public readonly bool Equals(IDither other)

Parameters

Type	Name	Description
IDither	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Object)

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

Operators

| Improve this Doc View Source

Equality(ErrorDither, ErrorDither)

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

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	The Boolean.

| Improve this Doc View Source

Equality(ErrorDither, IDither)

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

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	The Boolean.

| Improve this Doc View Source

Equality(IDither, ErrorDither)

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

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	The Boolean.

| Improve this Doc View Source

Inequality(ErrorDither, ErrorDither)

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

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	The Boolean.

| Improve this Doc View Source

Inequality(ErrorDither, IDither)

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

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	The Boolean.

| Improve this Doc View Source

Inequality(IDither, ErrorDither)

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

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	The Boolean.

Implements

IDither

System.IEquatable<T>