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