svn merge ^/trunk/blender -r47201:47210
[blender.git] / source / blender / blenlib / BLI_bitmap.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  * The Original Code is Copyright (C) 2012 by Nicholas Bishop
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BLI_BITMAP_H__
27 #define __BLI_BITMAP_H__
28
29 typedef unsigned int *BLI_bitmap;
30
31 /* warning: the bitmap does not keep track of its own size or check
32  * for out-of-bounds access */
33
34 /* internal use */
35 /* 2^5 = 32 (bits) */
36 #define BLI_BITMAP_POWER 5
37 /* 0b11111 */
38 #define BLI_BITMAP_MASK 31
39
40 /* number of blocks needed to hold '_tot' bits */
41 #define BLI_BITMAP_NUM_BLOCKS(_tot) \
42         (((_tot) >> BLI_BITMAP_POWER) + 1)
43
44 /* size (in bytes) used to hold '_tot' bits */
45 #define BLI_BITMAP_SIZE(_tot) \
46         (BLI_BITMAP_NUM_BLOCKS(_tot) * sizeof(unsigned int))
47
48 /* allocate memory for a bitmap with '_tot' bits; free
49  *  with MEM_freeN() */
50 #define BLI_BITMAP_NEW(_tot, _alloc_string) \
51         ((BLI_bitmap)MEM_callocN(BLI_BITMAP_SIZE(_tot), \
52                                  _alloc_string))
53
54 /* get the value of a single bit at '_index' */
55 #define BLI_BITMAP_GET(_bitmap, _index) \
56         ((_bitmap)[(_index) >> BLI_BITMAP_POWER] & \
57          (1 << ((_index) & BLI_BITMAP_MASK)))
58
59 /* set the value of a single bit at '_index' */
60 #define BLI_BITMAP_SET(_bitmap, _index) \
61         ((_bitmap)[(_index) >> BLI_BITMAP_POWER] |= \
62          (1 << ((_index) & BLI_BITMAP_MASK)))
63
64 /* clear the value of a single bit at '_index' */
65 #define BLI_BITMAP_CLEAR(_bitmap, _index) \
66         ((_bitmap)[(_index) >> BLI_BITMAP_POWER] &= \
67          ~(1 << ((_index) & BLI_BITMAP_MASK)))
68
69 /* set or clear the value of a single bit at '_index' */
70 #define BLI_BITMAP_MODIFY(_bitmap, _index, _set) \
71         do { \
72                 if (_set) \
73                         BLI_BITMAP_SET(_bitmap, _index); \
74                 else \
75                         BLI_BITMAP_CLEAR(_bitmap, _index); \
76         } while (0)
77
78 /* resize bitmap to have space for '_tot' bits */
79 #define BLI_BITMAP_RESIZE(_bitmap, _tot) \
80         (_bitmap) = MEM_reallocN(_bitmap, BLI_BITMAP_SIZE(_tot))
81
82 #endif