Select Git revision
SimulationEngineFactory.h
-
Oliver Bock authored
git-svn-id: https://svn.origo.ethz.ch/fidelity@3 53d1999f-d1a8-4366-aa61-588fded17473
Oliver Bock authoredgit-svn-id: https://svn.origo.ethz.ch/fidelity@3 53d1999f-d1a8-4366-aa61-588fded17473
doxygen_index.h 12.15 KiB
/**
* \mainpage Overview
*
* \section cha_intro Introduction
*
* This application is part of the Einstein\@Home project and aims to provide an extensible, refurbished version of
* the well-known %Starsphere graphics application (screensaver).
* \n
* The new version focuses on the following topics:
*
* - Refurbished visuals and extended features
* - Generalized API for community-driven implementations
* - %Resource embedding (e.g. fonts, images)
* - Migration from GLUT to SDL
* - Self-consistent build script (Linux, Mac OS X, Windows/MinGW)
* - Full doxygen documentation
*
* \subsection sec_status Current Status
*
* The graphics application is currently in its beta stage and has still to be considered as work-in-progress.
* This means that probably not all desired features are fully implemented yet and the code might still contain some bugs.
* However, we think the application is stable enough to be used on a daily basis. You're invited to test and
* discuss the current version at the Einstein\@Home
* \htmlonly<a href="http://einstein.phys.uwm.edu/forum_forum.php?id=3">\endhtmlonly
* Cruncher's Corner
* \htmlonly</a>\endhtmlonly.
*
* The most important feature that's not fully supported right now is the persistent configuration of the graphics
* application. It is intended to let users customize the application's options using the BOINC project preferences
* and/or other means. This task is still pending but is scheduled for the near future. As soon as these changes are
* completed users will be able to set the following options:
*
* - Common options (already available):
* - Window width (default: 800 pixels)
* - Window height (default: 600 pixels)
* - Frame rate (default: 20 fps)
* - Quality (default: low / also available: medium, high)
* - %Starsphere options (still pending):
* - Enabled screen elements (see \ref sec_app_usage)
*
* Please note that we're using conservative default values (for the common options) to ensure that the graphics
* applications runs with reasonable CPU consumption on most systems. This means that the visual improvements are
* \b not activated and the graphics look more or less the same as before. If you have hardware accelerated 3D
* support on your machine please feel free to increase the settings. For example: on a recent Linux PC the
* %Starsphere application consumes less than 10% CPU power when running at typical desktop resolutions (e.g. 1280x1024),
* 30 frames per second and high quality.
*
* \subsection sec_platforms Supported Platforms
*
* The binary versions as well as the build script support the following platforms:
* - Linux (Intel, 32 Bit)
* - Mac OS X (Tiger/Leopard, Intel/PowerPC, 32 Bit)
* - Windows (Intel, 32 Bit, cross compiled with MinGW)
*
* \subsection sec_future The Future
*
* - Community involvement: build and share \b your \b own graphics application!
* - Provide different backgrounds and search visualizations
* - Full Linux screensaver support (X11, KDE, Gnome)
* - Help dialog (on screen display)
*
* \section sec_doc_user User Documentation
*
* \subsection cha_app_S5 Starsphere Graphics Application - LSC/Virgo S5
*
* \subsubsection sec_app_overview Overview
*
* The new %Starsphere application is based on the original version currently shipped with Einstein\@Home.
* For more information about what it shows please refer to our
* \htmlonly<a href="http://einstein.phys.uwm.edu/starsphere.php">\endhtmlonly