Addd high level introductory docs for all the libs
This commit is contained in:
@@ -56,4 +56,12 @@
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osg
|
||||
|
||||
The core osg library provides the basic scene graph classes such as Nodes,
|
||||
State and Drawables, and maths and general helper classes.
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
@@ -25,10 +25,18 @@
|
||||
#include <list>
|
||||
#include <fstream>
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgUtx
|
||||
|
||||
The osgUtx is a unit test framework.
|
||||
*/
|
||||
|
||||
namespace osgUtx{
|
||||
|
||||
class TestVisitor;
|
||||
|
||||
|
||||
/**
|
||||
Test, an abstract base class, is the Composite pattern's \em component
|
||||
class for our graph of test cases, and defines the basic interface
|
||||
|
||||
@@ -34,4 +34,12 @@
|
||||
# define OSGDB_EXPORT
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgDB
|
||||
|
||||
The osgDB library provides support for reading and writing scene graphs, providing a plugin framework and file utility classes.
|
||||
The plugin framework in centred around the osgDB::Registry, and allows plugins which provide specific file format support to be dynamically loaded on demand.
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
@@ -25,4 +25,14 @@
|
||||
# define OSGFX_EXPORT
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgFX
|
||||
|
||||
The osgFX is a NodeKit library that extends the core scene graph to provide a special effects framework.
|
||||
osgFX's framework allows multiple rendering techniques to be provide for each effect, thereby provide the use
|
||||
appropriate rendering techniques for each different class of graphics hardware, i.e. support for both modern
|
||||
programmable graphics hardware and still have standard OpenGL 1.1 support as a fallback.
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
@@ -43,5 +43,12 @@
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgGL2
|
||||
|
||||
The osgGL2 is a NodeKit library that extends the core scene graph to support OpenGL Shader Language.
|
||||
*/
|
||||
|
||||
#endif /* OSGGL2_EXPORT_ */
|
||||
|
||||
|
||||
@@ -35,6 +35,12 @@
|
||||
# define OSGPARTICLE_EXPORT
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgParticle
|
||||
|
||||
The osgParticle is a NodeKit library that extends the core scene graph to support particle effects.
|
||||
*/
|
||||
|
||||
|
||||
#endif
|
||||
|
||||
@@ -35,5 +35,16 @@
|
||||
#define OSGPRODUCER_EXPORT
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgProducer
|
||||
|
||||
The osgProducer is a utility library integrates OpenProducer to provide a general purpose viewer classes.
|
||||
osgProducer is used by all the OpenSceneGraph examples, and can also be used for client application development.
|
||||
|
||||
Note, the core scene graph libraries and NodeKits are entirely Windowing API agnostic so you are free to implement
|
||||
your own integration with whichever Windowing toolkit you prefer.
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
@@ -43,4 +43,12 @@
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgSim
|
||||
|
||||
The osgSim is a NodeKit library that extends the core scene graph to support nodes and drawables that specific to the visual simulation, such
|
||||
a navigational light point support and OpenFlight style degrees of freedom transform.
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
@@ -34,4 +34,15 @@
|
||||
# define OSGTERRAIN_EXPORT
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgTerrain
|
||||
|
||||
The osgTerrain is a utility library that provides geospecifc terrain database generation support.
|
||||
The osgTerrain library is typically invoked by the osgdem utlitly application that users can use to build paged terrain databases
|
||||
from geospecific imagery and digial elevation maps (DEM's). osgTerrain may also be used directly in your own applications to generate
|
||||
databases. Note, osgTerrain is not presently written for run-time rendering of terrain, and is just focused on database
|
||||
generation, these generated databases then can used used in standard OpenSceneGraph application which do not need to link osgTerrain..
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
@@ -34,4 +34,11 @@
|
||||
# define OSGTEXT_EXPORT
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgText
|
||||
|
||||
The osgText is a NodeKit library that extends the core scene graph to support high quality text.
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
@@ -35,5 +35,13 @@
|
||||
#define OSGUTIL_EXPORT
|
||||
#endif
|
||||
|
||||
/**
|
||||
|
||||
\namespace osgUtil
|
||||
|
||||
The osgUtil library provides general purpose utility classes such as update, cull and draw traverses, scene graph operators such a scene graph optimisation, tri stripping, and tessellation.
|
||||
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
Reference in New Issue
Block a user