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