regen -- Real-time Graphics Engine -- is a portable OpenGL library written in C++. The purpose of this library is to help creating real-time rendering software.

A graphics card supporting the OpenGL 3.3 API is required for regen. Some features from the 4.0 API are also supported but optional for backwards compatibility. The engine was tested with proprietary NVIDIA and ATI drivers and should work with Unix based operating systems and Windows.

Clone the code from github. The master branch contains the most up to date source code. For each release you will find a custom branch.

regen builds with CMake. Run cmake . in the root directory to generate files needed for compiling. On Unix systems CMake will generate Makefile's with usual targets. Running make invokes the compiler and linker and if make was successfull a static library libregen.a was created in the root directory. On Windows CMake generates Visual Studio files, just open them and compile from the IDE.

regen defines following build targets:

CMake supports some default parameters for compiler and build path setup, consider the CMake documentations for a complete socumentation of these arguments. Some important argument are listed below.

Following you can find a list of cmake arguments with special handling in the regen build files:

On Windows you might have to set environment variables for the dependency libraries. Following you can find a list of those variables:

Here you find a brief list of supported features in this library.

• Portability: Tested with Windows8, Ubuntu11.10 and ArchLinux
• Augmented GLSL:
  • input modification (constant, uniform, attribute, instanced attribute)
  • support for 'include' and 'for' directive
• Render State: encapsulates GL states and avoids redundant state switches.
• Audio/Video: Streaming from file resources, 3D Sound
• Image loading: Support for common image formats (png, jpg, hdr, ...)
• Text rendering: Loading of Freetype fonts, rendering of texture mapped text
• Model loading: Support for common model formats (3ds, ply, obj, ...), support for bone animations
• Shading: Deferred and Direct shading is supported
• Picking: Supports to distinguish between objects and instances
• Scene post processing: FXAA, Ambient Occlusion, Volumetric Fog, Tonemap ...
• Sky Rendering: Dynamic sky with realistic scattering
• Particles: Simple implementations of smoke,rain,snow particles
• Volume Rendering: Simple raycasting volume renderer
• Scene Graph: Loading scenes from XML resources

Following you can find a list of libraries that must be installed in order to compile regen.

• OpenGL >=3.3
• OpenAL Soft >=1.1 and ALUT
  • You might have to compile ALUT manually on Win. I had troubles linking against the binary distribution using VisualStudio, probably incompatible compilers.
• Assimp >= 2.0
  • You have to copy the dll manually to binary dir on Win (.dll is not named like .lib)
• DevIL >= 1.4.0
• FreeType >= 2.4.0
  • You might have to compile FreeType manually on Win. I had troubles linking against the binary distribution using VisualStudio, probably incompatible compilers.
• Boost
  • components: thread system date_time filesystem regex
  • compile options: --build-type=complete
• FFmpeg
  • download Dev and Shared package from here on Win. You have to copy the dll manually to binary dir (.dll is not named like .lib).
• Bullet

In order to compile the test applications you will also need to install the following list of libraries:

• Qt >=4.0 (QtCore, QtGui, QtOpenGL)
  • Qt4 installer for 64Bit Win

The documentation is hosted using the gh-pages branch

If you find any bugs or if you have any feature requests please report them to the github tracker.

You also can contact me directly via mail or Jabber if you like (address: daniel(at)orgizm.net).