OpenTK.GLControl Class Reference

Defines a UserControl with OpenGL rendering capabilities. More...

List of all members.

Public Member Functions
	GLControl ()
	Constructs a new GLControl.
	GLControl (GraphicsMode mode)
	Constructs a new GLControl with the specified GraphicsMode.
	GLControl (GraphicsMode mode, int major, int minor, GraphicsContextFlags flags)
	Constructs a new GLControl with the specified GraphicsMode.
void	SwapBuffers ()
	Swaps the front and back buffers, presenting the rendered scene to the screen.
void	MakeCurrent ()
	Makes the underlying this GLControl current in the calling thread. All OpenGL commands issued are hereafter interpreted by this GLControl.
Bitmap	GrabScreenshot ()
	Grabs a screenshot of the frontbuffer contents.
Protected Member Functions
override void	OnHandleCreated (EventArgs e)
	Raises the HandleCreated event.
override void	OnHandleDestroyed (EventArgs e)
	Raises the HandleDestroyed event.
override void	OnPaint (PaintEventArgs e)
	Raises the System.Windows.Forms.Control.Paint event.
override void	OnResize (EventArgs e)
	Raises the Resize event. Note: this method may be called before the OpenGL context is ready. Check that IsHandleCreated is true before using any OpenGL methods.
override void	OnParentChanged (EventArgs e)
	Raises the ParentChanged event.
Properties
bool	IsIdle [get]
	Gets a value indicating whether the current thread contains pending system messages.
IGraphicsContext	Context [get, set]
	Gets an interface to the underlying GraphicsContext used by this GLControl.
float	AspectRatio [get]
	Gets the aspect ratio of this GLControl.
bool	VSync [get, set]
	Gets or sets a value indicating whether vsync is active for this GLControl.
GraphicsMode	GraphicsMode [get]
	Gets the GraphicsMode of the GraphicsContext attached to this GLControl.
IWindowInfo	WindowInfo [get]
	Gets the OpenTK.Platform.IWindowInfo for this instance.

---

Detailed Description

Defines a UserControl with OpenGL rendering capabilities.

Definition at line 46 of file GLControl.cs.

---

Constructor & Destructor Documentation

OpenTK.GLControl.GLControl

(

)

Constructs a new GLControl.

Definition at line 65 of file GLControl.cs.

            : this(GraphicsMode.Default)
        { }

OpenTK.GLControl.GLControl

(

GraphicsMode

mode

)

Constructs a new GLControl with the specified GraphicsMode.

Parameters:

mode

The OpenTK.Graphics.GraphicsMode of the control.

Definition at line 73 of file GLControl.cs.

            : this(mode, 1, 0, GraphicsContextFlags.Default)
        { }

OpenTK.GLControl.GLControl	(	GraphicsMode	mode,
		int	major,
		int	minor,
		GraphicsContextFlags	flags
	)

Constructs a new GLControl with the specified GraphicsMode.

Parameters:

	mode	The OpenTK.Graphics.GraphicsMode of the control.
	major	The major version for the OpenGL GraphicsContext.
	minor	The minor version for the OpenGL GraphicsContext.
	flags	The GraphicsContextFlags for the OpenGL GraphicsContext.

Definition at line 84 of file GLControl.cs.

        {
            if (mode == null)
                throw new ArgumentNullException("mode");
            
            SetStyle(ControlStyles.Opaque, true);
            SetStyle(ControlStyles.UserPaint, true);
            SetStyle(ControlStyles.AllPaintingInWmPaint, true);
            DoubleBuffered = false;

            this.format = mode;
            this.major = major;
            this.minor = minor;
            this.flags = flags;

            InitializeComponent();
        }

---

Member Function Documentation

Bitmap OpenTK.GLControl.GrabScreenshot

(

)

Grabs a screenshot of the frontbuffer contents.

Returns:

A System.Drawing.Bitmap, containing the contents of the frontbuffer.

Exceptions:

OpenTK.Graphics.GraphicsContextException

Occurs when no OpenTK.Graphics.GraphicsContext is current in the calling thread.

Definition at line 392 of file GLControl.cs.

        {
            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;
        }

void OpenTK.GLControl.MakeCurrent

(

)

Makes the underlying this GLControl current in the calling thread. All OpenGL commands issued are hereafter interpreted by this GLControl.

Definition at line 258 of file GLControl.cs.

        {
            ValidateState();
            Context.MakeCurrent(Implementation.WindowInfo);
        }

override void OpenTK.GLControl.OnHandleCreated

(

EventArgs

e

)

[protected]

Raises the HandleCreated event.

Parameters:

e

Not used.

Definition at line 134 of file GLControl.cs.

        {
            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);

            if (resize_event_suppressed)
            {
                OnResize(EventArgs.Empty);
                resize_event_suppressed = false;
            }
        }

override void OpenTK.GLControl.OnHandleDestroyed

(

EventArgs

e

)

[protected]

Raises the HandleDestroyed event.

Parameters:

e

Not used.

Definition at line 171 of file GLControl.cs.

        {
            if (context != null)
            {
                context.Dispose();
                context = null;
            }

            if (implementation != null)
            {
                implementation.WindowInfo.Dispose();
                implementation = null;
            }

            base.OnHandleDestroyed(e);
        }

override void OpenTK.GLControl.OnPaint

(

PaintEventArgs

e

)

[protected]

Raises the System.Windows.Forms.Control.Paint event.

Parameters:

e

A System.Windows.Forms.PaintEventArgs that contains the event data.

Definition at line 192 of file GLControl.cs.

        {
            ValidateState();

            if (DesignMode)
                e.Graphics.Clear(BackColor);

            base.OnPaint(e);
        }

override void OpenTK.GLControl.OnParentChanged

(

EventArgs

e

)

[protected]

Raises the ParentChanged event.

Parameters:

e

A System.EventArgs that contains the event data.

Definition at line 227 of file GLControl.cs.

        {
            if (context != null)
                context.Update(Implementation.WindowInfo);

            base.OnParentChanged(e);
        }

override void OpenTK.GLControl.OnResize

(

EventArgs

e

)

[protected]

Raises the Resize event. Note: this method may be called before the OpenGL context is ready. Check that IsHandleCreated is true before using any OpenGL methods.

Parameters:

e

A System.EventArgs that contains the event data.

Definition at line 208 of file GLControl.cs.

        {
            // Do not raise OnResize event before the handle and context are created.
            if (!IsHandleCreated)
            {
                resize_event_suppressed = true;
                return;
            }

            if (context != null)
                context.Update(Implementation.WindowInfo);

            base.OnResize(e);
        }

void OpenTK.GLControl.SwapBuffers

(

)

Swaps the front and back buffers, presenting the rendered scene to the screen.

Definition at line 244 of file GLControl.cs.

        {
            ValidateState();
            Context.SwapBuffers();
        }

---

Property Documentation

float OpenTK.GLControl.AspectRatio [get]

Gets the aspect ratio of this GLControl.

Definition at line 308 of file GLControl.cs.

IGraphicsContext OpenTK.GLControl.Context [get, set]

Gets an interface to the underlying GraphicsContext used by this GLControl.

Definition at line 290 of file GLControl.cs.

GraphicsMode OpenTK.GLControl.GraphicsMode [get]

Gets the GraphicsMode of the GraphicsContext attached to this GLControl.

To change the GraphicsMode, you must destroy and recreate the GLControl.

Definition at line 362 of file GLControl.cs.

bool OpenTK.GLControl.IsIdle [get]

Gets a value indicating whether the current thread contains pending system messages.

Definition at line 273 of file GLControl.cs.

bool OpenTK.GLControl.VSync [get, set]

Gets or sets a value indicating whether vsync is active for this GLControl.

Definition at line 325 of file GLControl.cs.

IWindowInfo OpenTK.GLControl.WindowInfo [get]

Gets the OpenTK.Platform.IWindowInfo for this instance.

Definition at line 378 of file GLControl.cs.