Building OMGUI

Index

Requirements

OMGUI is built using the SCons build system, which requires Python 1.5.2 or higher. The OMGUI distribution contains a version of SCons, so you do not need to install this yourself if you do not already have it.

Supported Compilers

Platform	Compilers
Windows	Visual C++ v7.1 or higher
Linux	gcc 3.?.?
Mac	XCode ?? + gcc ??

Building from the command line

Building OMGUI from the command line is supported on all platforms that OMGUI supports. To prepare to build from the command line, navigate to the root directory where you extracted the OMGUI distribution and ensure that Python can be found in the PATH.

Important note for Windows users: Windows users should ensure that they open a "Visual Studio Command Prompt" instead of just a normal command prompt. This will ensure that SCons can find the compiler and will configure the INCLUDE and LIBPATH environment variables so that the compiler can locate the Windows SDK header files and libraries. You can open this prompt from the Visual Studio tools menu, or from the start menu.

To build OMGUI, simply execute this command: python build/scons/scons.py. This will execute SCons to build OMGUI with the default options. To see what these options and their default values are, run python build/scons/scons.py -h. For information about specific options, see Build Options. To specify a value for any of these options, simply add OPTION=value to the command to run scons. For example: python build/scons/scons.py DEBUG=true.

Building from Visual Studio

The OMGUI distribution includes project files for Visual Studio 2008. These project files are configured to integrate with the SCons build system, and will invoke SCons when build commands are issued. To build a specific project, select that project from the list of projects and use the build menu to build that project. Building any of the sample projects will also build the OMGUI library, so it is not necessary to build the library separately.

Warning for users with multiple processors: Avoid using the Build Solution command if you have multiple processors unless you tell Visual Studio to only build one project at a time. If Visual Studio is allowed to build multiple projects at the same time, the multiple instances of SCons will step on each other as they try to compile the same things. This applies to the Batch Build feature as well. As long as Visual Studio only builds one project at a time, these features are safe to use.

Build Options

DEBUG: Controls whether the library is built with debugging information.
SHARED: Controls whether the library is built as a shared library or as a static library.
BACKEND: Controls which backend implementation is built. This can be used to force the gtk2 source to be built on a Windows platform, for example.
SAMPLES: Controls which samples to build. Specify the names of the samples as a list. For example, SAMPLES=widgets,mouse