Crazy Eddie's GUI System Mk-2: Developer Documentation

http://www.cegui.org.uk

Copyright (c) 2004 - 2009 Paul D Turner & The CEGUI Development Team

This is Crazy Eddie's GUI System Mk-2; a free library providing windowing and widgets for graphics APIs and engines where such functionality is not natively available or is severely lacking. The library is written in C++, is object orientated, and is primarily targeted at games developers who should be spending their time creating great games, not building GUI sub-systems...

Note: In various documentation and online, the system is additionally referred to as both CEGUI (which is the main namespace name), and cegui_mk2 (which was the CVS module name of the Mk2 version of the system, and is now the root svn directory for this part of the system).

Documentation Sections

The documentation for CEGUI is split into the following sections:

• General Information
  • CEGUI License (and other licensing considerations)
  • List of authors and contributors
  • Change Log

• Code related topics
  • Obtaining the code
  • Supported systems and compilation.
  • Coding Standards in use for CEGUI
  • Contributing to the development of CEGUI.
  • Overview of system components

• Beginners Tutorials
  • The Beginners Guide to Getting CEGUI Rendering
  • The Beginners Guide to resource loading with ResourceProviders
  • The Beginners Guide to Data Files and Defaults Initialisation
  • The Beginners Guide to Creating a CEGUI Window
  • The Beginners Guide to Injecting Inputs

• Porting Guides and Future Changes
  • Porting from CEGUI 0.6.x to CEGUI 0.7.x
  • Planned and Considered Future Changes

• Additional reference material
  • Imageset XML files.
  • Font XML files.
  • Scheme XML files.
  • Layout XML files.
  • CEGUI Configuration XML files.
  • Falagard skinning system for CEGUI

Have Fun!