#region License
//
// The Open Toolkit Library License
//
// Copyright (c) 2006 - 2009 the Open Toolkit library, except where noted.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do
// so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
#endregion
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.Drawing;
using System.Data;
using System.Text;
using System.Windows.Forms;
using OpenTK.Platform;
using OpenTK.Graphics;
using OpenTK.Graphics.OpenGL;
namespace OpenTK
{
///
/// Defines a UserControl with OpenGL rendering capabilities.
///
public partial class GLControl : UserControl
{
IGraphicsContext context;
IGLControl implementation;
GraphicsMode format;
int major, minor;
GraphicsContextFlags flags;
bool? initial_vsync_value;
#region --- Constructors ---
///
/// Constructs a new GLControl.
///
public GLControl()
: this(GraphicsMode.Default)
{ }
///
/// Constructs a new GLControl with the specified GraphicsMode.
///
/// The OpenTK.Graphics.GraphicsMode of the control.
public GLControl(GraphicsMode mode)
: this(mode, 1, 0, GraphicsContextFlags.Default)
{ }
///
/// Constructs a new GLControl with the specified GraphicsMode.
///
/// The OpenTK.Graphics.GraphicsMode of the control.
/// The major version for the OpenGL GraphicsContext.
/// The minor version for the OpenGL GraphicsContext.
/// The GraphicsContextFlags for the OpenGL GraphicsContext.
public GLControl(GraphicsMode mode, int major, int minor, GraphicsContextFlags flags)
{
SetStyle(ControlStyles.Opaque, true);
SetStyle(ControlStyles.UserPaint, true);
SetStyle(ControlStyles.AllPaintingInWmPaint, true);
DoubleBuffered = false;
InitializeComponent();
this.format = mode;
this.major = major;
this.minor = minor;
this.flags = flags;
}
#endregion
#region --- Private Methods ---
IGLControl Implementation
{
get
{
ValidateState();
return implementation;
}
}
void ValidateState()
{
if (IsDisposed)
throw new ObjectDisposedException(GetType().Name);
if (!IsHandleCreated)
CreateControl();
if (implementation == null || context == null || context.IsDisposed)
RecreateHandle();
}
#endregion
#region --- Protected Methods ---
/// Raises the HandleCreated event.
/// Not used.
protected override void OnHandleCreated(EventArgs e)
{
if (context != null)
context.Dispose();
if (implementation != null)
implementation.WindowInfo.Dispose();
if (DesignMode)
implementation = new DummyGLControl();
else
implementation = new GLControlFactory().CreateGLControl(format, this);
context = implementation.CreateContext(major, minor, flags);
MakeCurrent();
if (!DesignMode)
((IGraphicsContextInternal)Context).LoadAll();
// Deferred setting of vsync mode. See VSync property for more information.
if (initial_vsync_value.HasValue)
{
Context.VSync = initial_vsync_value.Value;
initial_vsync_value = null;
}
base.OnHandleCreated(e);
}
/// Raises the HandleDestroyed event.
/// Not used.
protected override void OnHandleDestroyed(EventArgs e)
{
if (context != null)
{
context.Dispose();
context = null;
}
if (implementation != null)
{
implementation.WindowInfo.Dispose();
implementation = null;
}
base.OnHandleDestroyed(e);
}
///
/// Raises the System.Windows.Forms.Control.Paint event.
///
/// A System.Windows.Forms.PaintEventArgs that contains the event data.
protected override void OnPaint(PaintEventArgs e)
{
ValidateState();
if (DesignMode)
e.Graphics.Clear(BackColor);
base.OnPaint(e);
}
///
/// Raises the Resize event.
///
/// A System.EventArgs that contains the event data.
protected override void OnResize(EventArgs e)
{
if (context != null)
context.Update(Implementation.WindowInfo);
base.OnResize(e);
}
///
/// Raises the ParentChanged event.
///
/// A System.EventArgs that contains the event data.
protected override void OnParentChanged(EventArgs e)
{
if (context != null)
context.Update(Implementation.WindowInfo);
base.OnParentChanged(e);
}
#endregion
#region --- Public Methods ---
#region public void SwapBuffers()
///
/// Swaps the front and back buffers, presenting the rendered scene to the screen.
///
public void SwapBuffers()
{
ValidateState();
Context.SwapBuffers();
}
#endregion
#region public void MakeCurrent()
///
/// Makes the underlying this GLControl current in the calling thread.
/// All OpenGL commands issued are hereafter interpreted by this GLControl.
///
public void MakeCurrent()
{
ValidateState();
Context.MakeCurrent(Implementation.WindowInfo);
}
#endregion
#region public bool IsIdle
///
/// Gets a value indicating whether the current thread contains pending system messages.
///
[Browsable(false)]
public bool IsIdle
{
get
{
ValidateState();
return Implementation.IsIdle;
}
}
#endregion
#region public IGraphicsContext Context
///
/// Gets an interface to the underlying GraphicsContext used by this GLControl.
///
[Browsable(false)]
public IGraphicsContext Context
{
get
{
ValidateState();
return context;
}
private set { context = value; }
}
#endregion
#region public float AspectRatio
///
/// Gets the aspect ratio of this GLControl.
///
[Description("The aspect ratio of the client area of this GLControl.")]
public float AspectRatio
{
get
{
ValidateState();
return ClientSize.Width / (float)ClientSize.Height;
}
}
#endregion
#region public bool VSync
///
/// Gets or sets a value indicating whether vsync is active for this GLControl.
///
[Description("Indicates whether GLControl updates are synced to the monitor's refresh.")]
public bool VSync
{
get
{
if (!IsHandleCreated)
return false;
ValidateState();
return Context.VSync;
}
set
{
// The winforms designer sets this to false by default which forces control creation.
// However, events are typically connected after the VSync = false assignment, which
// can lead to "event xyz is not fired" issues.
// Work around this issue by deferring VSync mode setting to the HandleCreated event.
if (!IsHandleCreated)
{
initial_vsync_value = value;
return;
}
ValidateState();
Context.VSync = value;
}
}
#endregion
#region public GraphicsMode GraphicsMode
///
/// Gets the GraphicsMode of the GraphicsContext attached to this GLControl.
///
///
/// To change the GraphicsMode, you must destroy and recreate the GLControl.
///
public GraphicsMode GraphicsMode
{
get
{
ValidateState();
return Context.GraphicsMode;
}
}
#endregion
#region WindowInfo
///
/// Gets the for this instance.
///
public IWindowInfo WindowInfo
{
get { return implementation.WindowInfo; }
}
#endregion
#region public Bitmap GrabScreenshot()
/// Grabs a screenshot of the frontbuffer contents.
/// A System.Drawing.Bitmap, containing the contents of the frontbuffer.
///
/// Occurs when no OpenTK.Graphics.GraphicsContext is current in the calling thread.
///
[Obsolete("This method will not work correctly with OpenGL|ES. Please use ReadPixels to capture the contents of the framebuffer (you can then load them into a System.Drawing.Bitmap for further processing or saving them to disk).")]
public Bitmap GrabScreenshot()
{
ValidateState();
Bitmap bmp = new Bitmap(this.ClientSize.Width, this.ClientSize.Height);
System.Drawing.Imaging.BitmapData data =
bmp.LockBits(this.ClientRectangle, System.Drawing.Imaging.ImageLockMode.WriteOnly,
System.Drawing.Imaging.PixelFormat.Format24bppRgb);
GL.ReadPixels(0, 0, this.ClientSize.Width, this.ClientSize.Height, PixelFormat.Bgr, PixelType.UnsignedByte,
data.Scan0);
bmp.UnlockBits(data);
bmp.RotateFlip(RotateFlipType.RotateNoneFlipY);
return bmp;
}
#endregion
#endregion
}
}