| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This section is intended to explain the general CS directory structure. Crystal Space consists of the following directories:
CSThe main directory for Crystal Space. You can choose any path for it, as long as it is supported by your operating system. If you choose to build the project within this directory, then this is where the built applications and plugin modules are deposited. The file ‘vfs.cfg’ also resides in this directory.
CS/outThis directory is used by the build process if you build the project using “make” or “jam” within the source tree. It is also possible—indeed recommended—to build the project in some other location. This directory will contain all object files, static link libraries, and other generated files needed for building the project.
CS/appsContains the source code for applications which ship with Crystal Space. See section Quick Overview.
CS/apps/testsApplications for testing specific features of the project reside here.
CS/apps/tutorialVarious tutorial applications can be found here.
CS/binMiscellaneous scripts used by the project maintainers.
CS/dataLocation of data files and maps distributed with Crystal Space.
CS/data/configMay applications and plugins utilize a (‘.cfg’) file. For convenience they are grouped here.
CS/data/shaderThis important directory contains shaders and other related information which is used by the Crystal Space engine.
CS/docsThe root of the Crystal Space documentation hierarchy. There are several subdirectories.
CS/docs/texinfoTexinfo is the master format for all Crystal Space documentation. This directory and its subdirectories contain all of the Texinfo source and images which comprise the Crystal Space manual. Most users need not concern themselves with this directory since the Texinfo documentation is automatically converted to HTML which is more accessible to the general user. Documentation writers and maintainers, however, may be interested in this directory.
CS/docs/html/manualThis directory contains the HTML conversion of the Texinfo Crystal Space manual. Most users will want to browse the file ‘CS/docs/html/manual/index.html’.
CS/docs/html/apiThis directory contains the Crystal Space SDK's public API reference manual. Most users will want to browse the file ‘CS/docs/html/api/index.html’.
CS/docs/supportThis directory contains support scripts and templates for automatically generating documentation.
CS/includeThese are the public Crystal Space header files. These headers will be installed as part of the SDK when you invoke ‘make install’ or ‘jam install’.
CS/libsHere is where the utility-like modules reside which you can link into your applications or plugins. There are relatively few such libraries since most of Crystal Space's functionality is provided in the form of plugin modules.
CS/libs/csgeomThe geometry module. Various geometry related functions and classes can be found here: matrices, vectors, transforms, clipper, planes, etc.
CS/libs/csgfxThe graphics module. Here you will find bumpmapping, mipmapping, quantizers, and routines to support loading an image file (through the various image loading plug-ins).
CS/libs/cstoolThis module contains high-level utility functions which rely upon the other modules, and possibly upon plugin modules. It is possible to write programs without utilizing this module, but it does provide several convenience classes for common cases and is, therefore, quite valuable.
CS/libs/csutilThis module contains various low-level utilities. The utilities include an archiver, configuration manager, virtual clock, scheduler, strings, hash tables, SCF (see section Shared Class Facility (SCF)), MD5 algorithm, command-line parser, event structures, and many others.
CS/libs/csutil/genericGeneric implementations of possibly platform-specific functionality.
CS/libs/csutil/macosxMacOS/X-specific functionality.
CS/libs/csutil/unixUnix-specific functionality.
CS/libs/csutil/win32Windows-specific functionality.
CS/libs/csplugincommonA collection of convenience modules which eliminate much of the drudgery associated with implementing SCF interfaces in certain types of common plugin modules. For example, the ‘csGraphics2D’ class in ‘csplugincommon/canvas’ implements the ‘iGraphics2D’ interface and provides much of the functionality common to most canvases. Likewise, the ‘csGraphics3D’ class in ‘csplugincommon/render3d’ implements the ‘iGraphics3D’ interface and provides much functionality common to renderers. You are not required to utilize these implementations when authoring your own plugins, but they are available for your convenience and may prove to be handy time-savers.
CS/libs/csplugincommon/canvasCommon canvas functionality.
CS/libs/csplugincommon/directxCommon Direct-X functionality.
CS/libs/csplugincommon/imageloaderCommon image loader functionality.
CS/libs/csplugincommon/macosxCommon MacOS/X functionality.
CS/libs/csplugincommon/openglCommon OpenGL functionality.
CS/libs/csplugincommon/particlesysCommon particle system functionality.
CS/libs/csplugincommon/render3dCommon renderer functionality.
CS/libs/csplugincommon/renderstepCommon render-loop functionality.
CS/libs/csplugincommon/shaderCommon shader functionality.
CS/libs/csplugincommon/soundloaderCommon sound loader functionality.
CS/libs/csplugincommon/soundrendererCommon sound renderer functionality.
CS/libs/csplugincommon/win32Common Microsoft Windows functionality.
CS/mkThis directory contains support facilities for the configuration and build systems.
CS/mk/autoconfHandy Autoconf utility macros which may be of use to external projects based upon Crystal space.
CS/mk/jamHandy Jam rules which may be of use to external projects based upon Crystal Space.
CS/mk/msvcgenComponent for automatic generation of Visual C++ project files based upon information gleaned from Jamfiles project-wide.
CS/mk/msvcProject files for Microsoft Windows using MSVC 6.0 and 7.0.
CS/pluginsDynamically loaded plug-ins. Communication with these modules is performed strictly via SCF interfaces. See section Shared Class Facility (SCF).
CS/plugins/bugplugCrystal Space debugger.
CS/plugins/collideCollision detection plugins.
CS/plugins/collide/opcodeThis is the Opcode collision detection plugin which is based upon the Opcode library.
CS/plugins/consoleVarious console plugins for input/output. A console is often overlaid atop the 3D display.
CS/plugins/cscriptThe Crystal Script plugins. Crystal Script plugins allow programmers to interact with the Crystal Space engine via a scripting language.
CS/plugins/cscript/csjavaJava interface.
CS/plugins/cscript/csperl5Perl5 interface.
CS/plugins/cscript/cspythonPython interface.
CS/plugins/csparserA plugin which parses structured map files and imports the map into the 3D engine. The standard map file format is XML, however the parser can parse any structured document which can be represented by an ‘iDocument’ interface.
CS/plugins/csparser/servicesCrystal Space format loader services.
CS/plugins/cullingVisibility culling plug-ins.
CS/plugins/culling/dynavisDynavis visibility culling system.
CS/plugins/culling/frustvisFrustvis visibility culling system (default culler if no other is selected).
CS/plugins/deviceHardware device plugins.
CS/plugins/device/joystickJoystick support.
CS/plugins/engineThe 3D engine which drives Crystal Space.
CS/plugins/engine/3dThe 3D engine plugin.
CS/plugins/filesysFilesystem-related plugins.
CS/plugins/filesys/vfsVirtual filesystem, VFS. See section Virtual File System (VFS).
CS/plugins/fontCollection of font servers.
CS/plugins/font/server/csfontStandard (bitmapped) Crystal Space font server.
CS/plugins/font/server/freefontFreeType (version 2) font server.
CS/plugins/font/server/fontplexFont server multiplexer.
CS/plugins/meshVarious mesh object implementations (see section Mesh Object Plug-In System). For every mesh object there is typically one implementation in ‘object/’ and one or more loader/saver plugins in ‘persist/’. ‘persist/standard/’ is the loader in Crystal Space format.
CS/plugins/physicsPlug-ins relating to the physics of motion.
CS/plugins/physics/odedynamODE dynamics.
CS/plugins/physics/bulletBullet physics.
CS/plugins/reporterReporter.
CS/plugins/sequenceThis is the sequence manager which is useful for managing timed sequences of events such as for demos.
CS/plugins/sndsysAll sound-related plugins (see section Sound System).
CS/plugins/stdrepStandard reporter listener.
CS/plugins/videoAll rendering- and graphics-related plugins.
CS/plugins/video/canvasThe 2D driver component which manages creation of the Crystal Space window used for rendering and also supports limited 2D drawing capabilities (including 2D pixmaps).
CS/plugins/video/canvas/cacaColour ASCII Art driver.
CS/plugins/video/canvas/commonCommon code for 2D drivers.
CS/plugins/video/canvas/ddrawWindows DirectDraw driver.
CS/plugins/video/canvas/directxcommonCommon DirectX (Win32) code.
CS/plugins/video/canvas/macosxMacOS/X OpenGL and CoreGraphics graphics drivers.
CS/plugins/video/canvas/memoryMemory driver (render a scene directly to memory).
CS/plugins/video/canvas/null2dA do-nothing 2D canvas.
CS/plugins/video/canvas/openglcommonCommon code for all OpenGL 2D drivers.
CS/plugins/video/canvas/openglwinOpenGL 2D driver for Windows.
CS/plugins/video/canvas/openglxOpenGL 2D driver for X11.
CS/plugins/video/canvas/softxX11 software 2D driver.
CS/plugins/video/canvas/xextf86vmX-extension driver (X11).
CS/plugins/video/canvas/xextshmMIT X-extension shared memory driver (X11).
CS/plugins/video/canvas/xwindowX-window X11 driver.
CS/plugins/video/loaderLoaders for various graphics file formats.
CS/plugins/video/rendererThe 3D rasterizer component is required by the 3D engine but may also be used in a standalone environment. It requires a 2D canvas.
CS/plugins/video/renderer/commonCommon code for 3D rasterizers.
CS/plugins/video/renderer/nullA do-nothing renderer (required when working only with 2D graphics).
CS/plugins/video/renderer/openglOpenGL renderer.
CS/plugins/video/renderer/softwareSoftware (non-accelerated) renderer.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This document was generated using texi2html 1.76.