csBackground Class Reference
[Crystal Space Windowing System]
This class is meant for displaying textured or gradiented backgrounds.
More...
#include <csws/csbackgr.h>
Public Member Functions | |
csBackground () | |
Create a black background object. | |
~csBackground () | |
Destroy the object. | |
void | Free () |
Free the background. | |
void | SetTexture (iTextureHandle *iTex) |
Set background texture. | |
iTextureHandle * | GetTexture () |
Query background texture. | |
void | SetColor (int iIndex, csRGBcolor &iColor) |
Set Nth (0-3) color of the background. | |
csRGBcolor & | GetColor (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
|
Create a black background object.
|
|
Destroy the object.
|
Member Function Documentation
|
Draw the background.
|
|
Free the background.
Definition at line 75 of file csbackgr.h. References SetTexture(). |
|
Get the flat color of this background.
Definition at line 98 of file csbackgr.h. |
|
Get Nth (0-3) color of the background.
Definition at line 90 of file csbackgr.h. |
|
Query background texture.
Definition at line 82 of file csbackgr.h. |
|
Query background type.
Definition at line 106 of file csbackgr.h. References csBackgroundType. |
|
Set the flat color of this background.
Definition at line 94 of file csbackgr.h. |
|
Set Nth (0-3) color of the background.
Definition at line 86 of file csbackgr.h. |
|
Set background texture.
Referenced by Free(). |
|
Set background type.
Definition at line 102 of file csbackgr.h. |
The documentation for this class was generated from the following file:
- csws/csbackgr.h
Generated for Crystal Space by doxygen 1.3.9.1