macro formatting & remve some unused code.
[blender.git] / source / blender / python / generic / bgl.h
1 /* 
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * This is a new part of Blender.
23  *
24  * Contributor(s): Willian P. Germano
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/python/generic/bgl.h
30  *  \ingroup pygen
31  */
32
33
34 /* This is the Blender.BGL part of opy_draw.c, from the old bpython/intern
35  * dir, with minor changes to adapt it to the new Python implementation.
36  * The BGL submodule "wraps" OpenGL functions and constants, allowing script
37  * writers to make OpenGL calls in their Python scripts for Blender.  The
38  * more important original comments are marked with an @ symbol. */
39
40 #ifndef BGL_H
41 #define BGL_H
42
43 PyObject *BPyInit_bgl(void);
44
45 /*@ Create a buffer object */
46 /*@ dimensions is an array of ndimensions integers representing the size of each dimension */
47 /*@ initbuffer if not NULL holds a contiguous buffer with the correct format from which the buffer will be initialized */
48 struct _Buffer *BGL_MakeBuffer( int type, int ndimensions, int *dimensions, void *initbuffer );
49 /*@ Return the size of buffer element, type must be one of GL_BYTE, GL_SHORT, GL_INT, GL_FLOAT or GL_DOUBLE */
50 /*@ returns -1 otherwise */
51 int BGL_typeSize( int type );
52
53 /*@ Buffer Object */
54 /*@ For Python access to OpenGL functions requiring a pointer. */
55 typedef struct _Buffer {
56         PyObject_VAR_HEAD 
57         PyObject *parent;
58
59         int type;               /* GL_BYTE, GL_SHORT, GL_INT, GL_FLOAT */
60         int ndimensions;
61         int *dimensions;
62
63         union {
64                 char *asbyte;
65                 short *asshort;
66                 int *asint;
67                 float *asfloat;
68                 double *asdouble;
69
70                 void *asvoid;
71         } buf;
72 } Buffer;
73
74 /*@ The type object */
75 extern PyTypeObject BGL_bufferType;
76
77 /*@ By golly George! It looks like fancy pants macro time!!! */
78
79 /*
80 #define int_str       "i"
81 #define int_var(number)   bgl_int##number
82 #define int_ref(number)   &bgl_int##number
83 #define int_def(number)   int int_var(number)
84
85 #define float_str     "f"
86 #define float_var(number) bgl_float##number
87 #define float_ref(number) &bgl_float##number
88 #define float_def(number) float float_var(number)
89 */
90
91 /* TYPE_str is the string to pass to Py_ArgParse (for the format) */
92 /* TYPE_var is the name to pass to the GL function */
93 /* TYPE_ref is the pointer to pass to Py_ArgParse (to store in) */
94 /* TYPE_def is the C initialization of the variable */
95
96 #define void_str      ""
97 #define void_var(num)
98 #define void_ref(num)   &bgl_var##num
99 #define void_def(num)   char bgl_var##num
100
101 #define buffer_str      "O!"
102 #define buffer_var(number)  (bgl_buffer##number)->buf.asvoid
103 #define buffer_ref(number)  &BGL_bufferType, &bgl_buffer##number
104 #define buffer_def(number)  Buffer *bgl_buffer##number
105
106 /* GL Pointer fields, handled by buffer type */
107 /* GLdoubleP, GLfloatP, GLintP, GLuintP, GLshortP */
108
109 #define GLbooleanP_str      "O!"
110 #define GLbooleanP_var(number)  (bgl_buffer##number)->buf.asvoid
111 #define GLbooleanP_ref(number)  &BGL_bufferType, &bgl_buffer##number
112 #define GLbooleanP_def(number)  Buffer *bgl_buffer##number
113
114 #define GLbyteP_str     "O!"
115 #define GLbyteP_var(number) (bgl_buffer##number)->buf.asvoid
116 #define GLbyteP_ref(number) &BGL_bufferType, &bgl_buffer##number
117 #define GLbyteP_def(number) Buffer *bgl_buffer##number
118
119 #define GLubyteP_str      "O!"
120 #define GLubyteP_var(number)  (bgl_buffer##number)->buf.asvoid
121 #define GLubyteP_ref(number)  &BGL_bufferType, &bgl_buffer##number
122 #define GLubyteP_def(number)  Buffer *bgl_buffer##number
123
124 #define GLintP_str      "O!"
125 #define GLintP_var(number)  (bgl_buffer##number)->buf.asvoid
126 #define GLintP_ref(number)  &BGL_bufferType, &bgl_buffer##number
127 #define GLintP_def(number)  Buffer *bgl_buffer##number
128
129 #define GLuintP_str     "O!"
130 #define GLuintP_var(number) (bgl_buffer##number)->buf.asvoid
131 #define GLuintP_ref(number) &BGL_bufferType, &bgl_buffer##number
132 #define GLuintP_def(number) Buffer *bgl_buffer##number
133
134 #define GLshortP_str      "O!"
135 #define GLshortP_var(number)  (bgl_buffer##number)->buf.asvoid
136 #define GLshortP_ref(number)  &BGL_bufferType, &bgl_buffer##number
137 #define GLshortP_def(number)  Buffer *bgl_buffer##number
138
139 #define GLushortP_str     "O!"
140 #define GLushortP_var(number) (bgl_buffer##number)->buf.asvoid
141 #define GLushortP_ref(number) &BGL_bufferType, &bgl_buffer##number
142 #define GLushortP_def(number) Buffer *bgl_buffer##number
143
144 #define GLfloatP_str      "O!"
145 #define GLfloatP_var(number)  (bgl_buffer##number)->buf.asvoid
146 #define GLfloatP_ref(number)  &BGL_bufferType, &bgl_buffer##number
147 #define GLfloatP_def(number)  Buffer *bgl_buffer##number
148
149 #define GLdoubleP_str     "O!"
150 #define GLdoubleP_var(number) (bgl_buffer##number)->buf.asvoid
151 #define GLdoubleP_ref(number) &BGL_bufferType, &bgl_buffer##number
152 #define GLdoubleP_def(number) Buffer *bgl_buffer##number
153
154 #define GLclampfP_str     "O!"
155 #define GLclampfP_var(number) (bgl_buffer##number)->buf.asvoid
156 #define GLclampfP_ref(number) &BGL_bufferType, &bgl_buffer##number
157 #define GLclampfP_def(number) Buffer *bgl_buffer##number
158
159 #define GLvoidP_str     "O!"
160 #define GLvoidP_var(number) (bgl_buffer##number)->buf.asvoid
161 #define GLvoidP_ref(number) &BGL_bufferType, &bgl_buffer##number
162 #define GLvoidP_def(number) Buffer *bgl_buffer##number
163
164 #define buffer_str      "O!"
165 #define buffer_var(number)  (bgl_buffer##number)->buf.asvoid
166 #define buffer_ref(number)  &BGL_bufferType, &bgl_buffer##number
167 #define buffer_def(number)  Buffer *bgl_buffer##number
168
169 /*@The standard GL typedefs are used as prototypes, we can't
170  * use the GL type directly because Py_ArgParse expects normal
171  * C types.
172  * 
173  * Py_ArgParse doesn't grok writing into unsigned variables, 
174  * so we use signed everything (even stuff that should be unsigned.
175  */
176
177 /* typedef unsigned int GLenum; */
178 #define GLenum_str      "i"
179 #define GLenum_var(num)   bgl_var##num
180 #define GLenum_ref(num)   &bgl_var##num
181 #define GLenum_def(num)   /* unsigned */ int GLenum_var(num)
182
183 /* typedef unsigned int GLboolean; */
184 #define GLboolean_str     "b"
185 #define GLboolean_var(num)    bgl_var##num
186 #define GLboolean_ref(num)    &bgl_var##num
187 #define GLboolean_def(num)    /* unsigned */ char GLboolean_var(num)
188
189 /* typedef unsigned int GLbitfield; */
190 #define GLbitfield_str      "i"
191 #define GLbitfield_var(num)   bgl_var##num
192 #define GLbitfield_ref(num)   &bgl_var##num
193 #define GLbitfield_def(num)   /* unsigned */ int GLbitfield_var(num)
194
195 /* typedef signed char GLbyte; */
196 #define GLbyte_str        "b"
197 #define GLbyte_var(num)     bgl_var##num
198 #define GLbyte_ref(num)     &bgl_var##num
199 #define GLbyte_def(num)     signed char GLbyte_var(num)
200
201 /* typedef short GLshort; */
202 #define GLshort_str       "h"
203 #define GLshort_var(num)    bgl_var##num
204 #define GLshort_ref(num)    &bgl_var##num
205 #define GLshort_def(num)    short GLshort_var(num)
206
207 /* typedef int GLint; */
208 #define GLint_str       "i"
209 #define GLint_var(num)      bgl_var##num
210 #define GLint_ref(num)      &bgl_var##num
211 #define GLint_def(num)      int GLint_var(num)
212
213 /* typedef int GLsizei; */
214 #define GLsizei_str       "i"
215 #define GLsizei_var(num)    bgl_var##num
216 #define GLsizei_ref(num)    &bgl_var##num
217 #define GLsizei_def(num)    int GLsizei_var(num)
218
219 /* typedef unsigned char GLubyte; */
220 #define GLubyte_str       "B"
221 #define GLubyte_var(num)    bgl_var##num
222 #define GLubyte_ref(num)    &bgl_var##num
223 #define GLubyte_def(num)    /* unsigned */ char GLubyte_var(num)
224
225 /* typedef unsigned short GLushort; */
226 #define GLushort_str      "H"
227 #define GLushort_var(num)   bgl_var##num
228 #define GLushort_ref(num)   &bgl_var##num
229 #define GLushort_def(num)   /* unsigned */ short GLushort_var(num)
230
231 /* typedef unsigned int GLuint; */
232 #define GLuint_str        "I"
233 #define GLuint_var(num)     bgl_var##num
234 #define GLuint_ref(num)     &bgl_var##num
235 #define GLuint_def(num)     /* unsigned */ int GLuint_var(num)
236
237 /* typedef float GLfloat; */
238 #define GLfloat_str       "f"
239 #define GLfloat_var(num)    bgl_var##num
240 #define GLfloat_ref(num)    &bgl_var##num
241 #define GLfloat_def(num)    float GLfloat_var(num)
242
243 /* typedef float GLclampf; */
244 #define GLclampf_str      "f"
245 #define GLclampf_var(num)   bgl_var##num
246 #define GLclampf_ref(num)   &bgl_var##num
247 #define GLclampf_def(num)   float GLclampf_var(num)
248
249 /* typedef double GLdouble; */
250 #define GLdouble_str      "d"
251 #define GLdouble_var(num)   bgl_var##num
252 #define GLdouble_ref(num)   &bgl_var##num
253 #define GLdouble_def(num)   double GLdouble_var(num)
254
255 /* typedef double GLclampd; */
256 #define GLclampd_str      "d"
257 #define GLclampd_var(num)   bgl_var##num
258 #define GLclampd_ref(num)   &bgl_var##num
259 #define GLclampd_def(num)   double GLclampd_var(num)
260
261 /* typedef void GLvoid; */
262 /* #define GLvoid_str       "" */
263 /* #define GLvoid_var(num)      bgl_var##num */
264 /* #define GLvoid_ref(num)      &bgl_var##num */
265 /* #define GLvoid_def(num)      char bgl_var##num */
266
267 #define arg_def1(a1)          a1##_def(1)
268 #define arg_def2(a1, a2)        arg_def1(a1); a2##_def(2)
269 #define arg_def3(a1, a2, a3)      arg_def2(a1, a2); a3##_def(3)
270 #define arg_def4(a1, a2, a3, a4)    arg_def3(a1, a2, a3); a4##_def(4)
271 #define arg_def5(a1, a2, a3, a4, a5)  arg_def4(a1, a2, a3, a4); a5##_def(5)
272 #define arg_def6(a1, a2, a3, a4, a5, a6)arg_def5(a1, a2, a3, a4, a5); a6##_def(6)
273 #define arg_def7(a1, a2, a3, a4, a5, a6, a7)arg_def6(a1, a2, a3, a4, a5, a6); a7##_def(7)
274 #define arg_def8(a1, a2, a3, a4, a5, a6, a7, a8)arg_def7(a1, a2, a3, a4, a5, a6, a7); a8##_def(8)
275 #define arg_def9(a1, a2, a3, a4, a5, a6, a7, a8, a9)arg_def8(a1, a2, a3, a4, a5, a6, a7, a8); a9##_def(9)
276 #define arg_def10(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)arg_def9(a1, a2, a3, a4, a5, a6, a7, a8, a9); a10##_def(10)
277
278 #define arg_var1(a1)          a1##_var(1)
279 #define arg_var2(a1, a2)        arg_var1(a1), a2##_var(2)
280 #define arg_var3(a1, a2, a3)      arg_var2(a1, a2), a3##_var(3)
281 #define arg_var4(a1, a2, a3, a4)    arg_var3(a1, a2, a3), a4##_var(4)
282 #define arg_var5(a1, a2, a3, a4, a5)  arg_var4(a1, a2, a3, a4), a5##_var(5)
283 #define arg_var6(a1, a2, a3, a4, a5, a6)arg_var5(a1, a2, a3, a4, a5), a6##_var(6)
284 #define arg_var7(a1, a2, a3, a4, a5, a6, a7)arg_var6(a1, a2, a3, a4, a5, a6), a7##_var(7)
285 #define arg_var8(a1, a2, a3, a4, a5, a6, a7, a8)arg_var7(a1, a2, a3, a4, a5, a6, a7), a8##_var(8)
286 #define arg_var9(a1, a2, a3, a4, a5, a6, a7, a8, a9)arg_var8(a1, a2, a3, a4, a5, a6, a7, a8), a9##_var(9)
287 #define arg_var10(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)arg_var9(a1, a2, a3, a4, a5, a6, a7, a8, a9), a10##_var(10)
288
289 #define arg_ref1(a1)          a1##_ref(1)
290 #define arg_ref2(a1, a2)        arg_ref1(a1), a2##_ref(2)
291 #define arg_ref3(a1, a2, a3)      arg_ref2(a1, a2), a3##_ref(3)
292 #define arg_ref4(a1, a2, a3, a4)    arg_ref3(a1, a2, a3), a4##_ref(4)
293 #define arg_ref5(a1, a2, a3, a4, a5)  arg_ref4(a1, a2, a3, a4), a5##_ref(5)
294 #define arg_ref6(a1, a2, a3, a4, a5, a6)arg_ref5(a1, a2, a3, a4, a5), a6##_ref(6)
295 #define arg_ref7(a1, a2, a3, a4, a5, a6, a7)arg_ref6(a1, a2, a3, a4, a5, a6), a7##_ref(7)
296 #define arg_ref8(a1, a2, a3, a4, a5, a6, a7, a8)arg_ref7(a1, a2, a3, a4, a5, a6, a7), a8##_ref(8)
297 #define arg_ref9(a1, a2, a3, a4, a5, a6, a7, a8, a9)arg_ref8(a1, a2, a3, a4, a5, a6, a7, a8), a9##_ref(9)
298 #define arg_ref10(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)arg_ref9(a1, a2, a3, a4, a5, a6, a7, a8, a9), a10##_ref(10)
299
300 #define arg_str1(a1)          a1##_str
301 #define arg_str2(a1, a2)        arg_str1(a1) a2##_str
302 #define arg_str3(a1, a2, a3)      arg_str2(a1, a2) a3##_str
303 #define arg_str4(a1, a2, a3, a4)    arg_str3(a1, a2, a3) a4##_str
304 #define arg_str5(a1, a2, a3, a4, a5)  arg_str4(a1, a2, a3, a4) a5##_str
305 #define arg_str6(a1, a2, a3, a4, a5, a6)arg_str5(a1, a2, a3, a4, a5) a6##_str
306 #define arg_str7(a1, a2, a3, a4, a5, a6, a7)arg_str6(a1, a2, a3, a4, a5, a6) a7##_str
307 #define arg_str8(a1, a2, a3, a4, a5, a6, a7, a8)arg_str7(a1, a2, a3, a4, a5, a6, a7) a8##_str
308 #define arg_str9(a1, a2, a3, a4, a5, a6, a7, a8, a9)arg_str8(a1, a2, a3, a4, a5, a6, a7, a8) a9##_str
309 #define arg_str10(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10)arg_str9(a1, a2, a3, a4, a5, a6, a7, a8, a9) a10##_str
310
311 #define ret_def_void
312 #define ret_set_void
313 #define ret_ret_void    return Py_INCREF(Py_None), Py_None
314
315 #define ret_def_GLint   int ret_int
316 #define ret_set_GLint   ret_int=
317 #define ret_ret_GLint   return PyLong_FromLong(ret_int)
318
319 #define ret_def_GLuint    unsigned int ret_uint
320 #define ret_set_GLuint    ret_uint=
321 #define ret_ret_GLuint    return PyLong_FromLong((long) ret_uint)
322
323 #define ret_def_GLenum    unsigned int ret_uint
324 #define ret_set_GLenum    ret_uint=
325 #define ret_ret_GLenum    return PyLong_FromLong((long) ret_uint)
326
327 #define ret_def_GLboolean unsigned char ret_bool
328 #define ret_set_GLboolean ret_bool=
329 #define ret_ret_GLboolean return PyLong_FromLong((long) ret_bool)
330
331 #define ret_def_GLstring  const unsigned char *ret_str;
332 #define ret_set_GLstring  ret_str=
333
334 #define ret_ret_GLstring                                                      \
335         if (ret_str) {                                                            \
336                 return PyUnicode_FromString((const char *)ret_str);                   \
337         }                                                                         \
338         else {                                                                    \
339                 PyErr_SetString(PyExc_AttributeError, "could not get opengl string"); \
340                 return NULL;                                                          \
341         }                                                                         \
342
343 #endif /* BGL_H */