CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

Crystal Space Windowing System


Modules

group  Components
group  Layouting
group  Skin support
group  Standard dialogs

Classes

class  csBackground
 This class is meant for displaying textured or gradiented backgrounds. More...
class  csGraphicsPipeline
 Graphics System pipeline class. More...
class  csMousePointer
 This class encapsulates mouse pointer. More...
class  csMouse
 This class handles mouse pointer and generates mouse events. More...
class  csWSTexture
 Texture representation within the windowing system. More...
class  csWSTexVector
 This class is a vector of csWSTexture's. More...
class  csWindowList
 Window List class. More...

Defines

#define MAX_CSWS_PIPELINE_LENGTH   16384
 Maximal number of primitives which can be drawn IN ONE FRAME.
#define MAX_SYNC_PAGES   8
 Maximal number of video pages to sync image.

Enumerations

enum  csBackgroundType { csbgNone = 0, csbgColor, csbgGradient, csbgTextured }
 Background type. More...

Functions

void RectUnion (cswsRectVector &rect, csRect &result)
 Compute the biggest union of a set of adjanced rectangles (i.e.
void ParseConfigBitmap (csApp *app, const char *prefix, const char *section, const char *id, int &x, int &y, int &w, int &h)
 Find a bitmap definition in one of CSWS.CFG bitmap arrays.
void csHLS2RGB (float h, float l, float s, float &r, float &g, float &b)
 Convert HLS to RGB.
void csRGB2HLS (float r, float g, float b, float &h, float &l, float &s)
 Convert RGB to HLS.
void csGetRGB (int iColor, csApp *iApp, float &r, float &g, float &b)
 Get a color's R,G,B components (iColor as returned by csApp::FindColor).
csButtoncsNewToolbarButton (csComponent *iToolbar, int iCommand, char *iText, csButtonFrameStyle iFrameStyle=csbfsThinRect, int iButtonStyle=CSBS_SHIFT|CSBS_TEXTBELOW)
 The short way to add a text button to a toolbar.
csButtoncsNewToolbarButton (csComponent *iToolbar, int iCommand, csPixmap *bmpup=0, csPixmap *bmpdn=0, csButtonFrameStyle iFrameStyle=csbfsThinRect, int iButtonStyle=CSBS_SHIFT, bool iDeletePixmaps=true)
 The short way to add a icon button to a toolbar.
csPixmapNewBitmap (csApp *app, char *texturename, int tx, int ty, int tw, int th)
 Create and return a new bitmap (2D sprite).

Current CrystalSpace Windowing System class hierarchy

   |--[ csRect ]			// Rectangle
   |--[ csGraphicsPipeline ]  	// Deferred drawing pipeline
   +--[ csComponent ]         	// Windowing System component
        |--[ csMouse ]		// Mouse cursor
        |--[ csApp ]			// Windowing System application
        |--[ csWindow ]		// A window with titlebar, menu, client window etc
        |--[ csTitleBar ]		// title bar
        |--[ csMenu ]			// popup menu / menu bar
        |--[ csDialog ]		// dialog client window
        |--[ csStatic ]		// static control
        |    +--[ csColorWheel ]	// color wheel control
        |--[ csButton ]		// button control
        |    |--[ csCheckBox ]	// check box control
        |    +--[ csRadioButton ]	// radio button control
        |--[ csScrollBar ]		// scroll bar control
        |--[ csInputLine ]		// input line control
        |    +--[ csSpinBox ]		// spin box control
        |--[ csListBox ]		// list box control
        |--[ csNotebook ]		// notebook control
        |--[ csGrid ]			// grid control
        |--[ csSplitter ]		// splitter control
        |--[ csTreeCtrl ]		// tree control
        +--[ csLayout ]		// layout control
        |    |--[ csLayout2 ]	        // layout control 2
        |    |--[ csAbsolueLayout ]	// absolute layout
        |    |--[ csBoxLayout ]	// box layout
        |    |--[ csFlowLayout ]	// flow layout
        |    |--[ csBorderLayout ]	// border layout
        |    |--[ csGridLayout ]	// grid layout
        |    |--[ csGridBagLayout ]	// gridbag layout

 

Define Documentation

#define MAX_CSWS_PIPELINE_LENGTH   16384
 

Maximal number of primitives which can be drawn IN ONE FRAME.

Definition at line 43 of file csgfxppl.h.

#define MAX_SYNC_PAGES   8
 

Maximal number of video pages to sync image.

Definition at line 45 of file csgfxppl.h.


Enumeration Type Documentation

enum csBackgroundType
 

Background type.

Enumeration values:
csbgNone  No background.
csbgColor  Single-color background.
csbgGradient  Gradient background.
csbgTextured  Textured background.

Definition at line 40 of file csbackgr.h.

Referenced by csBackground::GetType().


Function Documentation

void csGetRGB int  iColor,
csApp iApp,
float &  r,
float &  g,
float &  b
 

Get a color's R,G,B components (iColor as returned by csApp::FindColor).

void csHLS2RGB float  h,
float  l,
float  s,
float &  r,
float &  g,
float &  b
 

Convert HLS to RGB.

csButton* csNewToolbarButton csComponent iToolbar,
int  iCommand,
csPixmap bmpup = 0,
csPixmap bmpdn = 0,
csButtonFrameStyle  iFrameStyle = csbfsThinRect,
int  iButtonStyle = CSBS_SHIFT,
bool  iDeletePixmaps = true
 

The short way to add a icon button to a toolbar.

csButton* csNewToolbarButton csComponent iToolbar,
int  iCommand,
char *  iText,
csButtonFrameStyle  iFrameStyle = csbfsThinRect,
int  iButtonStyle = CSBS_SHIFT|CSBS_TEXTBELOW
 

The short way to add a text button to a toolbar.

void csRGB2HLS float  r,
float  g,
float  b,
float &  h,
float &  l,
float &  s
 

Convert RGB to HLS.

csPixmap* NewBitmap csApp app,
char *  texturename,
int  tx,
int  ty,
int  tw,
int  th
 

Create and return a new bitmap (2D sprite).

void ParseConfigBitmap csApp app,
const char *  prefix,
const char *  section,
const char *  id,
int &  x,
int &  y,
int &  w,
int &  h
 

Find a bitmap definition in one of CSWS.CFG bitmap arrays.

void RectUnion cswsRectVector rect,
csRect result
 

Compute the biggest union of a set of adjanced rectangles (i.e.

rectangles do not overlap and can have adjanced edges).


Generated for Crystal Space by doxygen 1.3.9.1