Class IndexedImageFrame<TPixel>

A pixel-specific image frame where each pixel buffer value represents an index in a color palette.

Inheritance
Object
IndexedImageFrame<TPixel>
Implements
Inherited Members
Namespace: SixLabors.ImageSharp
Assembly: SixLabors.ImageSharp.dll
Syntax
public sealed class IndexedImageFrame<TPixel> : IDisposable where TPixel : struct, IPixel<TPixel>
Type Parameters
Name Description
TPixel

The pixel format.

Properties

| Improve this Doc View Source

Configuration

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

Declaration
public Configuration Configuration { get; }
Property Value
Type Description
Configuration
| Improve this Doc View Source

Height

Gets the height of this IndexedImageFrame<TPixel>.

Declaration
public int Height { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Palette

Gets the color palette of this IndexedImageFrame<TPixel>.

Declaration
public ReadOnlyMemory<TPixel> Palette { get; }
Property Value
Type Description
ReadOnlyMemory<TPixel>
| Improve this Doc View Source

Width

Gets the width of this IndexedImageFrame<TPixel>.

Declaration
public int Width { get; }
Property Value
Type Description
Int32

Methods

| Improve this Doc View Source

DangerousGetRowSpan(Int32)

Gets the representation of the pixels as a ReadOnlySpan<T> of contiguous memory at row rowIndex beginning from the first pixel on that row.

WARNING: Disposing or leaking the underlying IndexedImageFrame<TPixel> while still working with it's Span<T> might lead to memory corruption.

Declaration
public ReadOnlySpan<byte> DangerousGetRowSpan(int rowIndex)
Parameters
Type Name Description
Int32 rowIndex

The row index in the pixel buffer.
Returns
Type Description
ReadOnlySpan<Byte>

The pixel row as a ReadOnlySpan<T>.
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

GetWritablePixelRowSpanUnsafe(Int32)

Gets the representation of the pixels as a Span<T> of contiguous memory at row rowIndex beginning from the first pixel on that row.

Note: Values written to this span are not sanitized against the palette length. Care should be taken during assignment to prevent out-of-bounds errors.

Declaration
public Span<byte> GetWritablePixelRowSpanUnsafe(int rowIndex)
Parameters
Type Name Description
Int32 rowIndex

The row index in the pixel buffer.
Returns
Type Description
Span<Byte>

The pixel row as a Span<T>.

Implements