Fix syntax for ID keyword.
[blender.git] / source / blender / editors / include / BIF_glutil.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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation 2002-2008
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BIF_GLUTIL_H
29 #define BIF_GLUTIL_H
30
31 struct rcti;
32 struct rctf;
33
34 void fdrawbezier(float vec[4][3]);
35 void fdrawline(float x1, float y1, float x2, float y2);
36 void fdrawbox(float x1, float y1, float x2, float y2);
37 void sdrawline(short x1, short y1, short x2, short y2);
38 void sdrawtri(short x1, short y1, short x2, short y2);
39 void sdrawtrifill(short x1, short y1, short x2, short y2);
40 void sdrawbox(short x1, short y1, short x2, short y2);
41
42 void sdrawXORline(int x0, int y0, int x1, int y1);
43 void sdrawXORline4(int nr, int x0, int y0, int x1, int y1);
44
45 void fdrawXORellipse(float xofs, float yofs, float hw, float hh);
46 void fdrawXORcirc(float xofs, float yofs, float rad);
47
48 /* glStipple defines */
49 extern unsigned char stipple_halftone[128];
50 extern unsigned char stipple_quarttone[128];
51
52         /**
53          * Draw a lined (non-looping) arc with the given
54          * @a radius, starting at angle @a start and arcing 
55          * through @a angle. The arc is centered at the origin 
56          * and drawn in the XY plane.
57          * 
58          * @param start The initial angle (in radians).
59          * @param angle The length of the arc (in radians).
60          * @param radius The arc radius.
61          * @param nsegments The number of segments to use in drawing the arc.
62          */
63 void glutil_draw_lined_arc      (float start, float angle, float radius, int nsegments);
64
65         /**
66          * Draw a filled arc with the given @a radius, 
67          * starting at angle @a start and arcing through 
68          * @a angle. The arc is centered at the origin 
69          * and drawn in the XY plane.
70          * 
71          * @param start The initial angle (in radians).
72          * @param angle The length of the arc (in radians).
73          * @param radius The arc radius.
74          * @param nsegments The number of segments to use in drawing the arc.
75          */
76 void glutil_draw_filled_arc     (float start, float angle, float radius, int nsegments);
77
78         /**
79          * Routines an integer value as obtained by glGetIntegerv.
80          * The param must cause only one value to be gotten from GL.
81          */
82 int glaGetOneInteger            (int param);
83
84         /**
85          * Routines a float value as obtained by glGetIntegerv.
86          * The param must cause only one value to be gotten from GL.
87          */
88 float glaGetOneFloat            (int param);
89
90         /**
91          * Functions like glRasterPos2i, except ensures that the resulting
92          * raster position is valid. @a known_good_x and @a known_good_y
93          * should be coordinates of a point known to be within the current
94          * view frustum.
95          * @attention This routine should be used when the distance of @a x 
96          * and @y away from the known good point is small (ie. for small icons
97          * and for bitmap characters), when drawing large+zoomed images it is
98          * possible for overflow to occur, the glaDrawPixelsSafe routine should
99          * be used instead.
100          */
101 void glaRasterPosSafe2f         (float x, float y, float known_good_x, float known_good_y);
102
103         /**
104          * Functions like a limited glDrawPixels, except ensures that 
105          * the image is displayed onscreen even if the @a x and @a y 
106          * coordinates for would be clipped. The routine respects the
107          * glPixelZoom values, pixel unpacking parameters are _not_ 
108          * respected.
109
110          * @attention This routine makes many assumptions: the rect data
111          * is expected to be in RGBA unsigned byte format, the coordinate
112          * (0.375, 0.375) is assumed to be within the view frustum, and the 
113          * modelview and projection matrices are assumed to define a 
114          * 1-to-1 mapping to screen space.
115          * @attention Furthmore, in the case of zoomed or unpixel aligned
116          * images extending outside the view frustum, but still within the 
117          * window, some portion of the image may be visible left and/or
118          * below of the given @a x and @a y coordinates. It is recommended
119          * to use the glScissor functionality if images are to be drawn
120          * with an inset view matrix.
121          */
122 void glaDrawPixelsSafe          (float x, float y, int img_w, int img_h, int row_w, int format, int type, void *rect);
123
124         /**
125          * Functions like a limited glDrawPixels, but actually draws the
126          * image using textures, which can be tremendously faster on low-end
127          * cards, and also avoids problems with the raster position being
128          * clipped when offscreen. The routine respects the glPixelZoom values, 
129          * pixel unpacking parameters are _not_ respected.
130
131          * @attention This routine makes many assumptions: the rect data
132          * is expected to be in RGBA byte or float format, and the 
133          * modelview and projection matrices are assumed to define a 
134          * 1-to-1 mapping to screen space.
135          * @param gamma_correct Optionally gamma correct float sources to sRGB for display
136          */
137
138         /* only for float rects, converts to 32 bits and draws */
139 void glaDrawPixelsSafe_to32(float fx, float fy, int img_w, int img_h, int row_w, float *rectf, int gamma_correct);
140
141
142 void glaDrawPixelsTex           (float x, float y, int img_w, int img_h, int format, void *rect);
143
144 void glaDrawPixelsTexScaled(float x, float y, int img_w, int img_h, int format, void *rect, float scaleX, float scaleY);
145
146         /* 2D Drawing Assistance */
147
148         /** Define a 2D area (viewport, scissor, matrices) for OpenGL rendering.
149          * This routine sets up an OpenGL state appropriate for drawing using
150          * both vertice (glVertex, etc) and raster (glRasterPos, glRect) commands.
151          * All coordinates should be at integer positions. There is little to
152          * no reason to use glVertex2f etc. functions during 2D rendering, and
153          * thus no reason to +-0.5 the coordinates or perform other silly
154          * tricks.
155          *
156          * @param screen_rect The screen rectangle to be defined for 2D drawing.
157          */
158 void glaDefine2DArea            (struct rcti *screen_rect);
159
160 typedef struct gla2DDrawInfo gla2DDrawInfo;
161
162         /** Save the current OpenGL state and initialize OpenGL for 2D
163          * rendering. glaEnd2DDraw should be called on the returned structure
164          * to free it and to return OpenGL to its previous state. The
165          * scissor rectangle is set to match the viewport.
166          *
167          * This routine sets up an OpenGL state appropriate for drawing using
168          * both vertice (glVertex, etc) and raster (glRasterPos, glRect) commands.
169          * All coordinates should be at integer positions. There is little to
170          * no reason to use glVertex2f etc. functions during 2D rendering, and
171          * thus no reason to +-0.5 the coordinates or perform other silly
172          * tricks.
173          *
174          * @param screen_rect The screen rectangle to be used for 2D drawing.
175          * @param world_rect The world rectangle that the 2D area represented
176          * by @a screen_rect is supposed to represent. If NULL it is assumed the
177          * world has a 1 to 1 mapping to the screen.
178          */
179 gla2DDrawInfo*  glaBegin2DDraw                  (struct rcti *screen_rect, struct rctf *world_rect);
180
181         /** Translate the (@a wo_x, @a wo_y) point from world coordinates into screen space. */
182 void                    gla2DDrawTranslatePt    (gla2DDrawInfo *di, float wo_x, float wo_y, int *sc_x_r, int *sc_y_r);
183
184         /** Translate the @a world point from world coordiantes into screen space. */
185 void                    gla2DDrawTranslatePtv   (gla2DDrawInfo *di, float world[2], int screen_r[2]);
186
187         /* Restores the previous OpenGL state and free's the auxilary
188          * gla data.
189          */
190 void                    glaEnd2DDraw                    (gla2DDrawInfo *di);
191
192         /** Adjust the transformation mapping of a 2d area */
193 void gla2DGetMap(gla2DDrawInfo *di, struct rctf *rect);
194 void gla2DSetMap(gla2DDrawInfo *di, struct rctf *rect);
195
196
197 /* use this for platform hacks. glPointSize is solved here */
198 void bglBegin(int mode);
199 void bglEnd(void);
200 int bglPointHack();
201 void bglVertex3fv(float *vec);
202 void bglVertex3f(float x, float y, float z);
203 void bglVertex2fv(float *vec);
204 /* intel gfx cards frontbuffer problem */
205 void bglFlush(void);
206 void set_inverted_drawing(int enable);
207 void setlinestyle(int nr);
208
209 /* own working polygon offset */
210 void bglPolygonOffset(float viewdist, float dist);
211
212 /* For caching opengl matrices (gluProject/gluUnProject) */
213 typedef struct bglMats {
214         double modelview[16];
215         double projection[16];
216         int viewport[4];
217 } bglMats;
218 void bgl_get_mats(bglMats *mats);
219
220 #endif /* BIF_GLUTIL_H */
221