Bugfix #20574: New 3D View regions were all had their 'type' set to 'RGN_TYPE_UI...
[blender-staging.git] / source / blender / gpu / gpu_buffers.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2005 Blender Foundation.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): Brecht Van Lommel.
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 #ifndef __GPU_BUFFERS_H__
34 #define __GPU_BUFFERS_H__
35
36 #define MAX_FREE_GPU_BUFFERS 8
37
38 #ifdef _DEBUG
39 /*#define DEBUG_VBO(X) printf(X)*/
40 #define DEBUG_VBO(X)
41 #else
42 #define DEBUG_VBO(X)
43 #endif
44
45 #ifdef _DEBUG
46 #define ERROR_VBO(X) printf(X)
47 #else
48 #define ERROR_VBO(X)
49 #endif
50
51 struct DerivedMesh;
52 struct GHash;
53
54 /* V - vertex, N - normal, T - uv, C - color
55    F - float, UB - unsigned byte */
56 #define GPU_BUFFER_INTER_V3F    1
57 #define GPU_BUFFER_INTER_N3F    2
58 #define GPU_BUFFER_INTER_T2F    3
59 #define GPU_BUFFER_INTER_C3UB   4
60 #define GPU_BUFFER_INTER_C4UB   5
61 #define GPU_BUFFER_INTER_END    -1
62
63 typedef struct GPUBuffer
64 {
65         int size;       /* in bytes */
66         void *pointer;  /* used with vertex arrays */
67         unsigned int id;        /* used with vertex buffer objects */
68 } GPUBuffer;
69
70 typedef struct GPUBufferPool
71 {
72         int size;       /* number of allocated buffers stored */
73         GPUBuffer* buffers[MAX_FREE_GPU_BUFFERS];
74 } GPUBufferPool;
75
76 typedef struct GPUBufferMaterial
77 {
78         int start;      /* at which vertex in the buffer the material starts */
79         int end;        /* at which vertex it ends */
80         char mat_nr;
81 } GPUBufferMaterial;
82
83 typedef struct IndexLink {
84         int element;
85         struct IndexLink *next;
86 } IndexLink;
87
88 typedef struct GPUDrawObject
89 {
90         GPUBuffer *vertices;
91         GPUBuffer *normals;
92         GPUBuffer *uv;
93         GPUBuffer *colors;
94         GPUBuffer *edges;
95         GPUBuffer *uvedges;
96
97         int     *faceRemap;                     /* at what index was the face originally in DerivedMesh */
98         IndexLink *indices;             /* given an index, find all elements using it */
99         IndexLink *indexMem;    /* for faster memory allocation/freeing */
100         int indexMemUsage;              /* how many are already allocated */
101         int colType;
102
103         GPUBufferMaterial *materials;
104
105         int nmaterials;
106         int nelements;  /* (number of faces) * 3 */
107         int nlooseverts;
108         int nedges;
109         int nindices;
110         int legacy;     /* if there was a failure allocating some buffer, use old rendering code */
111
112 } GPUDrawObject;
113
114 typedef struct GPUAttrib
115 {
116         int index;
117         int size;
118         int type;
119 } GPUAttrib;
120
121 GPUBufferPool *GPU_buffer_pool_new();
122 void GPU_buffer_pool_free( GPUBufferPool *pool );       /* TODO: Find a place where to call this function on exit */
123
124 GPUBuffer *GPU_buffer_alloc( int size, GPUBufferPool *pool );
125 void GPU_buffer_free( GPUBuffer *buffer, GPUBufferPool *pool );
126
127 GPUDrawObject *GPU_drawobject_new( struct DerivedMesh *dm );
128 void GPU_drawobject_free( struct DerivedMesh *dm );
129
130 /* Buffers for non-DerivedMesh drawing */
131 void *GPU_build_mesh_buffers(struct GHash *map, struct MVert *mvert,
132                         struct MFace *mface, int *face_indices,
133                         int totface, int *vert_indices, int uniq_verts,
134                         int totvert);
135 void GPU_update_mesh_buffers(void *buffers, struct MVert *mvert,
136                         int *vert_indices, int totvert);
137 void *GPU_build_grid_buffers(struct DMGridData **grids,
138         int *grid_indices, int totgrid, int gridsize);
139 void GPU_update_grid_buffers(void *buffers_v, struct DMGridData **grids,
140         int *grid_indices, int totgrid, int gridsize);
141 void GPU_draw_buffers(void *buffers);
142 void GPU_free_buffers(void *buffers);
143
144 /* called before drawing */
145 void GPU_vertex_setup( struct DerivedMesh *dm );
146 void GPU_normal_setup( struct DerivedMesh *dm );
147 void GPU_uv_setup( struct DerivedMesh *dm );
148 void GPU_color_setup( struct DerivedMesh *dm );
149 void GPU_edge_setup( struct DerivedMesh *dm );  /* does not mix with other data */
150 void GPU_uvedge_setup( struct DerivedMesh *dm );
151 void GPU_interleaved_setup( GPUBuffer *buffer, int data[] );
152 int GPU_attrib_element_size( GPUAttrib data[], int numdata );
153 void GPU_interleaved_attrib_setup( GPUBuffer *buffer, GPUAttrib data[], int numdata );
154
155 /* can't lock more than one buffer at once */
156 void *GPU_buffer_lock( GPUBuffer *buffer );     
157 void *GPU_buffer_lock_stream( GPUBuffer *buffer );
158 void GPU_buffer_unlock( GPUBuffer *buffer );
159
160 /* upload three unsigned chars, representing RGB colors, for each vertex. Resets dm->drawObject->colType to -1 */
161 void GPU_color3_upload( struct DerivedMesh *dm, unsigned char *data );
162 /* upload four unsigned chars, representing RGBA colors, for each vertex. Resets dm->drawObject->colType to -1 */
163 void GPU_color4_upload( struct DerivedMesh *dm, unsigned char *data );
164 /* switch color rendering on=1/off=0 */
165 void GPU_color_switch( int mode );
166
167 void GPU_buffer_draw_elements( GPUBuffer *elements, unsigned int mode, int start, int count );
168
169 /* called after drawing */
170 void GPU_buffer_unbind();
171
172 int GPU_buffer_legacy( struct DerivedMesh *dm );
173
174 #endif