Cleanup: misc spelling fixes
[blender.git] / source / blender / draw / intern / draw_cache_inline.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
20  * \ingroup draw
21  */
22
23 #ifndef __DRAW_CACHE_INLINE_H__
24 #define __DRAW_CACHE_INLINE_H__
25
26 #include "MEM_guardedalloc.h"
27 #include "GPU_batch.h"
28
29 /* Common */
30 // #define DRW_DEBUG_MESH_CACHE_REQUEST
31
32 #ifdef DRW_DEBUG_MESH_CACHE_REQUEST
33 #  define DRW_ADD_FLAG_FROM_VBO_REQUEST(flag, vbo, value) \
34     (flag |= DRW_vbo_requested(vbo) ? (printf("  VBO requested " #vbo "\n") ? value : value) : 0)
35 #  define DRW_ADD_FLAG_FROM_IBO_REQUEST(flag, ibo, value) \
36     (flag |= DRW_ibo_requested(ibo) ? (printf("  IBO requested " #ibo "\n") ? value : value) : 0)
37 #else
38 #  define DRW_ADD_FLAG_FROM_VBO_REQUEST(flag, vbo, value) \
39     (flag |= DRW_vbo_requested(vbo) ? (value) : 0)
40 #  define DRW_ADD_FLAG_FROM_IBO_REQUEST(flag, ibo, value) \
41     (flag |= DRW_ibo_requested(ibo) ? (value) : 0)
42 #endif
43
44 /* Test and assign NULL if test fails */
45 #define DRW_TEST_ASSIGN_VBO(v) (v = (DRW_vbo_requested(v) ? (v) : NULL))
46 #define DRW_TEST_ASSIGN_IBO(v) (v = (DRW_ibo_requested(v) ? (v) : NULL))
47
48 BLI_INLINE GPUBatch *DRW_batch_request(GPUBatch **batch)
49 {
50   /* XXX TODO(fclem): We are writing to batch cache here. Need to make this thread safe. */
51   if (*batch == NULL) {
52     *batch = MEM_callocN(sizeof(GPUBatch), "GPUBatch");
53   }
54   return *batch;
55 }
56
57 BLI_INLINE bool DRW_batch_requested(GPUBatch *batch, int prim_type)
58 {
59   /* Batch has been requested if it has been created but not initialized. */
60   if (batch != NULL && batch->verts[0] == NULL) {
61     /* HACK. We init without a valid VBO and let the first vbo binding
62      * fill verts[0]. */
63     GPU_batch_init_ex(batch, prim_type, (GPUVertBuf *)1, NULL, 0);
64     batch->verts[0] = NULL;
65     return true;
66   }
67   return false;
68 }
69
70 BLI_INLINE void DRW_ibo_request(GPUBatch *batch, GPUIndexBuf **ibo)
71 {
72   if (*ibo == NULL) {
73     *ibo = MEM_callocN(sizeof(GPUIndexBuf), "GPUIndexBuf");
74   }
75   GPU_batch_vao_cache_clear(batch);
76   batch->elem = *ibo;
77 }
78
79 BLI_INLINE bool DRW_ibo_requested(GPUIndexBuf *ibo)
80 {
81   /* TODO do not rely on data uploaded. This prevents multithreading.
82    * (need access to a gl context) */
83   return (ibo != NULL && ibo->ibo_id == 0 && ibo->data == NULL);
84 }
85
86 BLI_INLINE void DRW_vbo_request(GPUBatch *batch, GPUVertBuf **vbo)
87 {
88   if (*vbo == NULL) {
89     *vbo = MEM_callocN(sizeof(GPUVertBuf), "GPUVertBuf");
90   }
91   /* HACK set first vbo if not init. */
92   if (batch->verts[0] == NULL) {
93     GPU_batch_vao_cache_clear(batch);
94     batch->verts[0] = *vbo;
95   }
96   else {
97     /* HACK: bypass assert */
98     int vbo_vert_len = (*vbo)->vertex_len;
99     (*vbo)->vertex_len = batch->verts[0]->vertex_len;
100     GPU_batch_vertbuf_add(batch, *vbo);
101     (*vbo)->vertex_len = vbo_vert_len;
102   }
103 }
104
105 BLI_INLINE bool DRW_vbo_requested(GPUVertBuf *vbo)
106 {
107   return (vbo != NULL && vbo->format.attr_len == 0);
108 }
109
110 #endif /* __DRAW_CACHE_INLINE_H__ */