CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Crystal Space 3D Engine


Modules

Lighting
Mesh support
Textures & Materials
Views & Cameras
Visibility

Compounds

struct  iEngine
 This interface is the main interface to the 3D engine. More...

struct  iImposter
 iImposter defines the interface a mesh (or other) class must implement to be used as imposter mesh by the engine. More...

struct  iMovable
 This interface describes the transformation between local object space of some model and world space (i.e. More...

struct  iMovableListener
 Implement this class if you're interested in hearing about movable changes. More...

struct  iObjectWatcher
 This is a generic object watcher. More...

struct  iObjectWatcherListener
 Implement this class if you're interested in hearing about object watcher events. More...

struct  iRegion
 A region. More...

struct  iRegionList
 A list of region objects. More...

struct  iSector
 The iSector interface is used to work with "sectors". More...

struct  iSectorCallback
 Set a callback which is called when this sector is traversed. More...

struct  iSectorIterator
 An iterator to iterate over sectors. More...

struct  iSectorList
 A list of sectors. More...

struct  iSharedVariable
 iSharedVariable implements a refcounted float value which can be shared across many objects and updated efficiently. More...

struct  iSharedVariableList
 A list of shared variables. More...


GetNearbyLights() flags

#define CS_NLIGHT_SHADOWS   1
 Detect shadows and don't return lights for which the object is shadowed (not implemented yet). More...

#define CS_NLIGHT_STATIC   2
 Return static lights. More...

#define CS_NLIGHT_DYNAMIC   4
 Return dynamic lights. More...

#define CS_NLIGHT_NEARBYSECTORS   8
 Also check lights in nearby sectors (not implemented yet). More...


SetLightingCacheMode() settings

#define CS_ENGINE_CACHE_READ   1
 Read the cache. More...

#define CS_ENGINE_CACHE_WRITE   2
 Write the cache. More...

#define CS_ENGINE_CACHE_NOUPDATE   4
 Do not calculate lighting if not up-to-date. More...


RegisterRenderPriority() flags

#define CS_RENDPRI_NONE   0
 Do not sort this priority. More...

#define CS_RENDPRI_BACK2FRONT   1
 Sort this priority back to front. More...

#define CS_RENDPRI_FRONT2BACK   2
 Sort this priority front to back. More...


Operations

Operations indicate what has changed in one of the objects that is being watched.

#define CS_WATCH_NONE   0
 No operation recorded yet. More...

#define CS_WATCH_LIGHT_DESTROY   1
 Light has been destroyed. More...

#define CS_WATCH_LIGHT_MOVE   2
 Light has moved. More...

#define CS_WATCH_LIGHT_RADIUS   3
 Light has changed radius. More...

#define CS_WATCH_LIGHT_COLOR   4
 Light has changed color. More...

#define CS_WATCH_LIGHT_SECTOR   5
 Light has changed sector. More...

#define CS_WATCH_MOVABLE_DESTROY   6
 Movable has been destroyed. More...

#define CS_WATCH_MOVABLE_CHANGED   7
 Movable has changed otherwise. More...


Define Documentation

#define CS_ENGINE_CACHE_NOUPDATE   4
 

Do not calculate lighting if not up-to-date.

On by default.

Definition at line 122 of file iengine/engine.h.

#define CS_ENGINE_CACHE_READ   1
 

Read the cache.

Definition at line 112 of file iengine/engine.h.

#define CS_ENGINE_CACHE_WRITE   2
 

Write the cache.

Definition at line 117 of file iengine/engine.h.

#define CS_NLIGHT_DYNAMIC   4
 

Return dynamic lights.

Definition at line 99 of file iengine/engine.h.

#define CS_NLIGHT_NEARBYSECTORS   8
 

Also check lights in nearby sectors (not implemented yet).

Definition at line 104 of file iengine/engine.h.

#define CS_NLIGHT_SHADOWS   1
 

Detect shadows and don't return lights for which the object is shadowed (not implemented yet).

Definition at line 89 of file iengine/engine.h.

#define CS_NLIGHT_STATIC   2
 

Return static lights.

Definition at line 94 of file iengine/engine.h.

#define CS_RENDPRI_BACK2FRONT   1
 

Sort this priority back to front.

Definition at line 135 of file iengine/engine.h.

#define CS_RENDPRI_FRONT2BACK   2
 

Sort this priority front to back.

Definition at line 140 of file iengine/engine.h.

#define CS_RENDPRI_NONE   0
 

Do not sort this priority.

Definition at line 130 of file iengine/engine.h.

#define CS_WATCH_LIGHT_COLOR   4
 

Light has changed color.

Definition at line 46 of file iengine/objwatch.h.

#define CS_WATCH_LIGHT_DESTROY   1
 

Light has been destroyed.

Definition at line 40 of file iengine/objwatch.h.

#define CS_WATCH_LIGHT_MOVE   2
 

Light has moved.

Definition at line 42 of file iengine/objwatch.h.

#define CS_WATCH_LIGHT_RADIUS   3
 

Light has changed radius.

Definition at line 44 of file iengine/objwatch.h.

#define CS_WATCH_LIGHT_SECTOR   5
 

Light has changed sector.

Definition at line 48 of file iengine/objwatch.h.

#define CS_WATCH_MOVABLE_CHANGED   7
 

Movable has changed otherwise.

Definition at line 52 of file iengine/objwatch.h.

#define CS_WATCH_MOVABLE_DESTROY   6
 

Movable has been destroyed.

Definition at line 50 of file iengine/objwatch.h.

#define CS_WATCH_NONE   0
 

No operation recorded yet.

Definition at line 38 of file iengine/objwatch.h.


Generated for Crystal Space by doxygen 1.2.14