Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / gpu / GPU_select.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  * The Original Code is Copyright (C) 2014 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup gpu
21  */
22
23 #ifndef __GPU_SELECT_H__
24 #define __GPU_SELECT_H__
25
26 #include "BLI_sys_types.h"
27
28 struct rcti;
29
30 /* flags for mode of operation */
31 enum {
32         GPU_SELECT_ALL                      = 1,
33         /* gpu_select_query */
34         GPU_SELECT_NEAREST_FIRST_PASS       = 2,
35         GPU_SELECT_NEAREST_SECOND_PASS      = 3,
36         /* gpu_select_pick */
37         GPU_SELECT_PICK_ALL           = 4,
38         GPU_SELECT_PICK_NEAREST       = 5,
39 };
40
41 void GPU_select_begin(unsigned int *buffer, unsigned int bufsize, const struct rcti *input, char mode, int oldhits);
42 bool GPU_select_load_id(unsigned int id);
43 void GPU_select_finalize(void);
44 unsigned int GPU_select_end(void);
45
46 /* cache selection region */
47 bool GPU_select_is_cached(void);
48 void GPU_select_cache_begin(void);
49 void GPU_select_cache_load_id(void);
50 void GPU_select_cache_end(void);
51
52 /* utilities */
53 const uint *GPU_select_buffer_near(const uint *buffer, int hits);
54
55 #endif