• Articles
  • API Documentation
Search Results for

    Show / Hide Table of Contents
    • SixLabors.ImageSharp
      • ByteOrder
      • Color
      • ColorMatrix
      • Configuration
      • DenseMatrix<T>
      • GeometryUtilities
      • GraphicOptionsDefaultsExtensions
      • GraphicsOptions
      • IDeepCloneable
      • IDeepCloneable<T>
      • Image
      • ImageExtensions
      • ImageFormatException
      • ImageFrame
      • ImageFrameCollection
      • ImageFrameCollectionExtensions
      • ImageFrameCollection<TPixel>
      • ImageFrame<TPixel>
      • ImageInfo
      • ImageProcessingException
      • Image<TPixel>
      • IndexedImageFrame<TPixel>
      • InvalidImageContentException
      • Matrix3x2Extensions
      • MetadataExtensions
      • Number
      • PixelAccessorAction<TPixel>
      • PixelAccessorAction<TPixel1, TPixel2>
      • PixelAccessorAction<TPixel1, TPixel2, TPixel3>
      • PixelAccessor<TPixel>
      • Point
      • PointF
      • Rational
      • ReadOrigin
      • Rectangle
      • RectangleF
      • SignedRational
      • Size
      • SizeF
      • UnknownImageFormatException
    • SixLabors.ImageSharp.Advanced
      • AdvancedImageExtensions
      • IConfigurationProvider
      • IImageVisitor
      • IImageVisitorAsync
      • IRowIntervalOperation
      • IRowIntervalOperation<TBuffer>
      • IRowOperation
      • IRowOperation<TBuffer>
      • ParallelExecutionSettings
      • ParallelRowIterator
    • SixLabors.ImageSharp.ColorSpaces
      • CieLab
      • CieLch
      • CieLchuv
      • CieLuv
      • CieXyy
      • CieXyz
      • Cmyk
      • Hsl
      • Hsv
      • HunterLab
      • Illuminants
      • LinearRgb
      • Lms
      • Rgb
      • RgbWorkingSpaces
      • YCbCr
    • SixLabors.ImageSharp.ColorSpaces.Companding
      • GammaCompanding
      • LCompanding
      • Rec2020Companding
      • Rec709Companding
      • SRgbCompanding
    • SixLabors.ImageSharp.ColorSpaces.Conversion
      • CieXyChromaticityCoordinates
      • ColorSpaceConverter
      • ColorSpaceConverterOptions
      • GammaWorkingSpace
      • IChromaticAdaptation
      • LWorkingSpace
      • LmsAdaptationMatrix
      • Rec2020WorkingSpace
      • Rec709WorkingSpace
      • RgbPrimariesChromaticityCoordinates
      • RgbWorkingSpace
      • SRgbWorkingSpace
      • VonKriesChromaticAdaptation
    • SixLabors.ImageSharp.Compression.Zlib
      • DeflateCompressionLevel
    • SixLabors.ImageSharp.Diagnostics
      • MemoryDiagnostics
      • UndisposedAllocationDelegate
    • SixLabors.ImageSharp.Formats
      • DecoderOptions
      • IImageDecoder
      • IImageEncoder
      • IImageFormat
      • IImageFormatConfigurationModule
      • IImageFormatDetector
      • IImageFormat<TFormatMetadata>
      • IImageFormat<TFormatMetadata, TFormatFrameMetadata>
      • ISpecializedDecoderOptions
      • ISpecializedImageDecoder<T>
      • ImageDecoder
      • ImageEncoder
      • ImageFormatManager
      • PixelTypeInfo
      • QuantizingImageEncoder
      • SpecializedImageDecoder<T>
    • SixLabors.ImageSharp.Formats.Bmp
      • BmpBitsPerPixel
      • BmpConfigurationModule
      • BmpDecoder
      • BmpDecoderOptions
      • BmpEncoder
      • BmpFileMarkerType
      • BmpFormat
      • BmpImageFormatDetector
      • BmpInfoHeaderType
      • BmpMetadata
      • RleSkippedPixelHandling
    • SixLabors.ImageSharp.Formats.Gif
      • GifColorTableMode
      • GifConfigurationModule
      • GifDecoder
      • GifDisposalMethod
      • GifEncoder
      • GifFormat
      • GifFrameMetadata
      • GifImageFormatDetector
      • GifMetadata
      • IGifExtension
    • SixLabors.ImageSharp.Formats.Jpeg
      • JpegConfigurationModule
      • JpegDecoder
      • JpegDecoderOptions
      • JpegDecoderResizeMode
      • JpegEncoder
      • JpegEncodingColor
      • JpegFormat
      • JpegImageFormatDetector
      • JpegMetadata
    • SixLabors.ImageSharp.Formats.Jpeg.Components.Encoder
      • HuffmanSpec
    • SixLabors.ImageSharp.Formats.Pbm
      • PbmColorType
      • PbmComponentType
      • PbmConfigurationModule
      • PbmDecoder
      • PbmEncoder
      • PbmEncoding
      • PbmFormat
      • PbmImageFormatDetector
      • PbmMetadata
    • SixLabors.ImageSharp.Formats.Png
      • PngBitDepth
      • PngBlendMethod
      • PngChunkFilter
      • PngColorType
      • PngConfigurationModule
      • PngCrcChunkHandling
      • PngDecoder
      • PngDecoderOptions
      • PngDisposalMethod
      • PngEncoder
      • PngFilterMethod
      • PngFormat
      • PngFrameMetadata
      • PngImageFormatDetector
      • PngInterlaceMode
      • PngMetadata
      • PngTransparentColorMode
    • SixLabors.ImageSharp.Formats.Png.Chunks
      • PngTextData
    • SixLabors.ImageSharp.Formats.Qoi
      • QoiChannels
      • QoiColorSpace
      • QoiConfigurationModule
      • QoiEncoder
      • QoiFormat
      • QoiImageFormatDetector
      • QoiMetadata
    • SixLabors.ImageSharp.Formats.Tga
      • TgaBitsPerPixel
      • TgaCompression
      • TgaConfigurationModule
      • TgaDecoder
      • TgaEncoder
      • TgaFormat
      • TgaImageFormatDetector
      • TgaImageType
      • TgaImageTypeExtensions
      • TgaMetadata
    • SixLabors.ImageSharp.Formats.Tiff
      • TiffBitsPerPixel
      • TiffBitsPerSample
      • TiffConfigurationModule
      • TiffDecoder
      • TiffEncoder
      • TiffFormat
      • TiffFormatType
      • TiffFrameMetadata
      • TiffImageFormatDetector
      • TiffMetadata
    • SixLabors.ImageSharp.Formats.Tiff.Compression
      • FaxCompressionOptions
    • SixLabors.ImageSharp.Formats.Tiff.Compression.Decompressors
      • LzwString
    • SixLabors.ImageSharp.Formats.Tiff.Constants
      • TiffCompression
      • TiffInkSet
      • TiffNewSubfileType
      • TiffPhotometricInterpretation
      • TiffPlanarConfiguration
      • TiffPredictor
      • TiffSampleFormat
      • TiffSubfileType
    • SixLabors.ImageSharp.Formats.Webp
      • BackgroundColorHandling
      • WebpBitsPerPixel
      • WebpBlendMethod
      • WebpConfigurationModule
      • WebpDecoder
      • WebpDecoderOptions
      • WebpDisposalMethod
      • WebpEncoder
      • WebpEncodingMethod
      • WebpFileFormatType
      • WebpFormat
      • WebpFrameMetadata
      • WebpImageFormatDetector
      • WebpMetadata
      • WebpTransparentColorMode
    • SixLabors.ImageSharp.Memory
      • AllocationOptions
      • Buffer2DExtensions
      • Buffer2DRegion<T>
      • Buffer2D<T>
      • IMemoryGroup<T>
      • InvalidMemoryOperationException
      • MemoryAllocator
      • MemoryAllocatorExtensions
      • MemoryAllocatorOptions
      • RowInterval
      • SimpleGcMemoryAllocator
    • SixLabors.ImageSharp.Metadata
      • ImageFrameMetadata
      • ImageMetadata
      • PixelResolutionUnit
    • SixLabors.ImageSharp.Metadata.Profiles.Cicp
      • CicpColorPrimaries
      • CicpMatrixCoefficients
      • CicpProfile
      • CicpTransferCharacteristics
    • SixLabors.ImageSharp.Metadata.Profiles.Exif
      • EncodedString
      • EncodedString.CharacterCode
      • ExifDataType
      • ExifOrientationMode
      • ExifParts
      • ExifProfile
      • ExifTag
      • ExifTag<TValueType>
      • IExifValue
      • IExifValue<TValueType>
    • SixLabors.ImageSharp.Metadata.Profiles.Icc
      • IccColorSpaceType
      • IccDeviceAttribute
      • IccPrimaryPlatformType
      • IccProfile
      • IccProfileClass
      • IccProfileFlag
      • IccProfileHeader
      • IccProfileId
      • IccProfileTag
      • IccRenderingIntent
      • IccTagDataEntry
      • IccTypeSignature
      • IccVersion
      • InvalidIccProfileException
    • SixLabors.ImageSharp.Metadata.Profiles.Iptc
      • IptcProfile
      • IptcTag
      • IptcTagExtensions
      • IptcValue
    • SixLabors.ImageSharp.Metadata.Profiles.Xmp
      • XmpProfile
    • SixLabors.ImageSharp.PixelFormats
      • A8
      • Abgr32
      • Argb32
      • Bgr24
      • Bgr565
      • Bgra32
      • Bgra4444
      • Bgra5551
      • Byte4
      • HalfSingle
      • HalfVector2
      • HalfVector4
      • IPackedVector<TPacked>
      • IPixel
      • IPixel<TSelf>
      • L16
      • L8
      • La16
      • La32
      • NormalizedByte2
      • NormalizedByte4
      • NormalizedShort2
      • NormalizedShort4
      • PixelAlphaCompositionMode
      • PixelAlphaRepresentation
      • PixelBlender<TPixel>
      • PixelColorBlendingMode
      • PixelConversionModifiers
      • PixelOperations<TPixel>
      • Rg32
      • Rgb24
      • Rgb48
      • Rgba1010102
      • Rgba32
      • Rgba64
      • RgbaVector
      • Short2
      • Short4
    • SixLabors.ImageSharp.Processing
      • AdaptiveThresholdExtensions
      • AffineTransformBuilder
      • AnchorPositionMode
      • AutoOrientExtensions
      • BackgroundColorExtensions
      • BinaryDitherExtensions
      • BinaryThresholdExtensions
      • BinaryThresholdMode
      • BlackWhiteExtensions
      • BokehBlurExtensions
      • BoxBlurExtensions
      • BrightnessExtensions
      • ColorBlindnessExtensions
      • ColorBlindnessMode
      • ContrastExtensions
      • CropExtensions
      • DetectEdgesExtensions
      • DitherExtensions
      • DrawImageExtensions
      • EntropyCropExtensions
      • FilterExtensions
      • FlipExtensions
      • FlipMode
      • GaussianBlurExtensions
      • GaussianSharpenExtensions
      • GlowExtensions
      • GrayscaleExtensions
      • GrayscaleMode
      • HistogramEqualizationExtensions
      • HueExtensions
      • IImageProcessingContext
      • InvertExtensions
      • KnownDitherings
      • KnownEdgeDetectorKernels
      • KnownFilterMatrices
      • KnownQuantizers
      • KnownResamplers
      • KodachromeExtensions
      • LightnessExtensions
      • LomographExtensions
      • MedianBlurExtensions
      • OilPaintExtensions
      • OpacityExtensions
      • PadExtensions
      • PixelRowDelegateExtensions
      • PixelRowOperation
      • PixelRowOperation<T>
      • PixelateExtensions
      • PolaroidExtensions
      • ProcessingExtensions
      • ProjectiveTransformBuilder
      • QuantizeExtensions
      • ResizeExtensions
      • ResizeMode
      • ResizeOptions
      • RotateExtensions
      • RotateFlipExtensions
      • RotateMode
      • SaturateExtensions
      • SepiaExtensions
      • SkewExtensions
      • SwizzleExtensions
      • TaperCorner
      • TaperSide
      • TransformExtensions
      • TransformSpace
      • VignetteExtensions
    • SixLabors.ImageSharp.Processing.Processors
      • CloningImageProcessor
      • CloningImageProcessor<TPixel>
      • ICloningImageProcessor
      • ICloningImageProcessor<TPixel>
      • IImageProcessor
      • IImageProcessor<TPixel>
      • ImageProcessor<TPixel>
    • SixLabors.ImageSharp.Processing.Processors.Binarization
      • AdaptiveThresholdProcessor
      • BinaryThresholdProcessor
    • SixLabors.ImageSharp.Processing.Processors.Convolution
      • BokehBlurProcessor
      • BorderWrappingMode
      • BoxBlurProcessor
      • EdgeDetector2DKernel
      • EdgeDetector2DProcessor
      • EdgeDetectorCompassKernel
      • EdgeDetectorCompassProcessor
      • EdgeDetectorKernel
      • EdgeDetectorProcessor
      • GaussianBlurProcessor
      • GaussianSharpenProcessor
      • MedianBlurProcessor
    • SixLabors.ImageSharp.Processing.Processors.Dithering
      • ErrorDither
      • IDither
      • IPaletteDitherImageProcessor<TPixel>
      • OrderedDither
      • PaletteDitherProcessor
    • SixLabors.ImageSharp.Processing.Processors.Drawing
      • DrawImageProcessor
    • SixLabors.ImageSharp.Processing.Processors.Effects
      • IPixelRowDelegate
      • OilPaintingProcessor
      • PixelateProcessor
    • SixLabors.ImageSharp.Processing.Processors.Filters
      • AchromatomalyProcessor
      • AchromatopsiaProcessor
      • BlackWhiteProcessor
      • BrightnessProcessor
      • ContrastProcessor
      • DeuteranomalyProcessor
      • DeuteranopiaProcessor
      • FilterProcessor
      • GrayscaleBt601Processor
      • GrayscaleBt709Processor
      • HueProcessor
      • InvertProcessor
      • KodachromeProcessor
      • LightnessProcessor
      • LomographProcessor
      • OpacityProcessor
      • PolaroidProcessor
      • ProtanomalyProcessor
      • ProtanopiaProcessor
      • SaturateProcessor
      • SepiaProcessor
      • TritanomalyProcessor
      • TritanopiaProcessor
    • SixLabors.ImageSharp.Processing.Processors.Normalization
      • AdaptiveHistogramEqualizationProcessor
      • AdaptiveHistogramEqualizationSlidingWindowProcessor
      • AutoLevelProcessor
      • GlobalHistogramEqualizationProcessor
      • HistogramEqualizationMethod
      • HistogramEqualizationOptions
      • HistogramEqualizationProcessor
    • SixLabors.ImageSharp.Processing.Processors.Overlays
      • BackgroundColorProcessor
      • GlowProcessor
      • VignetteProcessor
    • SixLabors.ImageSharp.Processing.Processors.Quantization
      • ColorMatchingMode
      • DefaultPixelSamplingStrategy
      • ExtensivePixelSamplingStrategy
      • IPixelSamplingStrategy
      • IQuantizer
      • IQuantizer<TPixel>
      • OctreeQuantizer
      • OctreeQuantizer<TPixel>
      • PaletteQuantizer
      • QuantizeProcessor
      • QuantizerConstants
      • QuantizerOptions
      • QuantizerUtilities
      • WebSafePaletteQuantizer
      • WernerPaletteQuantizer
      • WuQuantizer
    • SixLabors.ImageSharp.Processing.Processors.Transforms
      • AffineTransformProcessor
      • AutoOrientProcessor
      • BicubicResampler
      • BoxResampler
      • CropProcessor
      • CubicResampler
      • DegenerateTransformException
      • EntropyCropProcessor
      • FlipProcessor
      • IResampler
      • IResamplingTransformImageProcessor<TPixel>
      • ISwizzler
      • LanczosResampler
      • NearestNeighborResampler
      • ProjectiveTransformProcessor
      • ResizeProcessor
      • RotateProcessor
      • SkewProcessor
      • SwizzleProcessor<TSwizzler>
      • TriangleResampler
      • WelchResampler

    Class PngEncoder

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

    Inheritance
    object
    ImageEncoder
    QuantizingImageEncoder
    PngEncoder
    Implements
    IImageEncoder
    Inherited Members
    QuantizingImageEncoder.Quantizer
    QuantizingImageEncoder.PixelSamplingStrategy
    ImageEncoder.SkipMetadata
    ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream)
    ImageEncoder.EncodeAsync<TPixel>(Image<TPixel>, Stream, CancellationToken)
    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 class PngEncoder : QuantizingImageEncoder, IImageEncoder

    Properties

    | Edit this page 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; init; }
    Property Value
    Type Description
    PngBitDepth?
    | Edit this page View Source

    ChunkFilter

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

    Declaration
    public PngChunkFilter? ChunkFilter { get; init; }
    Property Value
    Type Description
    PngChunkFilter?
    | Edit this page View Source

    ColorType

    Gets the color type.

    Declaration
    public PngColorType? ColorType { get; init; }
    Property Value
    Type Description
    PngColorType?
    | Edit this page View Source

    CompressionLevel

    Gets the compression level 1-9. Defaults to SixLabors.ImageSharp.Formats.Png.PngCompressionLevel.DefaultCompression.

    Declaration
    public PngCompressionLevel CompressionLevel { get; init; }
    Property Value
    Type Description
    PngCompressionLevel
    | Edit this page View Source

    FilterMethod

    Gets the filter method.

    Declaration
    public PngFilterMethod? FilterMethod { get; init; }
    Property Value
    Type Description
    PngFilterMethod?
    | Edit this page View Source

    Gamma

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

    Declaration
    public float? Gamma { get; init; }
    Property Value
    Type Description
    float?

    The gamma value of the image.

    | Edit this page View Source

    InterlaceMethod

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

    Declaration
    public PngInterlaceMode? InterlaceMethod { get; init; }
    Property Value
    Type Description
    PngInterlaceMode?
    | Edit this page View Source

    TextCompressionThreshold

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

    Declaration
    public int TextCompressionThreshold { get; init; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    Threshold

    Gets the transparency threshold.

    Declaration
    public byte Threshold { get; init; }
    Property Value
    Type Description
    byte
    | Edit this page 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; init; }
    Property Value
    Type Description
    PngTransparentColorMode

    Methods

    | Edit this page 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 : unmanaged, 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.

    Type Parameters
    Name Description
    TPixel

    The pixel format.

    Overrides
    ImageEncoder.Encode<TPixel>(Image<TPixel>, Stream, CancellationToken)
    Remarks

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

    Implements

    IImageEncoder
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX