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