Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / draw / intern / draw_instance_data.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  * Copyright 2016, Blender Foundation.
17  */
18
19 /** \file \ingroup draw
20  */
21
22 #ifndef __DRAW_INSTANCE_DATA_H__
23 #define __DRAW_INSTANCE_DATA_H__
24
25 #include "BLI_compiler_attrs.h"
26 #include "BLI_sys_types.h"
27
28 #include "GPU_batch.h"
29
30 #define MAX_INSTANCE_DATA_SIZE 64 /* Can be adjusted for more */
31
32 typedef struct DRWInstanceData DRWInstanceData;
33 typedef struct DRWInstanceDataList DRWInstanceDataList;
34
35 struct DRWShadingGroup;
36
37 void *DRW_instance_data_next(DRWInstanceData *idata);
38 DRWInstanceData *DRW_instance_data_request(
39         DRWInstanceDataList *idatalist, uint attr_size);
40
41 void DRW_batching_buffer_request(
42         DRWInstanceDataList *idatalist, GPUVertFormat *format, GPUPrimType type, struct DRWShadingGroup *shgroup,
43         GPUBatch **r_batch, GPUVertBuf **r_vert);
44 void DRW_instancing_buffer_request(
45         DRWInstanceDataList *idatalist, GPUVertFormat *format, GPUBatch *instance, struct DRWShadingGroup *shgroup,
46         GPUBatch **r_batch, GPUVertBuf **r_vert);
47
48 /* Upload all instance data to the GPU as soon as possible. */
49 void DRW_instance_buffer_finish(DRWInstanceDataList *idatalist);
50
51 void DRW_instance_data_list_reset(DRWInstanceDataList *idatalist);
52 void DRW_instance_data_list_free_unused(DRWInstanceDataList *idatalist);
53 void DRW_instance_data_list_resize(DRWInstanceDataList *idatalist);
54
55 #endif /* __DRAW_INSTANCE_DATA_H__ */