• 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 SpecializedImageDecoder<T>

    Acts as a base class for specialized image decoders. Specialized decoders allow for additional options to be passed to the decoder. Types that inherit this decoder are required to implement cancellable synchronous decoding operations only.

    Inheritance
    object
    ImageDecoder
    SpecializedImageDecoder<T>
    BmpDecoder
    JpegDecoder
    PngDecoder
    WebpDecoder
    Implements
    ISpecializedImageDecoder<T>
    IImageDecoder
    Inherited Members
    ImageDecoder.Decode<TPixel>(DecoderOptions, Stream)
    ImageDecoder.Decode(DecoderOptions, Stream)
    ImageDecoder.DecodeAsync<TPixel>(DecoderOptions, Stream, CancellationToken)
    ImageDecoder.DecodeAsync(DecoderOptions, Stream, CancellationToken)
    ImageDecoder.Identify(DecoderOptions, Stream)
    ImageDecoder.IdentifyAsync(DecoderOptions, Stream, CancellationToken)
    ImageDecoder.Identify(DecoderOptions, Stream, CancellationToken)
    ImageDecoder.ScaleToTargetSize(DecoderOptions, Image)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: SixLabors.ImageSharp.Formats
    Assembly: SixLabors.ImageSharp.dll
    Syntax
    public abstract class SpecializedImageDecoder<T> : ImageDecoder, ISpecializedImageDecoder<T>, IImageDecoder where T : ISpecializedDecoderOptions
    Type Parameters
    Name Description
    T

    The type of specialized options.

    Methods

    | Edit this page View Source

    CreateDefaultSpecializedOptions(DecoderOptions)

    A factory method for creating the default specialized options.

    Declaration
    protected abstract T CreateDefaultSpecializedOptions(DecoderOptions options)
    Parameters
    Type Name Description
    DecoderOptions options

    The general decoder options.

    Returns
    Type Description
    T

    The new T.

    | Edit this page View Source

    Decode(DecoderOptions, Stream, CancellationToken)

    Decodes the image from the specified stream to an Image.

    Declaration
    protected override Image Decode(DecoderOptions options, Stream stream, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    DecoderOptions options

    The general decoder options.

    Stream stream

    The Stream containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    Image

    The Image.

    Overrides
    ImageDecoder.Decode(DecoderOptions, Stream, CancellationToken)
    Remarks

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

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    | Edit this page View Source

    Decode(T, Stream)

    Decodes the image from the specified stream to an Image of a specific pixel type.

    Declaration
    public Image Decode(T options, Stream stream)
    Parameters
    Type Name Description
    T options

    The specialized decoder options.

    Stream stream

    The Stream containing image data.

    Returns
    Type Description
    Image

    The Image<TPixel>.

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    | Edit this page View Source

    Decode(T, Stream, CancellationToken)

    Decodes the image from the specified stream to an Image of a specific pixel type.

    Declaration
    protected abstract Image Decode(T options, Stream stream, CancellationToken cancellationToken)
    Parameters
    Type Name Description
    T options

    The specialized decoder options.

    Stream stream

    The Stream containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    Image

    The Image<TPixel>.

    Remarks

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

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    | Edit this page View Source

    DecodeAsync(T, Stream, CancellationToken)

    Decodes the image from the specified stream to an Image of a specific pixel type.

    Declaration
    public Task<Image> DecodeAsync(T options, Stream stream, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    T options

    The specialized decoder options.

    Stream stream

    The Stream containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    Task<Image>

    A Task<TResult> representing the asynchronous operation.

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    | Edit this page View Source

    DecodeAsync<TPixel>(T, Stream, CancellationToken)

    Decodes the image from the specified stream to an Image<TPixel> of a specific pixel type.

    Declaration
    public Task<Image<TPixel>> DecodeAsync<TPixel>(T options, Stream stream, CancellationToken cancellationToken = default) where TPixel : unmanaged, IPixel<TPixel>
    Parameters
    Type Name Description
    T options

    The specialized decoder options.

    Stream stream

    The Stream containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    Task<Image<TPixel>>

    A Task<TResult> representing the asynchronous operation.

    Type Parameters
    Name Description
    TPixel

    The pixel format.

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    | Edit this page View Source

    Decode<TPixel>(DecoderOptions, Stream, CancellationToken)

    Decodes the image from the specified stream to an Image<TPixel> of a specific pixel type.

    Declaration
    protected override Image<TPixel> Decode<TPixel>(DecoderOptions options, Stream stream, CancellationToken cancellationToken) where TPixel : unmanaged, IPixel<TPixel>
    Parameters
    Type Name Description
    DecoderOptions options

    The general decoder options.

    Stream stream

    The Stream containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    Image<TPixel>

    The Image<TPixel>.

    Type Parameters
    Name Description
    TPixel

    The pixel format.

    Overrides
    ImageDecoder.Decode<TPixel>(DecoderOptions, Stream, CancellationToken)
    Remarks

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

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    | Edit this page View Source

    Decode<TPixel>(T, Stream)

    Decodes the image from the specified stream to an Image<TPixel> of a specific pixel type.

    Declaration
    public Image<TPixel> Decode<TPixel>(T options, Stream stream) where TPixel : unmanaged, IPixel<TPixel>
    Parameters
    Type Name Description
    T options

    The specialized decoder options.

    Stream stream

    The Stream containing image data.

    Returns
    Type Description
    Image<TPixel>

    The Image<TPixel>.

    Type Parameters
    Name Description
    TPixel

    The pixel format.

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    | Edit this page View Source

    Decode<TPixel>(T, Stream, CancellationToken)

    Decodes the image from the specified stream to an Image<TPixel> of a specific pixel type.

    Declaration
    protected abstract Image<TPixel> Decode<TPixel>(T options, Stream stream, CancellationToken cancellationToken) where TPixel : unmanaged, IPixel<TPixel>
    Parameters
    Type Name Description
    T options

    The specialized decoder options.

    Stream stream

    The Stream containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    Image<TPixel>

    The Image<TPixel>.

    Type Parameters
    Name Description
    TPixel

    The pixel format.

    Remarks

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

    Exceptions
    Type Condition
    ImageFormatException

    Thrown if the encoded image contains errors.

    Implements

    ISpecializedImageDecoder<T>
    IImageDecoder
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX