=bmesh= merge from trunk at r36153
[blender.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 /** \file GPU_buffers.h
34  *  \ingroup gpu
35  */
36
37 #ifndef __GPU_BUFFERS_H__
38 #define __GPU_BUFFERS_H__
39
40 #define MAX_FREE_GPU_BUFFERS 8
41
42 #ifdef _DEBUG
43 /*#define DEBUG_VBO(X) printf(X)*/
44 #define DEBUG_VBO(X)
45 #else
46 #define DEBUG_VBO(X)
47 #endif
48
49 #ifdef _DEBUG
50 #define ERROR_VBO(X) printf(X)
51 #else
52 #define ERROR_VBO(X)
53 #endif
54
55 struct DerivedMesh;
56 struct DMGridData;
57 struct GHash;
58 struct DMGridData;
59
60 /* V - vertex, N - normal, T - uv, C - color
61    F - float, UB - unsigned byte */
62 #define GPU_BUFFER_INTER_V3F    1
63 #define GPU_BUFFER_INTER_N3F    2
64 #define GPU_BUFFER_INTER_T2F    3
65 #define GPU_BUFFER_INTER_C3UB   4
66 #define GPU_BUFFER_INTER_C4UB   5
67 #define GPU_BUFFER_INTER_END    -1
68
69 typedef struct GPUBuffer
70 {
71         int size;       /* in bytes */
72         void *pointer;  /* used with vertex arrays */
73         unsigned int id;        /* used with vertex buffer objects */
74 } GPUBuffer;
75
76 /* stores deleted buffers so that new buffers wouldn't have to 
77 be recreated that often. */
78 typedef struct GPUBufferPool
79 {
80         int size;               /* number of allocated buffers stored */
81         int maxsize;    /* size of the array */
82         GPUBuffer **buffers;
83 } GPUBufferPool;
84
85 typedef struct GPUBufferMaterial
86 {
87         int start;      /* at which vertex in the buffer the material starts */
88         int end;        /* at which vertex it ends */
89         char mat_nr;
90 } GPUBufferMaterial;
91
92 typedef struct IndexLink {
93         int element;
94         struct IndexLink *next;
95 } IndexLink;
96
97 typedef struct GPUDrawObject
98 {
99         GPUBuffer *vertices;
100         GPUBuffer *normals;
101         GPUBuffer *uv;
102         GPUBuffer *colors;
103         GPUBuffer *edges;
104         GPUBuffer *uvedges;
105
106         int     *faceRemap;                     /* at what index was the face originally in DerivedMesh */
107         IndexLink *indices;             /* given an index, find all elements using it */
108         IndexLink *indexMem;    /* for faster memory allocation/freeing */
109         int indexMemUsage;              /* how many are already allocated */
110         int colType;
111
112         GPUBufferMaterial *materials;
113
114         int nmaterials;
115         int nelements;  /* (number of faces) * 3 */
116         int nlooseverts;
117         int nedges;
118         int nindices;
119         int legacy;     /* if there was a failure allocating some buffer, use old rendering code */
120
121 } GPUDrawObject;
122
123 /* used for GLSL materials */
124 typedef struct GPUAttrib
125 {
126         int index;
127         int size;
128         int type;
129 } GPUAttrib;
130
131 GPUBufferPool *GPU_buffer_pool_new(void);
132 void GPU_buffer_pool_free( GPUBufferPool *pool );
133 void GPU_buffer_pool_free_unused( GPUBufferPool *pool );
134
135 GPUBuffer *GPU_buffer_alloc( int size, GPUBufferPool *pool );
136 void GPU_buffer_free( GPUBuffer *buffer, GPUBufferPool *pool );
137
138 GPUDrawObject *GPU_drawobject_new( struct DerivedMesh *dm );
139 void GPU_drawobject_free( struct DerivedMesh *dm );
140
141 /* Buffers for non-DerivedMesh drawing */
142 void *GPU_build_mesh_buffers(struct GHash *map, struct MVert *mvert,
143                         struct MFace *mface, int *face_indices,
144                         int totface, int *vert_indices, int uniq_verts,
145                         int totvert);
146 void GPU_update_mesh_buffers(void *buffers, struct MVert *mvert,
147                         int *vert_indices, int totvert);
148 void *GPU_build_grid_buffers(struct DMGridData **grids,
149         int *grid_indices, int totgrid, int gridsize);
150 void GPU_update_grid_buffers(void *buffers_v, struct DMGridData **grids,
151         int *grid_indices, int totgrid, int gridsize, int smooth);
152 void GPU_draw_buffers(void *buffers);
153 void GPU_free_buffers(void *buffers);
154
155 /* called before drawing */
156 void GPU_vertex_setup( struct DerivedMesh *dm );
157 void GPU_normal_setup( struct DerivedMesh *dm );
158 void GPU_uv_setup( struct DerivedMesh *dm );
159 void GPU_color_setup( struct DerivedMesh *dm );
160 void GPU_edge_setup( struct DerivedMesh *dm );  /* does not mix with other data */
161 void GPU_uvedge_setup( struct DerivedMesh *dm );
162 void GPU_interleaved_setup( GPUBuffer *buffer, int data[] );
163 int GPU_attrib_element_size( GPUAttrib data[], int numdata );
164 void GPU_interleaved_attrib_setup( GPUBuffer *buffer, GPUAttrib data[], int numdata );
165
166 /* can't lock more than one buffer at once */
167 void *GPU_buffer_lock( GPUBuffer *buffer );     
168 void *GPU_buffer_lock_stream( GPUBuffer *buffer );
169 void GPU_buffer_unlock( GPUBuffer *buffer );
170
171 /* upload three unsigned chars, representing RGB colors, for each vertex. Resets dm->drawObject->colType to -1 */
172 void GPU_color3_upload( struct DerivedMesh *dm, unsigned char *data );
173 /* upload four unsigned chars, representing RGBA colors, for each vertex. Resets dm->drawObject->colType to -1 */
174 void GPU_color4_upload( struct DerivedMesh *dm, unsigned char *data );
175 /* switch color rendering on=1/off=0 */
176 void GPU_color_switch( int mode );
177
178 void GPU_buffer_draw_elements( GPUBuffer *elements, unsigned int mode, int start, int count );
179
180 /* called after drawing */
181 void GPU_buffer_unbind(void);
182
183 /* used to check whether to use the old (without buffers) code */
184 int GPU_buffer_legacy( struct DerivedMesh *dm );
185
186 #endif