Initial commit for new text object.
[blender.git] / source / blender / include / BIF_glutil.h
1 /**
2  * @file BIF_glutil.h
3  * 
4  * OpenGL drawing utility functions.
5  * 
6  * $Id$
7  *
8  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version. The Blender
14  * Foundation also sells licenses for use in proprietary software under
15  * the Blender License.  See http://www.blender.org/BL/ for information
16  * about this.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  *
27  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
28  * All rights reserved.
29  *
30  * The Original Code is: all of this file.
31  *
32  * Contributor(s): none yet.
33  *
34  * ***** END GPL/BL DUAL LICENSE BLOCK *****
35  */
36
37 #ifndef BIF_GLUTIL_H
38 #define BIF_GLUTIL_H
39
40 struct rcti;
41 struct rctf;
42
43 void sdrawXORline(int x0, int y0, int x1, int y1);
44 void sdrawXORline4(int nr, int x0, int y0, int x1, int y1);
45
46 void fdrawXORcirc(float xofs, float yofs, float rad);
47
48         /**
49          * Draw an XOR'd line in the front buffer between
50          * the given points. 
51          *
52          * @attention This function also handles flushing the GL
53          * pipeline, which means it is inappropriate for drawing
54          * a large number of lines at once.
55          */
56 void glutil_draw_front_xor_line(int x0, int y0, int x1, int y1);
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, 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 unsigned byte format, and the 
139          * modelview and projection matrices are assumed to define a 
140          * 1-to-1 mapping to screen space.
141          */
142 void glaDrawPixelsTex           (float x, float y, int img_w, int img_h, void *rect);
143
144         /* 2D Drawing Assistance */
145
146         /** Define a 2D area (viewport, scissor, matrices) for OpenGL rendering.
147          * This routine sets up an OpenGL state appropriate for drawing using
148          * both vertice (glVertex, etc) and raster (glRasterPos, glRect) commands.
149          * All coordinates should be at integer positions. There is little to
150          * no reason to use glVertex2f etc. functions during 2D rendering, and
151          * thus no reason to +-0.5 the coordinates or perform other silly
152          * tricks.
153          *
154          * @param screen_rect The screen rectangle to be defined for 2D drawing.
155          */
156 void glaDefine2DArea            (struct rcti *screen_rect);
157
158 typedef struct gla2DDrawInfo gla2DDrawInfo;
159
160         /** Save the current OpenGL state and initialize OpenGL for 2D
161          * rendering. glaEnd2DDraw should be called on the returned structure
162          * to free it and to return OpenGL to its previous state. The
163          * scissor rectangle is set to match the viewport.
164          *
165          * This routine sets up an OpenGL state appropriate for drawing using
166          * both vertice (glVertex, etc) and raster (glRasterPos, glRect) commands.
167          * All coordinates should be at integer positions. There is little to
168          * no reason to use glVertex2f etc. functions during 2D rendering, and
169          * thus no reason to +-0.5 the coordinates or perform other silly
170          * tricks.
171          *
172          * @param screen_rect The screen rectangle to be used for 2D drawing.
173          * @param world_rect The world rectangle that the 2D area represented
174          * by @a screen_rect is supposed to represent. If NULL it is assumed the
175          * world has a 1 to 1 mapping to the screen.
176          */
177 gla2DDrawInfo*  glaBegin2DDraw                  (struct rcti *screen_rect, struct rctf *world_rect);
178
179         /** Translate the (@a wo_x, @a wo_y) point from world coordinates into screen space. */
180 void                    gla2DDrawTranslatePt    (gla2DDrawInfo *di, float wo_x, float wo_y, int *sc_x_r, int *sc_y_r);
181
182         /** Translate the @a world point from world coordiantes into screen space. */
183 void                    gla2DDrawTranslatePtv   (gla2DDrawInfo *di, float world[2], int screen_r[2]);
184
185         /* Restores the previous OpenGL state and free's the auxilary
186          * gla data.
187          */
188 void                    glaEnd2DDraw                    (gla2DDrawInfo *di);
189
190 /* use this for platform hacks. for now glPointSize is solved here */
191 void bglBegin(int mode);
192 void bglEnd(void);
193 void bglVertex3fv(float *vec);
194 void bglVertex2fv(float *vec);
195
196 void set_inverted_drawing(int enable);
197
198
199 /* own working polygon offset */
200 void bglPolygonOffset(float dist);
201
202 #endif /* BIF_GLUTIL_H */
203