ImageFrameCollection<TPixel> Class

The typed, read-only, ordered list of the displayed frames of an Image<TPixel>. Never empty.

public sealed class ImageFrameCollection<TPixel> : ImageFrameCollection, IEnumerable<ImageFrame<TPixel>>, IReadOnlyCollection<ImageFrame<TPixel>>, IReadOnlyList<ImageFrame<TPixel>>, IEnumerable where TPixel : unmanaged

Type parameters

TPixel
The pixel type.

Remarks

The typed and untyped collections of an image expose the same frame objects.

Inheritance
ImageFrameCollection ImageFrameCollection<TPixel>
Implements

Nested types

NameDescription
ImageFrameCollection<TPixel>.EnumeratorEnumerates the frames of an ImageFrameCollection<TPixel>.

Properties

NameDescription
CountGets the number of displayed frames. Always at least 1.

Gets the number of displayed frames. Always at least 1.

public override int Count { get; }

Property value

int

Exceptions

ObjectDisposedException
The image is disposed.

Indexers

NameDescription
this[int]Gets the frame at the specified index.

Gets the frame at the specified index.

public override ImageFrame<TPixel> this[int index] { get; }

Parameters

index int
The index of the frame.

Property value

ImageFrame<TPixel>

Exceptions

ArgumentOutOfRangeException
index is out of range.
ObjectDisposedException
The image is disposed.

Methods

NameDescription
GetEnumerator()Returns an enumerator over the typed frames.
System.Collections.Generic.IEnumerable<Meziantou.Framework.Imaging.ImageFrame<TPixel>>.GetEnumerator()
System.Collections.IEnumerable.GetEnumerator()

Returns an enumerator over the typed frames.

public new ImageFrameCollection<TPixel>.Enumerator GetEnumerator()

Returns

ImageFrameCollection<TPixel>.Enumerator An enumerator that throws if the collection is structurally modified during enumeration.

System.Collections.Generic.IEnumerable<Meziantou.Framework.Imaging.ImageFrame<TPixel>>.GetEnumerator()

ImageFrameCollection{TPixel}.cs
IEnumerator<ImageFrame<TPixel>> IEnumerable<ImageFrame<TPixel>>.GetEnumerator()

No documentation is available.

System.Collections.IEnumerable.GetEnumerator()

ImageFrameCollection{TPixel}.cs
IEnumerator IEnumerable.GetEnumerator()

No documentation is available.