doxygen: add newline after \file
[blender.git] / source / blender / blenlib / intern / bitmap.c
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  * The Original Code is Copyright (C) 2012 by Nicholas Bishop
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bli
22  *
23  * Utility functions for variable size bitmasks.
24  */
25
26 #include <string.h>
27 #include <limits.h>
28
29 #include "BLI_utildefines.h"
30 #include "BLI_bitmap.h"
31
32 /** Set or clear all bits in the bitmap. */
33 void BLI_bitmap_set_all(BLI_bitmap *bitmap, bool set, size_t bits)
34 {
35         memset(bitmap, set ? UCHAR_MAX : 0, BLI_BITMAP_SIZE(bits));
36 }
37
38 /** Invert all bits in the bitmap. */
39 void BLI_bitmap_flip_all(BLI_bitmap *bitmap, size_t bits)
40 {
41         size_t num_blocks = _BITMAP_NUM_BLOCKS(bits);
42         for (size_t i = 0; i < num_blocks; i++) {
43                 bitmap[i] ^= ~(BLI_bitmap)0;
44         }
45 }
46
47 /** Copy all bits from one bitmap to another. */
48 void BLI_bitmap_copy_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits)
49 {
50         memcpy(dst, src, BLI_BITMAP_SIZE(bits));
51 }
52
53 /** Combine two bitmaps with boolean AND. */
54 void BLI_bitmap_and_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits)
55 {
56         size_t num_blocks = _BITMAP_NUM_BLOCKS(bits);
57         for (size_t i = 0; i < num_blocks; i++) {
58                 dst[i] &= src[i];
59         }
60 }
61
62 /** Combine two bitmaps with boolean OR. */
63 void BLI_bitmap_or_all(BLI_bitmap *dst, const BLI_bitmap *src, size_t bits)
64 {
65         size_t num_blocks = _BITMAP_NUM_BLOCKS(bits);
66         for (size_t i = 0; i < num_blocks; i++) {
67                 dst[i] |= src[i];
68         }
69 }