CrystalSpace

Public API Reference

CS Namespace Reference
[Geometry utilitiesGeometry utilitiesGraphics3DCommon Plugin ClassesCommon Plugin ClassesCommon Plugin ClassesCommon Plugin ClassesCommon Plugin ClassesMemory ManagementMemory ManagementEvent handlingMemory ManagementUtilitiesUtilitiesUtilities3D]

Main namespace for CrystalSpace. More...


Classes

struct  AllocPlatform
class  CowWrapper
 Copy-on-write wrapper for arbitrary types. More...
class  DataBuffer
 This is an implementation of iDataBuffer interface. More...
class  ImageAutoConvert
 Small wrapper class to automatically convert an image into a different storage format, if needed. More...
class  MeasureTime
 Simple helper class to measure execution time of a block. More...
class  NumberedFilenameHelper
 Helper to deal with numbered filename. More...
class  RenderBufferPersistent
 Render buffer wrapper with additional persistence information. More...
class  RenderViewClipper
 Helper to clip in the context of a render view. More...
class  ShaderVariableContextImpl
 Simple implementation for iShaderVariableContext. More...
struct  ShaderVarName
 Helper class to obtain an ID for a shader variable. More...
class  SpinLock
class  StructuredTextureFormat
 Structured representation of a texture format. More...
class  SubRectangles
 A class managing allocations of sub-rectangles. More...
class  SubRectanglesCompact
 A variation of SubRectangles that tries to place rectangles in a rectangular fashion. More...
class  TextureFormatStrings
 Texture format string parser routines. More...
class  TriangleIndicesStream
 Helper class to extract triangles from an index buffer. More...
struct  TriangleT
 A templated triangle. More...
class  UberScreenshotMaker
 Helper to create "überscreenshots", screenshots with a resolution larger than the current framebuffer resolution. More...

Namespaces

namespace  Debug
 Debugging utilities and helpers.
namespace  Deprecated
 Contains deprecated code that will be removed after next stable release.
namespace  DocSystem
 Document system / XML helper classes.
namespace  DocumentHelper
 For compatibility.
namespace  Implementation
namespace  Macros
namespace  Math
 Mathematical functions and definitions.
namespace  Memory
 Memory allocation.
namespace  Meta
 Meta-programming helpers.
namespace  Platform
 Platform specific code and wrappers.
namespace  Plugin
 Implementation of all plugins.
namespace  PluginCommon
 Common code shared among a number of plugins.
namespace  SndSys
namespace  Threading
 Functions and classes for threading, locking and atomic operations.
namespace  Utility
 Assorted utility functions and classes that doesn't belong anywhere else.

Typedefs

typedef
CS::Utility::ImportKit 
ImportKit
 Import kit, old name.
typedef
Implementation::NonCopyable_ 
NonCopyable

Functions

template<class T, class Fn, class P>
CS_FORCEINLINE_TEMPLATEMETHOD
Fn & 
ForEach (T it, Fn &Func, P &p)
 Iterate over all elements in the iterator and perform operation given by Func.
template<class T, class Fn>
CS_FORCEINLINE_TEMPLATEMETHOD
Fn & 
ForEach (T *start, T *end, Fn &Func)
 Iterate over all elements in the list and perform operation given by Func.
template<class T, class Fn>
CS_FORCEINLINE_TEMPLATEMETHOD
Fn & 
ForEach (T it, Fn &Func)
 Iterate over all elements in the iterator and perform operation given by Func.
csHandlerID RegisterWeakListener (iEventQueue *q, iEventHandler *listener, csRef< iEventHandler > &handler)
 Helper function for registering an event handler using a weak reference.
void RemoveWeakListener (iEventQueue *q, csRef< iEventHandler > &handler)
 Helper function for removing an event handler that was registered with RegisterWeakListener().
char * StrDup (const wchar_t *s)
 Allocate a char string with cs_malloc() and copy an UTF-8 version of the string into the newly allocated storage.
char * StrDup (const char *s)
 Allocate a char string with cs_malloc() and copy the string into the newly allocated storage.
wchar_tStrDupW (const char *s)
 Allocate a wide char string with cs_malloc() and copy the string converted from UTF-8 into the newly allocated storage.
wchar_tStrDupW (const wchar_t *s)
 Allocate a wide char string with cs_malloc() and copy the string into the newly allocated storage.
template<class T>
CS_FORCEINLINE_TEMPLATEMETHOD
void 
Swap (T &a, T &b)
 Swap two elements.


Detailed Description

Main namespace for CrystalSpace.

Typedef Documentation

Import kit, old name.

Deprecated:
Use CS::Utility::ImportKit instead.

Definition at line 212 of file importkit.h.


Function Documentation

template<class T, class Fn, class P>
CS_FORCEINLINE_TEMPLATEMETHOD Fn& CS::ForEach ( it,
Fn &  Func,
P &  p 
) [inline]

Iterate over all elements in the iterator and perform operation given by Func.

Definition at line 81 of file algorithms.h.

template<class T, class Fn>
CS_FORCEINLINE_TEMPLATEMETHOD Fn& CS::ForEach ( T *  start,
T *  end,
Fn &  Func 
) [inline]

Iterate over all elements in the list and perform operation given by Func.

Definition at line 66 of file algorithms.h.

template<class T, class Fn>
CS_FORCEINLINE_TEMPLATEMETHOD Fn& CS::ForEach ( it,
Fn &  Func 
) [inline]

Iterate over all elements in the iterator and perform operation given by Func.

 csArray<int> anArray;
 anArray.Push (1);
 anArray.Push (4);
 ForEach (anArray.GetIterator (), OurFunctor ());

Definition at line 52 of file algorithms.h.

csHandlerID CS::RegisterWeakListener ( iEventQueue q,
iEventHandler listener,
csRef< iEventHandler > &  handler 
)

Helper function for registering an event handler using a weak reference.

Use RemoveWeakListener() to remove an event handler registered with this function.

void CS::RemoveWeakListener ( iEventQueue q,
csRef< iEventHandler > &  handler 
)

Helper function for removing an event handler that was registered with RegisterWeakListener().

char* CS::StrDup ( const wchar_t s  ) 

Allocate a char string with cs_malloc() and copy an UTF-8 version of the string into the newly allocated storage.

See also:
StrDup(const char*)

char* CS::StrDup ( const char *  s  ) 

Allocate a char string with cs_malloc() and copy the string into the newly allocated storage.

This is a handy method for copying strings, in fact it is an analogue of the strdup() function from string.h, but using cs_malloc(). (Also, strdup() is not present on some platforms). To free the pointer the caller should call cs_free().

wchar_t* CS::StrDupW ( const char *  s  ) 

Allocate a wide char string with cs_malloc() and copy the string converted from UTF-8 into the newly allocated storage.

See also:
StrDup(const char*)

wchar_t* CS::StrDupW ( const wchar_t s  ) 

Allocate a wide char string with cs_malloc() and copy the string into the newly allocated storage.

See also:
StrDup(const char*)

template<class T>
CS_FORCEINLINE_TEMPLATEMETHOD void CS::Swap ( T &  a,
T &  b 
) [inline]

Swap two elements.

Definition at line 34 of file algorithms.h.

Referenced by csSort().


Generated for Crystal Space 1.2.1 by doxygen 1.5.3