/OpenGL.Net

Modern OpenGL bindings for C#.

Primary LanguageC#MIT LicenseMIT

build build codecov nuget NuGet

wiki

OpenGL.Net

Modern OpenGL bindings for C#.

OpenGL and related API

Features

  • Generated from the lastest official XML specification
  • Function pointer wrappers, with safe and unsafe parameters, pinning managed memory when necessary;
  • Automatic entry points aliasing management: function loader is aware of the current OpenGL context; you can share code for OpenGL and OpenGL ES;
  • Strongly typed enumerants;
  • OpenGL entry points overloading;
  • Fully documented OpenGL entry points with the official manual pages;
  • Vector, math and color data structures. With System.Numerics.Vector support.
  • Automatic OpenGL extensions and implementation limits query;
  • Checking errors after each OpenGL command (Debug builds only);
  • Integrated entry points call logging (Debug builds only);
  • Support ANGLE backend (for OpenGL ES on DirectX);

If you need more OOP with OpenGL, you can give a try to OpenGL.Net.Objects.

Frameworks

OpenGL.Net is running on a number of .NET frameworks:

  • .NET Framework 3.5
  • .NET Framework 4.6.1
  • .NET Core 1.1
  • .NET Core 2.0
  • .NET Standard 2.0
  • Xamarin/Android

Toolkits

OpenGL.Net is not aware(*) about the underlying platform or graphical toolkit you're running on. To create a GL context, users are required to provide a window handle and a display handle. There are sub-projects that automate the GL viewport definition and creation.

  • System.Windows.Forms toolkit, using an custom UserControl.
  • GTK# toolkit, using a custom Widget.
  • Android, using a SurfaceView.
  • Raspberry Pi 2 VC4, using the platform SDK.
  • OpenWF compatible video systems.

Instructions

In order to use OpenGL.Net you only need to link the library; due the current state of the project, it is advisable to clone the repository and work directly with the library, since this method offers more flexible solution (i.e. Debug builds).

Clone the repository

Follow the command below to clone and build the repository.

git clone https://github.com/luca-piccioni/OpenGL.Net.git
cd OpenGL.Net
msbuild /p:Configuration=Release OpenGL.Net_VC14.sln
msbuild /p:Configuration=Release OpenGL.Net_VC15.sln

The following environments can be used:

  • Visual Studio 2015 for OpenGL.Net_VC14.sln
  • Visual Studio 2017 15.3 (Preview 2) for OpenGL.Net_VC15.sln

NuGet

Open the Package Manager Console and run the following command:

Install-Package OpenGL.Net

You can choose to restrict the available GL profile:

Install-Package OpenGL.Net.CoreProfile
Install-Package OpenGL.Net.ES2Profile

To integrate window systems, run the most appropriate command for your platform:

Install-Package OpenGL.Net.WinForms
Install-Package OpenGL.Net.Xamarin.Android
Install-Package OpenGL.Net.VideoCore

Or just download the nuget binary packages:

Documentation

Go to the wiki to look for information about the project. There is also a Samples directory, where application skeleton are implemented for various platforms.

Licensing

The project is released under the MIT license. Previous revisions of the project were licensed under the LGPL2 licence; this kind of license seems limiting the deployment of the binary forms on some platform (ironic, isn't it?). Since the project is maintained to be useful on the widest range of platforms/user-cases, and considering the spirit of the technology used to build it (.NET Fundation), the MIT license was preferred. The WTFPL license was considered also, but it hasn not met all requirements.