Class PngEncoder

Image encoder for writing image data to a stream in png format.

Inheritance
Object
ImageEncoder
QuantizingImageEncoder
PngEncoder
Implements
Inherited Members
Namespace: SixLabors.ImageSharp.Formats.Png
Assembly: SixLabors.ImageSharp.dll
Syntax
public class PngEncoder : QuantizingImageEncoder, IImageEncoder

Constructors

| Improve this Doc View Source

PngEncoder()

Initializes a new instance of the PngEncoder class.

Declaration
public PngEncoder()

Properties

| Improve this Doc View Source

BitDepth

Gets the number of bits per sample or per palette index (not per pixel). Not all values are allowed for all ColorType values.

Declaration
public PngBitDepth? BitDepth { get; set; }
Property Value
Type Description
Nullable<PngBitDepth>
| Improve this Doc View Source

ChunkFilter

Gets the chunk filter method. This allows to filter ancillary chunks.

Declaration
public PngChunkFilter? ChunkFilter { get; set; }
Property Value
Type Description
Nullable<PngChunkFilter>
| Improve this Doc View Source

ColorType

Gets the color type.

Declaration
public PngColorType? ColorType { get; set; }
Property Value
Type Description
Nullable<PngColorType>
| Improve this Doc View Source

CompressionLevel

Gets the compression level 1-9. Defaults to DefaultCompression.

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

FilterMethod

Gets the filter method.

Declaration
public PngFilterMethod? FilterMethod { get; set; }
Property Value
Type Description
Nullable<PngFilterMethod>
| Improve this Doc View Source

Gamma

Gets the gamma value, that will be written the image.

Declaration
public float? Gamma { get; set; }
Property Value
Type Description
Nullable<Single>

The gamma value of the image.
| Improve this Doc View Source

InterlaceMethod

Gets a value indicating whether this instance should write an Adam7 interlaced image.

Declaration
public PngInterlaceMode? InterlaceMethod { get; set; }
Property Value
Type Description
Nullable<PngInterlaceMode>
| Improve this Doc View Source

TextCompressionThreshold

Gets the threshold of characters in text metadata, when compression should be used.

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

Threshold

Gets the transparency threshold.

Declaration
public byte Threshold { get; set; }
Property Value
Type Description
Byte
| Improve this Doc View Source

TransparentColorMode

Gets a value indicating whether fully transparent pixels that may contain R, G, B values which are not 0, should be converted to transparent black, which can yield in better compression in some cases.

Declaration
public PngTransparentColorMode TransparentColorMode { get; set; }
Property Value
Type Description
PngTransparentColorMode

Methods

| Improve this Doc View Source

Encode<TPixel>(Image<TPixel>, Stream, CancellationToken)

Encodes the image to the specified stream from the Image<TPixel>.

Declaration
protected override void Encode<TPixel>(Image<TPixel> image, Stream stream, CancellationToken cancellationToken)
    where TPixel : struct, IPixel<TPixel>
Parameters
Type Name Description
Image<TPixel> image

The Image<TPixel> to encode from.
Stream stream

The to encode the image data to.
CancellationToken cancellationToken

The token to monitor for cancellation requests.
Type Parameters
Name Description
TPixel

The pixel format.
Overrides
SixLabors.ImageSharp.Formats.ImageEncoder.Encode<TPixel>(SixLabors.ImageSharp.Image<TPixel>, Stream, CancellationToken)
Remarks

This method is designed to support the ImageSharp internal infrastructure and is not recommended for direct use.

Implements