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