File: csbackgr.h

package info (click to toggle)
crystalspace 0.94-20020412-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 62,276 kB
  • ctags: 52,843
  • sloc: cpp: 274,783; ansic: 6,608; perl: 6,276; objc: 3,952; asm: 2,942; python: 2,354; php: 542; pascal: 530; sh: 430; makefile: 370; awk: 193
file content (104 lines) | stat: -rw-r--r-- 2,721 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
    Crystal Space Windowing System: background class
    Copyright (C) 2000 by Andrew Zabolotny <bit@eltech.ru>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CSBACKGR_H__
#define __CSBACKGR_H__

#include "csgfx/rgbpixel.h"

struct iTextureHandle;
class csApp;
class csComponent;

/// Background type
enum csBackgroundType
{
  /// No background
  csbgNone = 0,
  /// Single-color background
  csbgColor,
  /// Gradient background
  csbgGradient,
  /// Textured background
  csbgTextured
};

/**
 * This class is meant for displaying textured or gradiented backgrounds.
 * This is not a component; it is mainly meant for use by skins.
 */
class csBackground
{
  /// Background type
  csBackgroundType type;
  /// The background texture (if not NULL)
  iTextureHandle *tex;
  /// Gradient colors (for all four corners)
  csRGBcolor colors [4];
  /// The uniform background color (if type == csbgColor)
  int color;

public:
  /// Create a black background object
  csBackground ();

  /// Destroy the object
  ~csBackground ();

  /// Free the background
  void Free ()
  { SetTexture (NULL); }

  /// Set background texture
  void SetTexture (iTextureHandle *iTex);

  /// Query background texture
  iTextureHandle *GetTexture ()
  { return tex; }

  /// Set Nth (0-3) color of the background
  void SetColor (int iIndex, csRGBcolor &iColor)
  { colors [iIndex] = iColor; type = csbgGradient; }

  /// Get Nth (0-3) color of the background
  csRGBcolor &GetColor (int iIndex)
  { return colors [iIndex]; }

  /// Set the flat color of this background
  void SetColor (int iColor)
  { color = iColor; type = csbgColor; }

  /// Get the flat color of this background
  int GetColor ()
  { return color; }

  /// Set background type
  void SetType (csBackgroundType iType)
  { type = iType; }

  /// Query background type
  csBackgroundType GetType ()
  { return type; }

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

#endif // __CSBACKGR_H__