Class PngEncoder

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

Inheritance

Object

PngEncoder

Implements

IImageEncoder

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: SixLabors.ImageSharp.Formats.Png

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class PngEncoder : IImageEncoder, IPngEncoderOptions

Properties

| Improve this Doc View Source

BitDepth

Declaration

public PngBitDepth? BitDepth { get; set; }

Property Value

Type	Description
Nullable<PngBitDepth>

| Improve this Doc View Source

ChunkFilter

Declaration

public PngChunkFilter? ChunkFilter { get; set; }

Property Value

Type	Description
Nullable<PngChunkFilter>

| Improve this Doc View Source

ColorType

Declaration

public PngColorType? ColorType { get; set; }

Property Value

Type	Description
Nullable<PngColorType>

| Improve this Doc View Source

CompressionLevel

Declaration

public PngCompressionLevel CompressionLevel { get; set; }

Property Value

Type	Description
PngCompressionLevel

| Improve this Doc View Source

FilterMethod

Declaration

public PngFilterMethod? FilterMethod { get; set; }

Property Value

Type	Description
Nullable<PngFilterMethod>

| Improve this Doc View Source

Gamma

Declaration

public float? Gamma { get; set; }

Property Value

Type	Description
Nullable<Single>

| Improve this Doc View Source

IgnoreMetadata

Declaration

public bool IgnoreMetadata { get; set; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

InterlaceMethod

Declaration

public PngInterlaceMode? InterlaceMethod { get; set; }

Property Value

Type	Description
Nullable<PngInterlaceMode>

| Improve this Doc View Source

Quantizer

Declaration

public IQuantizer Quantizer { get; set; }

Property Value

Type	Description
IQuantizer

| Improve this Doc View Source

TextCompressionThreshold

Declaration

public int TextCompressionThreshold { get; set; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Threshold

Declaration

public byte Threshold { get; set; }

Property Value

Type	Description
Byte

| Improve this Doc View Source

TransparentColorMode

Declaration

public PngTransparentColorMode TransparentColorMode { get; set; }

Property Value

Type	Description
PngTransparentColorMode

Methods

| Improve this Doc View Source

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

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

Declaration

public void Encode<TPixel>(Image<TPixel> image, Stream stream)
    where TPixel : struct, IPixel<TPixel>

Parameters

Type	Name	Description
Image<TPixel>	image	The Image<TPixel> to encode from.
Stream	stream	The Stream to encode the image data to.

Type Parameters

Name	Description
TPixel	The pixel format.

| Improve this Doc View Source

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

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

Declaration

public async Task EncodeAsync<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 Stream to encode the image data to.
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Type Parameters

Name	Description
TPixel	The pixel format.

Implements

IImageEncoder