• 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
      • Image<TPixel>
      • ImageExtensions
      • ImageFormatException
      • ImageFrame
      • ImageFrame<TPixel>
      • ImageFrameCollection
      • ImageFrameCollection<TPixel>
      • ImageFrameCollectionExtensions
      • ImageInfo
      • ImageProcessingException
      • IndexedImageFrame<TPixel>
      • InvalidImageContentException
      • Matrix3x2Extensions
      • MetadataExtensions
      • Number
      • PixelAccessor<TPixel>
      • PixelAccessorAction<TPixel>
      • PixelAccessorAction<TPixel1, TPixel2, TPixel3>
      • PixelAccessorAction<TPixel1, TPixel2>
      • Point
      • PointF
      • Rational
      • ReadOrigin
      • Rectangle
      • RectangleF
      • SignedRational
      • Size
      • SizeF
      • UnknownImageFormatException
    • SixLabors.ImageSharp.Advanced
      • AdvancedImageExtensions
      • 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
      • LmsAdaptationMatrix
      • LWorkingSpace
      • Rec2020WorkingSpace
      • Rec709WorkingSpace
      • RgbPrimariesChromaticityCoordinates
      • RgbWorkingSpace
      • SRgbWorkingSpace
      • VonKriesChromaticAdaptation
    • SixLabors.ImageSharp.Compression.Zlib
      • DeflateCompressionLevel
    • SixLabors.ImageSharp.Diagnostics
      • MemoryDiagnostics
      • UndisposedAllocationDelegate
    • SixLabors.ImageSharp.Formats
      • DecoderOptions
      • IImageDecoder
      • IImageEncoder
      • IImageFormat
      • IImageFormat<TFormatMetadata, TFormatFrameMetadata>
      • IImageFormat<TFormatMetadata>
      • IImageFormatConfigurationModule
      • IImageFormatDetector
      • ImageDecoder
      • ImageEncoder
      • ImageFormatManager
      • ISpecializedDecoderOptions
      • ISpecializedImageDecoder<T>
      • 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
      • PngChunkFilter
      • PngColorType
      • PngCompressionLevel
      • PngConfigurationModule
      • PngDecoder
      • PngEncoder
      • PngFilterMethod
      • PngFormat
      • PngImageFormatDetector
      • PngInterlaceMode
      • PngMetadata
      • PngTextData
      • PngTransparentColorMode
    • 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
      • WebpBitsPerPixel
      • WebpConfigurationModule
      • WebpDecoder
      • WebpEncoder
      • WebpEncodingMethod
      • WebpFileFormatType
      • WebpFormat
      • WebpFrameMetadata
      • WebpImageFormatDetector
      • WebpMetadata
      • WebpTransparentColorMode
    • SixLabors.ImageSharp.Memory
      • AllocationOptions
      • Buffer2D<T>
      • Buffer2DExtensions
      • Buffer2DRegion<T>
      • IMemoryGroup<T>
      • InvalidMemoryOperationException
      • MemoryAllocator
      • MemoryAllocatorExtensions
      • MemoryAllocatorOptions
      • MemoryGroupEnumerator<T>
      • RowInterval
      • SimpleGcMemoryAllocator
    • SixLabors.ImageSharp.Metadata
      • FrameDecodingMode
      • ImageFrameMetadata
      • ImageMetadata
      • PixelResolutionUnit
    • 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
      • PixelateExtensions
      • PixelRowDelegateExtensions
      • PixelRowOperation
      • PixelRowOperation<T>
      • PolaroidExtensions
      • ProcessingExtensions
      • ProjectiveTransformBuilder
      • QuantizeExtensions
      • ResizeExtensions
      • ResizeMode
      • ResizeOptions
      • RotateExtensions
      • RotateFlipExtensions
      • RotateMode
      • SaturateExtensions
      • SepiaExtensions
      • SkewExtensions
      • SwizzleExtensions
      • TaperCorner
      • TaperSide
      • TransformExtensions
      • 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
      • 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 BmpDecoder

    Image decoder for generating an image out of a Windows bitmap stream.

    Inheritance
    Object
    ImageDecoder
    SpecializedImageDecoder<BmpDecoderOptions>
    BmpDecoder
    Implements
    ISpecializedImageDecoder<BmpDecoderOptions>
    IImageDecoder
    Inherited Members
    SpecializedImageDecoder<BmpDecoderOptions>.Decode<TPixel>(BmpDecoderOptions, Stream)
    SpecializedImageDecoder<BmpDecoderOptions>.Decode(BmpDecoderOptions, Stream)
    SpecializedImageDecoder<BmpDecoderOptions>.DecodeAsync<TPixel>(BmpDecoderOptions, Stream, CancellationToken)
    SpecializedImageDecoder<BmpDecoderOptions>.DecodeAsync(BmpDecoderOptions, Stream, CancellationToken)
    SpecializedImageDecoder<BmpDecoderOptions>.Decode<TPixel>(DecoderOptions, Stream, CancellationToken)
    SpecializedImageDecoder<BmpDecoderOptions>.Decode(DecoderOptions, Stream, CancellationToken)
    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.ScaleToTargetSize(DecoderOptions, Image)
    Namespace: SixLabors.ImageSharp.Formats.Bmp
    Assembly: SixLabors.ImageSharp.dll
    Syntax
    public sealed class BmpDecoder : SpecializedImageDecoder<BmpDecoderOptions>, ISpecializedImageDecoder<BmpDecoderOptions>, IImageDecoder

    Properties

    | Improve this Doc View Source

    Instance

    Gets the shared instance.

    Declaration
    public static BmpDecoder Instance { get; }
    Property Value
    Type Description
    BmpDecoder

    Methods

    | Improve this Doc View Source

    CreateDefaultSpecializedOptions(DecoderOptions)

    A factory method for creating the default specialized options.

    Declaration
    protected override BmpDecoderOptions CreateDefaultSpecializedOptions(DecoderOptions options)
    Parameters
    Type Name Description
    DecoderOptions options

    The general decoder options.

    Returns
    Type Description
    BmpDecoderOptions

    The new T.

    Overrides
    SixLabors.ImageSharp.Formats.SpecializedImageDecoder<SixLabors.ImageSharp.Formats.Bmp.BmpDecoderOptions>.CreateDefaultSpecializedOptions(SixLabors.ImageSharp.Formats.DecoderOptions)
    | Improve this Doc View Source

    Decode(BmpDecoderOptions, Stream, CancellationToken)

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

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

    The containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    Image

    The Image<TPixel>.

    Overrides
    SixLabors.ImageSharp.Formats.SpecializedImageDecoder<SixLabors.ImageSharp.Formats.Bmp.BmpDecoderOptions>.Decode(SixLabors.ImageSharp.Formats.Bmp.BmpDecoderOptions, 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.

    | Improve this Doc View Source

    Decode<TPixel>(BmpDecoderOptions, 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>(BmpDecoderOptions options, Stream stream, CancellationToken cancellationToken)
        where TPixel : struct, IPixel<TPixel>
    Parameters
    Type Name Description
    BmpDecoderOptions options
    Stream stream

    The 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
    SixLabors.ImageSharp.Formats.SpecializedImageDecoder<SixLabors.ImageSharp.Formats.Bmp.BmpDecoderOptions>.Decode<TPixel>(SixLabors.ImageSharp.Formats.Bmp.BmpDecoderOptions, 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.

    | Improve this Doc View Source

    Identify(DecoderOptions, Stream, CancellationToken)

    Reads the raw image information from the specified stream.

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

    The general decoder options.

    Stream stream

    The containing image data.

    CancellationToken cancellationToken

    The token to monitor for cancellation requests.

    Returns
    Type Description
    ImageInfo

    The ImageInfo object.

    Overrides
    ImageDecoder.Identify(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.

    Implements

    ISpecializedImageDecoder<T>
    IImageDecoder
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX