#region --- License ---
/* Licensed under the MIT/X11 license.
 * Copyright (c) 2006-2008 the OpenTK Team.
 * This notice may not be removed from any source distribution.
 * See license.txt for licensing detailed licensing details.
 */
#endregion

using System;
using OpenTK.Platform;

namespace OpenTK.Graphics {
	
    /// <summary> Provides methods for creating and interacting with an OpenGL context. </summary>
    public interface IGraphicsContext : IDisposable {
    	
        /// <summary> Swaps buffers, presenting the rendered scene to the user. </summary>
        void SwapBuffers();

        /// <summary> Makes the GraphicsContext current in the calling thread. </summary>
        /// <param name="window">An OpenTK.Platform.IWindowInfo structure that points to a valid window.</param>
        /// <remarks>
        /// <para>OpenGL commands in one thread, affect the GraphicsContext which is current in that thread.</para>
        /// <para>It is an error to issue an OpenGL command in a thread without a current GraphicsContext.</para>
        /// </remarks>
        void MakeCurrent(IWindowInfo window);

        /// <summary> Gets a <see cref="System.Boolean"/> indicating whether this instance is current in the calling thread. </summary>
        bool IsCurrent { get; }

        /// <summary> Gets a <see cref="System.Boolean"/> indicating whether this instance has been disposed.
        /// It is an error to access any instance methods if this property returns true. </summary>
        bool IsDisposed { get; }

        /// <summary> Gets or sets a value indicating whether VSyncing is enabled. </summary>
        bool VSync { get; set; }

        /// <summary> Updates the graphics context.  This must be called when the region the graphics context
        /// is drawn to is resized. </summary>
        /// <param name="window"></param>
        void Update(IWindowInfo window);

        /// <summary>Gets the GraphicsMode of this instance.</summary>
        GraphicsMode GraphicsMode { get; }

        /// <summary> Loads all OpenGL entry points. Requires this instance to be current on the calling thread. </summary>
        void LoadAll();

        /// <summary> Gets a handle to the OpenGL rendering context. </summary>
        IntPtr Context { get; }

        /// <summary> Gets the address of an OpenGL extension function. </summary>
        /// <param name="function">The name of the OpenGL function (e.g. "glGetString")</param>
        /// <returns> A pointer to the specified function or IntPtr.Zero if the function isn't
        /// available in the current opengl context. </returns>
        IntPtr GetAddress(string function);
    }
}