CrystalSpace

Public API Reference

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

csBackground Class Reference
[Crystal Space Windowing System]

This class is meant for displaying textured or gradiented backgrounds. More...

#include <csbackgr.h>

List of all members.

Public Methods

 csBackground ()
 Create a black background object.

 ~csBackground ()
 Destroy the object.

void Free ()
 Free the background.

void SetTexture (iTextureHandle *iTex)
 Set background texture.

iTextureHandleGetTexture ()
 Query background texture.

void SetColor (int iIndex, csRGBcolor &iColor)
 Set Nth (0-3) color of the background.

csRGBcolorGetColor (int iIndex)
 Get Nth (0-3) color of the background.

void SetColor (int iColor)
 Set the flat color of this background.

int GetColor ()
 Get the flat color of this background.

void SetType (csBackgroundType iType)
 Set background type.

csBackgroundType GetType ()
 Query background type.

void Draw (csComponent &This, int x, int y, int w, int h, int xorg, int yorg, uint8 iAlpha)
 Draw the background.


Detailed Description

This class is meant for displaying textured or gradiented backgrounds.

This is not a component; it is mainly meant for use by skins.

Definition at line 56 of file csbackgr.h.


Constructor & Destructor Documentation

csBackground::csBackground  
 

Create a black background object.

csBackground::~csBackground  
 

Destroy the object.


Member Function Documentation

void csBackground::Draw csComponent   This,
int    x,
int    y,
int    w,
int    h,
int    xorg,
int    yorg,
uint8    iAlpha
 

Draw the background.

void csBackground::Free   [inline]
 

Free the background.

Definition at line 75 of file csbackgr.h.

int csBackground::GetColor   [inline]
 

Get the flat color of this background.

Definition at line 98 of file csbackgr.h.

csRGBcolor& csBackground::GetColor int    iIndex [inline]
 

Get Nth (0-3) color of the background.

Definition at line 90 of file csbackgr.h.

iTextureHandle* csBackground::GetTexture   [inline]
 

Query background texture.

Definition at line 82 of file csbackgr.h.

csBackgroundType csBackground::GetType   [inline]
 

Query background type.

Definition at line 106 of file csbackgr.h.

References csBackgroundType.

void csBackground::SetColor int    iColor [inline]
 

Set the flat color of this background.

Definition at line 94 of file csbackgr.h.

References csbgColor.

void csBackground::SetColor int    iIndex,
csRGBcolor   iColor
[inline]
 

Set Nth (0-3) color of the background.

Definition at line 86 of file csbackgr.h.

References csbgGradient.

void csBackground::SetTexture iTextureHandle   iTex
 

Set background texture.

void csBackground::SetType csBackgroundType    iType [inline]
 

Set background type.

Definition at line 102 of file csbackgr.h.

References csBackgroundType.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18