code cleanup: make header defines more consistent, JOYSENSOR header guard had a typo...
[blender-staging.git] / source / blender / imbuf / intern / dds / Image.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributors: Amorilia (amorilia@users.sourceforge.net)
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/imbuf/intern/dds/Image.h
24  *  \ingroup imbdds
25  */
26
27
28 /*
29  * This file is based on a similar file from the NVIDIA texture tools
30  * (http://nvidia-texture-tools.googlecode.com/)
31  *
32  * Original license from NVIDIA follows.
33  */
34
35 // This code is in the public domain -- castanyo@yahoo.es
36
37 #ifndef __IMAGE_H__
38 #define __IMAGE_H__
39
40 #include <Common.h>
41 #include <Color.h>
42
43 /// 32 bit RGBA image.
44 class Image
45 {
46 public:
47         
48         enum Format 
49         {
50                 Format_RGB,
51                 Format_ARGB,
52         };
53         
54         Image();
55         ~Image();
56         
57         void allocate(uint w, uint h);
58 #if 0
59         bool load(const char * name);
60         
61         void wrap(void * data, uint w, uint h);
62         void unwrap();
63 #endif
64         
65         uint width() const;
66         uint height() const;
67         
68         const Color32 * scanline(uint h) const;
69         Color32 * scanline(uint h);
70         
71         const Color32 * pixels() const;
72         Color32 * pixels();
73         
74         const Color32 & pixel(uint idx) const;
75         Color32 & pixel(uint idx);
76         
77         const Color32 & pixel(uint x, uint y) const;
78         Color32 & pixel(uint x, uint y);
79         
80         Format format() const;
81         void setFormat(Format f);
82         
83 private:
84         void free();
85         
86 private:
87         uint m_width;
88         uint m_height;
89         Format m_format;
90         Color32 * m_data;
91 };
92
93
94 inline const Color32 & Image::pixel(uint x, uint y) const
95 {
96         return pixel(y * width() + x);
97 }
98
99 inline Color32 & Image::pixel(uint x, uint y)
100 {
101         return pixel(y * width() + x);
102 }
103
104 #endif  /* __IMAGE_H__ */