Public API Reference

                 

---

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. More...
	~csBackground ()
	Destroy the object. More...
void	Free ()
	Free the background. More...
void	SetTexture (iTextureHandle *iTex)
	Set background texture. More...
iTextureHandle *	GetTexture ()
	Query background texture. More...
void	SetColor (int iIndex, csRGBcolor &iColor)
	Set Nth (0-3) color of the background. More...
csRGBcolor &	GetColor (int iIndex)
	Get Nth (0-3) color of the background. More...
void	SetColor (int iColor)
	Set the flat color of this background. More...
int	GetColor ()
	Get the flat color of this background. More...
void	SetType (csBackgroundType iType)
	Set background type. More...
csBackgroundType	GetType ()
	Query background type. More...
void	Draw (csComponent &This, int x, int y, int w, int h, int xorg, int yorg, uint8 iAlpha)
	Draw the background. More...

---

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 54 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 73 of file csbackgr.h. References SetTexture.

int csBackground::GetColor (    )  [inline]

Get the flat color of this background. Definition at line 96 of file csbackgr.h.

csRGBcolor& csBackground::GetColor (  int    iIndex )  [inline]

Get Nth (0-3) color of the background. Definition at line 88 of file csbackgr.h.

iTextureHandle* csBackground::GetTexture (    )  [inline]

Query background texture. Definition at line 80 of file csbackgr.h.

csBackgroundType csBackground::GetType (    )  [inline]

Query background type. Definition at line 104 of file csbackgr.h. References csBackgroundType.

void csBackground::SetColor (  int    iColor )  [inline]

Set the flat color of this background. Definition at line 92 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 84 of file csbackgr.h. References csbgGradient.

void csBackground::SetTexture (  iTextureHandle *    iTex )

Set background texture. Referenced by Free.

void csBackground::SetType (  csBackgroundType    iType )  [inline]

Set background type. Definition at line 100 of file csbackgr.h. References csBackgroundType.

---

The documentation for this class was generated from the following file:

• csbackgr.h

---