Struct Palette.Enumerator

Namespace

Sdl3Sharp.Video.Coloring

Assembly

Sdl3Sharp.dll

Enumerates the colors in a Palette

public struct Palette.Enumerator : IEnumerator<Color<byte>>, IEnumerator, IDisposable

Implements

IEnumerator<Color<byte>>

IEnumerator

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Enumerator(Palette)

Creates a new Palette.Enumerator for a specified Palette

public Enumerator(Palette palette)

Parameters

palette Palette

The palette to enumerate

Exceptions

ArgumentNullException

palette is null

Properties

Current

Gets the element in the collection at the current position of the enumerator.

public readonly Color<byte> Current { get; }

Property Value

Color<byte>

The element in the collection at the current position of the enumerator.

Methods

Dispose()

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

public void Dispose()

MoveNext()

Advances the enumerator to the next element of the collection.

public bool MoveNext()

Returns

bool

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

Reset()

Sets the enumerator to its initial position, which is before the first element in the collection.

public void Reset()

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

NotSupportedException

The enumerator does not support being reset.