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