// <copyright file="IPixelAccessor.cs" company="James Jackson-South">
// Copyright (c) James Jackson-South and contributors.
// Licensed under the Apache License, Version 2.0.
// </copyright>

namespace ImageProcessorCore
{
    using System;

    /// <summary>
    /// Encapsulates properties to provides per-pixel access to an images pixels.
    /// </summary>
    public interface IPixelAccessor : IDisposable
    {
        /// <summary>
        /// Gets or sets the pixel at the specified position.
        /// </summary>
        /// <param name="x">
        /// The x-coordinate of the pixel. Must be greater
        /// than zero and smaller than the width of the pixel.
        /// </param>
        /// <param name="y">
        /// The y-coordinate of the pixel. Must be greater
        /// than zero and smaller than the width of the pixel.
        /// </param>
        /// <returns>The <see cref="IPackedVector"/> at the specified position.</returns>
        IPackedVector this[int x, int y]
        {
            get;
            set;
        }
    }
}