Struct OctreeQuantizer<TPixel>

Namespace

SixLabors.ImageSharp.Processing.Processors.Quantization

Assembly

SixLabors.ImageSharp.dll

Encapsulates methods to calculate the color palette if an image using an Octree pattern. http://msdn.microsoft.com/en-us/library/aa479306.aspx

public struct OctreeQuantizer<TPixel> : IQuantizer<TPixel>, IDisposable where TPixel : unmanaged, IPixel<TPixel>

Type Parameters

TPixel

The pixel format.

Implements

IQuantizer<TPixel>

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

QuantizerUtilities.BuildPaletteAndQuantizeFrame<TPixel>(IQuantizer<TPixel>, ImageFrame<TPixel>, Rectangle)

QuantizerUtilities.BuildPalette<TPixel>(IQuantizer<TPixel>, IPixelSamplingStrategy, ImageFrame<TPixel>)

QuantizerUtilities.BuildPalette<TPixel>(IQuantizer<TPixel>, IPixelSamplingStrategy, Image<TPixel>)

Constructors

OctreeQuantizer(Configuration, QuantizerOptions)

Initializes a new instance of the OctreeQuantizer<TPixel> struct.

public OctreeQuantizer(Configuration configuration, QuantizerOptions options)

Parameters

configuration Configuration

The configuration which allows altering default behaviour or extending the library.

options QuantizerOptions

The quantizer options defining quantization rules.

Properties

Configuration

Gets the configuration.

public readonly Configuration Configuration { get; }

Property Value

Configuration

Options

Gets the quantizer options defining quantization rules.

public readonly QuantizerOptions Options { get; }

Property Value

QuantizerOptions

Palette

Gets the quantized color palette.

public readonly ReadOnlyMemory<TPixel> Palette { get; }

Property Value

ReadOnlyMemory<TPixel>

Exceptions

InvalidOperationException

The palette has not been built via AddPaletteColors(Buffer2DRegion<TPixel>).

Methods

AddPaletteColors(Buffer2DRegion<TPixel>)

Adds colors to the quantized palette from the given pixel source.

public void AddPaletteColors(Buffer2DRegion<TPixel> pixelRegion)

Parameters

pixelRegion Buffer2DRegion<TPixel>

The Buffer2DRegion<T> of source pixels to register.

Dispose()

public void Dispose()

GetQuantizedColor(TPixel, out TPixel)

Returns the index and color from the quantized palette corresponding to the given color.

public readonly byte GetQuantizedColor(TPixel color, out TPixel match)

Parameters

color TPixel

The color to match.

match TPixel

The matched color.

Returns

byte

The byte index.

QuantizeFrame(ImageFrame<TPixel>, Rectangle)

Quantizes an image frame and return the resulting output pixels.

public readonly IndexedImageFrame<TPixel> QuantizeFrame(ImageFrame<TPixel> source, Rectangle bounds)

Parameters

source ImageFrame<TPixel>

The source image frame to quantize.

bounds Rectangle

The bounds within the frame to quantize.

Returns

IndexedImageFrame<TPixel>

A IndexedImageFrame<TPixel> representing a quantized version of the source frame pixels.

Remarks

Only executes the second (quantization) step. The palette has to be built by calling AddPaletteColors(Buffer2DRegion<TPixel>). To run both steps, use BuildPaletteAndQuantizeFrame<TPixel>(IQuantizer<TPixel>, ImageFrame<TPixel>, Rectangle).