Cleanup: Typos in comments (to to)
[blender.git] / source / blender / blenloader / BLO_blend_defs.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16 #ifndef __BLO_BLEND_DEFS_H__
17 #define __BLO_BLEND_DEFS_H__
18
19 /** \file BLO_blend_defs.h
20  *  \ingroup blenloader
21  *  \brief defines for blendfile codes
22  */
23
24 /* INTEGER CODES */
25 #ifdef __BIG_ENDIAN__
26 /* Big Endian */
27 #  define BLEND_MAKE_ID(a, b, c, d) ( (int)(a) << 24 | (int)(b) << 16 | (c) << 8 | (d) )
28 #else
29 /* Little Endian */
30 #  define BLEND_MAKE_ID(a, b, c, d) ( (int)(d) << 24 | (int)(c) << 16 | (b) << 8 | (a) )
31 #endif
32
33 /**
34  * Codes used for #BHead.code.
35  *
36  * These coexist with ID codes such as #ID_OB, #ID_SCE ... etc.
37  */
38 enum {
39         /**
40          * Arbitrary allocated memory
41          * (typically owned by #ID's, will be freed when there are no users).
42          */
43         DATA = BLEND_MAKE_ID('D', 'A', 'T', 'A'),
44         /**
45          * Used for #Global struct.
46          */
47         GLOB = BLEND_MAKE_ID('G', 'L', 'O', 'B'),
48         /**
49          * Used for storing the encoded SDNA string
50          * (decoded into an #SDNA on load).
51          */
52         DNA1 = BLEND_MAKE_ID('D', 'N', 'A', '1'),
53         /**
54          * Used to store thumbnail previews, written between #REND and #GLOB blocks,
55          * (ignored for regular file reading).
56          */
57         TEST = BLEND_MAKE_ID('T', 'E', 'S', 'T'),
58         /**
59          * Used for #RenderInfo, basic Scene and frame range info,
60          * can be easily read by other applications without writing a full blend file parser.
61          */
62         REND = BLEND_MAKE_ID('R', 'E', 'N', 'D'),
63         /**
64          * Used for #UserDef, (user-preferences data).
65          * (written to #BLENDER_STARTUP_FILE & #BLENDER_USERPREF_FILE).
66          */
67         USER = BLEND_MAKE_ID('U', 'S', 'E', 'R'),
68         /**
69          * Terminate reading (no data).
70          */
71         ENDB = BLEND_MAKE_ID('E', 'N', 'D', 'B'),
72 };
73
74 #define BLEN_THUMB_MEMSIZE_FILE(_x, _y) (sizeof(int) * (2 + (size_t)(_x) * (size_t)(_y)))
75
76 #endif  /* __BLO_BLEND_DEFS_H__ */