doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / imbuf / intern / dds / Stream.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 /* simple memory stream functions with buffer overflow check */
26
27 #ifndef _STREAM_H
28 #define _STREAM_H
29
30 struct Stream
31 {
32         unsigned char *mem; // location in memory
33         unsigned int size;  // size
34         unsigned int pos;   // current position
35         Stream(unsigned char *m, unsigned int s) : mem(m), size(s), pos(0) {};
36         unsigned int seek(unsigned int p);
37 };
38
39 unsigned int mem_read(Stream & mem, unsigned long long & i);
40 unsigned int mem_read(Stream & mem, unsigned int & i);
41 unsigned int mem_read(Stream & mem, unsigned short & i);
42 unsigned int mem_read(Stream & mem, unsigned char & i);
43 unsigned int mem_read(Stream & mem, unsigned char *i, unsigned int cnt);
44
45 #endif // _STREAM_H
46