doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / imbuf / intern / dds / PixelFormat.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributors: Amorilia (amorilia@gamebox.net)
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /*
26  * This file is based on a similar file from the NVIDIA texture tools
27  * (http://nvidia-texture-tools.googlecode.com/)
28  *
29  * Original license from NVIDIA follows.
30  */
31
32 // Copyright NVIDIA Corporation 2007 -- Ignacio Castano <icastano@nvidia.com>
33 // 
34 // Permission is hereby granted, free of charge, to any person
35 // obtaining a copy of this software and associated documentation
36 // files (the "Software"), to deal in the Software without
37 // restriction, including without limitation the rights to use,
38 // copy, modify, merge, publish, distribute, sublicense, and/or sell
39 // copies of the Software, and to permit persons to whom the
40 // Software is furnished to do so, subject to the following
41 // conditions:
42 // 
43 // The above copyright notice and this permission notice shall be
44 // included in all copies or substantial portions of the Software.
45 // 
46 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
47 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
48 // OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
49 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
50 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
51 // WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
52 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
53 // OTHER DEALINGS IN THE SOFTWARE.
54
55 #ifndef _DDS_PIXELFORMAT_H
56 #define _DDS_PIXELFORMAT_H
57
58 #include <Common.h>
59
60         namespace PixelFormat
61         {
62
63                 // Convert component @a c having @a inbits to the returned value having @a outbits.
64                 inline uint convert(uint c, uint inbits, uint outbits)
65                 {
66                         if (inbits == 0)
67                         {
68                                 return 0;
69                         }
70                         else if (inbits >= outbits)
71                         {
72                                 // truncate
73                                 return c >> (inbits - outbits);
74                         }
75                         else
76                         {
77                                 // bitexpand
78                                 return (c << (outbits - inbits)) | convert(c, inbits, outbits - inbits);
79                         }
80                 }
81
82                 // Get pixel component shift and size given its mask.
83                 inline void maskShiftAndSize(uint mask, uint * shift, uint * size)
84                 {
85                         if (!mask)
86                         {
87                                 *shift = 0;
88                                 *size = 0;
89                                 return;
90                         }
91
92                         *shift = 0;
93                         while((mask & 1) == 0) {
94                                 ++(*shift);
95                                 mask >>= 1;
96                         }
97                         
98                         *size = 0;
99                         while((mask & 1) == 1) {
100                                 ++(*size);
101                                 mask >>= 1;
102                         }
103                 }
104
105         } // PixelFormat namespace
106
107 #endif // _DDS_IMAGE_PIXELFORMAT_H