• 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 ImageFrameCollection

    Encapsulates a pixel-agnostic collection of ImageFrame instances that make up an Image.

    Inheritance
    object
    ImageFrameCollection
    ImageFrameCollection<TPixel>
    Implements
    IDisposable
    IEnumerable<ImageFrame>
    IEnumerable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: SixLabors.ImageSharp
    Assembly: SixLabors.ImageSharp.dll
    Syntax
    public abstract class ImageFrameCollection : IDisposable, IEnumerable<ImageFrame>, IEnumerable

    Properties

    | Edit this page View Source

    Count

    Gets the number of frames.

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

    this[int]

    Gets the ImageFrame at the specified index.

    Declaration
    public ImageFrame this[int index] { get; }
    Parameters
    Type Name Description
    int index

    The index.

    Property Value
    Type Description
    ImageFrame

    The ImageFrame.

    | Edit this page View Source

    NonGenericRootFrame

    Gets the root frame. (Implements RootFrame.)

    Declaration
    protected abstract ImageFrame NonGenericRootFrame { get; }
    Property Value
    Type Description
    ImageFrame
    | Edit this page View Source

    RootFrame

    Gets the root frame.

    Declaration
    public ImageFrame RootFrame { get; }
    Property Value
    Type Description
    ImageFrame

    Methods

    | Edit this page View Source

    AddFrame(ImageFrame)

    Clones the source frame and appends the clone to the end of the collection.

    Declaration
    public ImageFrame AddFrame(ImageFrame source)
    Parameters
    Type Name Description
    ImageFrame source

    The raw pixel data to generate the ImageFrame<TPixel> from.

    Returns
    Type Description
    ImageFrame

    The cloned ImageFrame<TPixel>.

    | Edit this page View Source

    CloneFrame(int)

    Creates an Image<TPixel> with only the frame at the specified index with the same metadata as the original image.

    Declaration
    public Image CloneFrame(int index)
    Parameters
    Type Name Description
    int index

    The zero-based index of the frame to clone.

    Returns
    Type Description
    Image

    The new Image<TPixel> with the specified frame.

    | Edit this page View Source

    Contains(ImageFrame)

    Determines whether the ImageFrameCollection<TPixel> contains the frame.

    Declaration
    public abstract bool Contains(ImageFrame frame)
    Parameters
    Type Name Description
    ImageFrame frame

    The frame.

    Returns
    Type Description
    bool

    true if the ImageFrameCollection<TPixel> contains the specified frame; otherwise, false.

    | Edit this page View Source

    CreateFrame()

    Creates a new ImageFrame<TPixel> and appends it to the end of the collection.

    Declaration
    public ImageFrame CreateFrame()
    Returns
    Type Description
    ImageFrame

    The new ImageFrame<TPixel>.

    | Edit this page View Source

    CreateFrame(Color)

    Creates a new ImageFrame<TPixel> and appends it to the end of the collection.

    Declaration
    public ImageFrame CreateFrame(Color backgroundColor)
    Parameters
    Type Name Description
    Color backgroundColor

    The background color to initialize the pixels with.

    Returns
    Type Description
    ImageFrame

    The new ImageFrame<TPixel>.

    | Edit this page View Source

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public void Dispose()
    | Edit this page View Source

    Dispose(bool)

    Disposes the object and frees resources for the Garbage Collector.

    Declaration
    protected abstract void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    Whether to dispose of managed and unmanaged objects.

    | Edit this page View Source

    EnsureNotDisposed()

    Throws ObjectDisposedException if the image frame is disposed.

    Declaration
    protected void EnsureNotDisposed()
    | Edit this page View Source

    ExportFrame(int)

    Removes the frame at the specified index and creates a new image with only the removed frame with the same metadata as the original image.

    Declaration
    public Image ExportFrame(int index)
    Parameters
    Type Name Description
    int index

    The zero-based index of the frame to export.

    Returns
    Type Description
    Image

    The new Image<TPixel> with the specified frame.

    Exceptions
    Type Condition
    InvalidOperationException

    Cannot remove last frame.

    | Edit this page View Source

    IndexOf(ImageFrame)

    Determines the index of a specific frame in the ImageFrameCollection.

    Declaration
    public abstract int IndexOf(ImageFrame frame)
    Parameters
    Type Name Description
    ImageFrame frame

    The ImageFrame to locate in the ImageFrameCollection.

    Returns
    Type Description
    int

    The index of item if found in the list; otherwise, -1.

    | Edit this page View Source

    InsertFrame(int, ImageFrame)

    Clones and inserts the source into the ImageFrameCollection at the specified index.

    Declaration
    public ImageFrame InsertFrame(int index, ImageFrame source)
    Parameters
    Type Name Description
    int index

    The zero-based index to insert the frame at.

    ImageFrame source

    The ImageFrame to clone and insert into the ImageFrameCollection.

    Returns
    Type Description
    ImageFrame

    The cloned ImageFrame.

    Exceptions
    Type Condition
    ArgumentException

    Frame must have the same dimensions as the image.

    | Edit this page View Source

    MoveFrame(int, int)

    Moves an ImageFrame<TPixel> from sourceIndex to destinationIndex.

    Declaration
    public abstract void MoveFrame(int sourceIndex, int destinationIndex)
    Parameters
    Type Name Description
    int sourceIndex

    The zero-based index of the frame to move.

    int destinationIndex

    The index to move the frame to.

    | Edit this page View Source

    NonGenericAddFrame(ImageFrame)

    Implements AddFrame(ImageFrame).

    Declaration
    protected abstract ImageFrame NonGenericAddFrame(ImageFrame source)
    Parameters
    Type Name Description
    ImageFrame source

    The frame.

    Returns
    Type Description
    ImageFrame

    The new frame.

    | Edit this page View Source

    NonGenericCloneFrame(int)

    Implements CloneFrame(int).

    Declaration
    protected abstract Image NonGenericCloneFrame(int index)
    Parameters
    Type Name Description
    int index

    The index.

    Returns
    Type Description
    Image

    The new image.

    | Edit this page View Source

    NonGenericCreateFrame()

    Implements CreateFrame().

    Declaration
    protected abstract ImageFrame NonGenericCreateFrame()
    Returns
    Type Description
    ImageFrame

    The new frame.

    | Edit this page View Source

    NonGenericCreateFrame(Color)

    Implements CreateFrame().

    Declaration
    protected abstract ImageFrame NonGenericCreateFrame(Color backgroundColor)
    Parameters
    Type Name Description
    Color backgroundColor

    The background color.

    Returns
    Type Description
    ImageFrame

    The new frame.

    | Edit this page View Source

    NonGenericExportFrame(int)

    Implements ExportFrame(int).

    Declaration
    protected abstract Image NonGenericExportFrame(int index)
    Parameters
    Type Name Description
    int index

    The index.

    Returns
    Type Description
    Image

    The new image.

    | Edit this page View Source

    NonGenericGetEnumerator()

    Implements GetEnumerator().

    Declaration
    protected abstract IEnumerator<ImageFrame> NonGenericGetEnumerator()
    Returns
    Type Description
    IEnumerator<ImageFrame>

    The enumerator.

    | Edit this page View Source

    NonGenericGetFrame(int)

    Implements the getter of the indexer.

    Declaration
    protected abstract ImageFrame NonGenericGetFrame(int index)
    Parameters
    Type Name Description
    int index

    The index.

    Returns
    Type Description
    ImageFrame

    The frame.

    | Edit this page View Source

    NonGenericInsertFrame(int, ImageFrame)

    Implements InsertFrame(int, ImageFrame).

    Declaration
    protected abstract ImageFrame NonGenericInsertFrame(int index, ImageFrame source)
    Parameters
    Type Name Description
    int index

    The index.

    ImageFrame source

    The frame.

    Returns
    Type Description
    ImageFrame

    The new frame.

    | Edit this page View Source

    RemoveFrame(int)

    Removes the frame at the specified index and frees all freeable resources associated with it.

    Declaration
    public abstract void RemoveFrame(int index)
    Parameters
    Type Name Description
    int index

    The zero-based index of the frame to remove.

    Exceptions
    Type Condition
    InvalidOperationException

    Cannot remove last frame.

    Implements

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