xoreos  0.0.5
surface.h
Go to the documentation of this file.
1 /* xoreos - A reimplementation of BioWare's Aurora engine
2  *
3  * xoreos is the legal property of its developers, whose names
4  * can be found in the AUTHORS file distributed with this source
5  * distribution.
6  *
7  * xoreos is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * xoreos is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
25 #ifndef GRAPHICS_IMAGES_SURFACE_H
26 #define GRAPHICS_IMAGES_SURFACE_H
27 
29 
30 namespace Graphics {
31 
32 class Surface : public ImageDecoder {
33 public:
34  Surface(int width, int height);
35  ~Surface();
36 
37  int getWidth () const;
38  int getHeight() const;
39  int getPitch() const { return getWidth() * 4; }
40 
41  byte *getData();
42  const byte *getData() const;
43 
44  void fill(byte r, byte g, byte b, byte a);
45 
47  const MipMap &getMipMap(size_t mipMap) const;
49  const MipMap &getMipMap() const;
51  MipMap &getMipMap();
52 };
53 
54 } // End of namespace Graphics
55 
56 #endif // GRAPHICS_IMAGES_SURFACE_H
Generic image decoder interface.
byte * getData()
Definition: surface.cpp:61
void fill(byte r, byte g, byte b, byte a)
Definition: surface.cpp:69
int getWidth() const
Definition: surface.cpp:53
const MipMap & getMipMap() const
Return a mip map.
Definition: surface.cpp:89
A generic interface for image decoders.
Definition: decoder.h:48
int getHeight() const
Definition: surface.cpp:57
Surface(int width, int height)
Definition: surface.cpp:32
int getPitch() const
Definition: surface.h:39
uint8 byte
Definition: types.h:209