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