Click here to Skip to main content
11,480,938 members (45,780 online)
Click here to Skip to main content
Articles » Multimedia » OpenGL » General » Revisions

SharpGL: A C# OpenGL Class Library

, 11 Dec 2011 GPL3 760.9K 49.2K 442
Rate this:
Please Sign up or sign in to vote.
Use OpenGL in WinForms or WPF applications, directly or with a powerful Scene Graph.
This is an old version of the currently published article.
Screenshot.jpg

Headline: SharpGL 2.0 Beta 1 is available to be tried out from the SharpGL CodePlex site - the latest download is at http://sharpgl.codeplex.com/releases/view/74704.

Introduction

Use OpenGL in your C# applications with SharpGL, it's a breeze! Just drag an OpenGLControl onto your Windows Form and handle the 'OpenGLDraw' function - now just call ordinary OpenGL functions!

Keeping Track of SharpGL

Before I go much further, here are some useful bits of information:

SharpGL is now hosted on CodePlex at http://sharpgl.codeplex.com

SharpGL is currently at version 2.0 Beta 1 - this version adds support for WPF, OpenGL 4.2 extensions and more.

I am also writing about the various challenges of creating the new version on my blog at http://www.dwmkerr.com.

Using SharpGL in WinForms Applications

SharpGL provides you with two controls for designing forms. The OpenGLControl, which lets you do standard OpenGL drawing in a C# application, and the SceneControl, which does the same with added support for polygons/persistence/picking and more. The screenshot above shows the SceneControl in action, with the supplied 'SceneBuilder' application. The screenshot below shows some 'old fasioned' OpenGL drawing, with calls to 'glBegin' and 'glEnd', etc.

Screenshot-Small.jpg

If you want to get OpenGL in your application quickly, there's no easier way. There are eight example applications in the download that show you how to use some common features.

Getting Started

Create a Windows Forms application, use the SharpGL DLL as a reference, and drop an OpenGLControl onto the form. Then handle the 'OpenGLDraw' event and you're ready to go!

Calls that in C++ would look like...

glBegin(GL_LINES);
    glVertex3f(1.0f, 1.0f, 1.0f); ...etc...

...will have to look like:

OpenGL gl = someForm.someOpenGLControl.OpenGL;

gl.Begin(OpenGL.LINES); 
		gl.Vertex(1, 1, 1); ...etc...

Porting over existing OpenGL code is therefore trivial. Every OpenGL and GLU library function has been imported and fully commented - no need to look through reference books for function parameters, the Code Hints will show you everything you need to see!

screenshot_codehints.jpg

The Scene Graph

The Scene Graph contains classes like 'Texture' and 'Camera' to make working with certain types of object much easier. You don't have to use them, you can use certain components or you can use the whole lot. Or you can mix and match. There is an example application that shows how to do texturing with the Scene Graph.

Using SharpGL in WPF Applications

The screenshot below shows SharpGL being used in a WPF application:

MainWindow-Final.png

There is a full article describing how to use SharpGL in a WPF application on CodeProject, at http://www.codeproject.com/KB/WPF/openglinwpf.aspx.

Updates

New to SharpGL 2.0 Beta 1

Note: Beta 1 is available on the CodePlex site only and won't be uploaded to this page until the Beta testing is complete.

  • Hardware acceleration
  • OpenGL Extensions Support
  • Core OpenGL Functionality up to OpenGL 4.2
  • A dedicated WPF library

New to SharpGL 1.83

  • Five example applications in the download
  • Numerous bug fixes, updates and optimisations

New to SharpGL 1.8

  • Three new example applications
  • Significant improvements to texturing code
  • Rollup Controls in SceneBuilder keep the interface clutter free
  • A new materials editor in the Modify tab allows quick material editing
  • All SceneObjects in SharpGL now automatically optimise themselves to use display lists. This has made the Scene drawing extremely fast.
  • An overhaul of the GDI code by Lee Davies and myself has removed the large memory leak and hugely increased the overall performace of the library and application.
  • Many more minor updates and bug fixes are documented in the updates document in the project.

You can now automatically load simple 3D objects from Caligari trueSpace files. This makes creating applications a bit more simple, as you can test the polygon classes with real objects. A Polygon in the SharpGL scene graph is very powerful, they can cast real time shadows. A set of 'Builders' have been added to the SceneBuilder application, allowing you to build polygons from scratch, play around with materials, etc.

SceneBuilder (the Test Application) is a simple application showing some of what SharpGL can do, and all the source code is bundled with it, you can use it to build many aspects of a scene.

Points of Interest

The library is great to use, the Scene Graph 'Scene' object lets you do picking, you can control objects via the mouse, even parts of objects, such as the control points of NURBS and evaluators can be moved around. The polygons can be edited by Face, Vertex or as whole objects, and cast shadows over other objects.

Many of the 'kludgy' aspects of OpenGL such as the limits on the number of lights have been smoothed over. Using lights as an example, when the scene is created, the maximum number of lights is ascertained, and you cannot go over that limit. The extent of Mouse control is amazing, and very easy to implement in your own classes. The Persistence code is some of the best code I've ever written, you can call a function in the persistence engine, passing a type of object, and immediately a File Open / Save dialog will be shown with all the available file formats there for the user to select from, then the object will be created from the file or saved to the file. This means in the SceneBuilder app, it takes about two lines to be able to load a polygon from file, with all the possible formats automatically shown.

Keep Up To Date

Up to date information on SharpGL development is available from the CodePlex site.

SharpGL is now hosted on CodePlex, at http://sharpgl.codeplex.com.

I write about various interesting areas I come across when developing SharpGL on my blog at http://www.dwmkerr.com.

Feature Requests

I am looking for feature requests for SharpGL 2.1 and the roadmap! Add feature requests from the CodePlex page's 'Issues' section or via the comments below.

License

This article, along with any associated source code and files, is licensed under The GNU General Public License (GPLv3)

Share

About the Author

Dave Kerr
Software Developer
United Kingdom United Kingdom
Follow my blog at www.dwmkerr.com and find out about my charity at www.childrenshomesnepal.org.
Follow on   Twitter

Comments and Discussions


Discussions posted for the Published version of this article. Posting a message here will take you to the publicly available article in order to continue your conversation in public.
 
GeneralThanks Pin
ARandomGuy26-Feb-15 5:00
memberARandomGuy26-Feb-15 5:00 
GeneralRe: Thanks Pin
Dave Kerr26-Feb-15 5:46
mvpDave Kerr26-Feb-15 5:46 
QuestionVS 2013 Extension Pin
smjones-home4-Dec-14 10:03
membersmjones-home4-Dec-14 10:03 
AnswerRe: VS 2013 Extension Pin
Dave Kerr8-Dec-14 18:50
mvpDave Kerr8-Dec-14 18:50 
QuestionVSIX Installation failed - Visual Studio Express Editions Pin
AORD17-Nov-14 23:30
memberAORD17-Nov-14 23:30 
AnswerRe: VSIX Installation failed - Visual Studio Express Editions Pin
Dave Kerr19-Nov-14 4:23
mvpDave Kerr19-Nov-14 4:23 
AnswerRe: VSIX Installation failed - Visual Studio Express Editions Pin
Dave Kerr25-Jan-15 2:12
mvpDave Kerr25-Jan-15 2:12 
GeneralRe: VSIX Installation failed - Visual Studio Express Editions Pin
AORD25-Jan-15 8:23
memberAORD25-Jan-15 8:23 
GeneralRe: VSIX Installation failed - Visual Studio Express Editions Pin
Dave Kerr26-Jan-15 22:45
mvpDave Kerr26-Jan-15 22:45 
QuestionSharpGL tutorial & 3D rendering?? [modified] Pin
Member 1088161316-Jun-14 23:56
memberMember 1088161316-Jun-14 23:56 
AnswerRe: SharpGL tutorial & 3D rendering?? Pin
Dave Kerr22-Jun-14 8:52
mvpDave Kerr22-Jun-14 8:52 
QuestionRe: SharpGL tutorial & 3D rendering?? Pin
Member 1088161326-Jun-14 0:04
memberMember 1088161326-Jun-14 0:04 
AnswerRe: SharpGL tutorial & 3D rendering?? Pin
Dave Kerr27-Jun-14 5:41
mvpDave Kerr27-Jun-14 5:41 
GeneralRe: SharpGL tutorial & 3D rendering?? Pin
Member 108816131-Jul-14 21:19
memberMember 108816131-Jul-14 21:19 
GeneralRe: SharpGL tutorial & 3D rendering?? Pin
Dave Kerr21-Jul-14 7:48
mvpDave Kerr21-Jul-14 7:48 
QuestionRe: SharpGL tutorial & 3D rendering?? Pin
Member 1088161328-Jul-14 21:53
memberMember 1088161328-Jul-14 21:53 
QuestionHow to use the WGS84 (Latitude, Longitude) projection Pin
AhmedGis201114-Apr-14 8:28
memberAhmedGis201114-Apr-14 8:28 
AnswerRe: How to use the WGS84 (Latitude, Longitude) projection Pin
Dave Kerr14-Apr-14 8:59
mvpDave Kerr14-Apr-14 8:59 
QuestionWhich OpenGL version? Pin
Leonardo Bouchan12-Apr-14 11:04
memberLeonardo Bouchan12-Apr-14 11:04 
AnswerRe: Which OpenGL version? Pin
Dave Kerr12-Apr-14 21:54
mvpDave Kerr12-Apr-14 21:54 
QuestionLicense Pin
moritz949-Apr-14 6:32
membermoritz949-Apr-14 6:32 
AnswerRe: License Pin
Dave Kerr9-Apr-14 6:36
mvpDave Kerr9-Apr-14 6:36 
GeneralRe: License Pin
LittleFox949-Apr-14 6:57
memberLittleFox949-Apr-14 6:57 
QuestionDrawText could not show Chinese! Pin
ydongydong11-Mar-14 3:48
memberydongydong11-Mar-14 3:48 
AnswerRe: DrawText could not show Chinese! Pin
Dave Kerr11-Mar-14 6:56
mvpDave Kerr11-Mar-14 6:56 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.150520.1 | Last Updated 11 Dec 2011
Article Copyright 2002 by Dave Kerr
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid