dfb02fa9c1b04873e7f0aedb740a3dd88c829a56
[blender-staging.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 struct ColorManagedViewSettings;
39 struct ColorManagedDisplaySettings;
40
41 void fdrawbezier(float vec[4][3]);
42 void fdrawline(float x1, float y1, float x2, float y2);
43 void fdrawbox(float x1, float y1, float x2, float y2);
44 void sdrawline(short x1, short y1, short x2, short y2);
45 void sdrawtri(short x1, short y1, short x2, short y2);
46 void sdrawtrifill(short x1, short y1, short x2, short y2);
47 void sdrawbox(short x1, short y1, short x2, short y2);
48
49 void sdrawXORline(int x0, int y0, int x1, int y1);
50 void sdrawXORline4(int nr, int x0, int y0, int x1, int y1);
51
52 void fdrawXORellipse(float xofs, float yofs, float hw, float hh);
53 void fdrawXORcirc(float xofs, float yofs, float rad);
54
55 void fdrawcheckerboard(float x1, float y1, float x2, float y2);
56
57 /* OpenGL stipple defines */
58 /* OpenGL stipple defines */
59 extern const unsigned char stipple_halftone[128];
60 extern const unsigned char stipple_quarttone[128];
61 extern const unsigned char stipple_diag_stripes_pos[128];
62 extern const unsigned char stipple_diag_stripes_neg[128];
63
64 /**
65  * Draw a lined (non-looping) arc with the given
66  * \a radius, starting at angle \a start and arcing
67  * through \a angle. The arc is centered at the origin
68  * and drawn in the XY plane.
69  *
70  * \param start The initial angle (in radians).
71  * \param angle The length of the arc (in radians).
72  * \param radius The arc radius.
73  * \param nsegments The number of segments to use in drawing the arc.
74  */
75 void glutil_draw_lined_arc(float start, float angle, float radius, int nsegments);
76
77 /**
78  * Draw a filled arc with the given \a radius,
79  * starting at angle \a start and arcing through
80  * \a angle. The arc is centered at the origin
81  * and drawn in the XY plane.
82  *
83  * \param start The initial angle (in radians).
84  * \param angle The length of the arc (in radians).
85  * \param radius The arc radius.
86  * \param nsegments The number of segments to use in drawing the arc.
87  */
88 void glutil_draw_filled_arc(float start, float angle, float radius, int nsegments);
89
90 /**
91  * Routines an integer value as obtained by glGetIntegerv.
92  * The param must cause only one value to be gotten from GL.
93  */
94 int glaGetOneInteger(int param);
95
96 /**
97  * Routines a float value as obtained by glGetIntegerv.
98  * The param must cause only one value to be gotten from GL.
99  */
100 float glaGetOneFloat(int param);
101
102 /**
103  * Functions like glRasterPos2i, except ensures that the resulting
104  * raster position is valid. \a known_good_x and \a known_good_y
105  * should be coordinates of a point known to be within the current
106  * view frustum.
107  * \attention This routine should be used when the distance of \a x
108  * and \a y away from the known good point is small (ie. for small icons
109  * and for bitmap characters), when drawing large+zoomed images it is
110  * possible for overflow to occur, the glaDrawPixelsSafe routine should
111  * be used instead.
112  */
113 void glaRasterPosSafe2f(float x, float y, float known_good_x, float known_good_y);
114
115 /**
116  * Functions like a limited glDrawPixels, except ensures that
117  * the image is displayed onscreen even if the \a x and \a y
118  * coordinates for would be clipped. The routine respects the
119  * glPixelZoom values, pixel unpacking parameters are _not_
120  * respected.
121  *
122  * \attention This routine makes many assumptions: the rect data
123  * is expected to be in RGBA unsigned byte format, the coordinate
124  * (GLA_PIXEL_OFS, GLA_PIXEL_OFS) is assumed to be within the view frustum,
125  * and the modelview and projection matrices are assumed to define a
126  * 1-to-1 mapping to screen space.
127  * \attention Furthermore, in the case of zoomed or unpixel aligned
128  * images extending outside the view frustum, but still within the
129  * window, some portion of the image may be visible left and/or
130  * below of the given \a x and \a y coordinates. It is recommended
131  * to use the glScissor functionality if images are to be drawn
132  * with an inset view matrix.
133  */
134 void glaDrawPixelsSafe(float x, float y, int img_w, int img_h, int row_w, int format, int type, void *rect);
135
136 /**
137  * glaDrawPixelsTex - Functions like a limited glDrawPixels, but actually draws the
138  * image using textures, which can be tremendously faster on low-end
139  * cards, and also avoids problems with the raster position being
140  * clipped when offscreen. The routine respects the glPixelZoom values,
141  * pixel unpacking parameters are _not_ respected.
142  *
143  * \attention This routine makes many assumptions: the rect data
144  * is expected to be in RGBA byte or float format, and the
145  * modelview and projection matrices are assumed to define a
146  * 1-to-1 mapping to screen space.
147  */
148
149 void glaDrawPixelsTex(float x, float y, int img_w, int img_h, int format, int type, int zoomfilter, void *rect);
150
151 /**
152  * glaDrawPixelsAuto - Switches between texture or pixel drawing using UserDef.
153  * only RGBA
154  * needs glaDefine2DArea to be set.
155  */
156 void glaDrawPixelsAuto(float x, float y, int img_w, int img_h, int format, int type, int zoomfilter, void *rect);
157
158
159 void glaDrawPixelsTexScaled(float x, float y, int img_w, int img_h, int format, int type, int zoomfilter, void *rect, float scaleX, float scaleY);
160
161 /* 2D Drawing Assistance */
162
163 /** Define a 2D area (viewport, scissor, matrices) for OpenGL rendering.
164  *
165  * glwDefine2DArea and glaBegin2DDraw set up an OpenGL state appropriate
166  * for drawing using both vertice (Vertex, etc) and raster (RasterPos, Rect)
167  * commands. All coordinates should be at integer positions. There is little
168  * to 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 defined for 2D drawing.
173  */
174 void glaDefine2DArea(struct rcti *screen_rect);
175
176 typedef struct gla2DDrawInfo gla2DDrawInfo;
177
178 /* UNUSED */
179 #if 0
180
181 gla2DDrawInfo  *glaBegin2DDraw(struct rcti *screen_rect, struct rctf *world_rect);
182 void gla2DDrawTranslatePt(gla2DDrawInfo *di, float wo_x, float wo_y, int *sc_x_r, int *sc_y_r);
183 void gla2DDrawTranslatePtv(gla2DDrawInfo *di, float world[2], int screen_r[2]);
184
185 void glaEnd2DDraw(gla2DDrawInfo *di);
186
187 /** Adjust the transformation mapping of a 2d area */
188 void gla2DGetMap(gla2DDrawInfo *di, struct rctf *rect);
189 void gla2DSetMap(gla2DDrawInfo *di, struct rctf *rect);
190 #endif
191
192 /* use this for platform hacks. glPointSize is solved here */
193 void bglBegin(int mode);
194 void bglEnd(void);
195 // int bglPointHack(void); /* UNUSED */
196 void bglVertex3fv(const float vec[3]);
197 void bglVertex3f(float x, float y, float z);
198 void bglVertex2fv(const float vec[2]);
199 /* intel gfx cards frontbuffer problem */
200 // void bglFlush(void); /* UNUSED */
201 void set_inverted_drawing(int enable);
202 void setlinestyle(int nr);
203
204 /* own working polygon offset */
205 void bglPolygonOffset(float viewdist, float dist);
206
207 /* For caching opengl matrices (gluProject/gluUnProject) */
208 typedef struct bglMats {
209         double modelview[16];
210         double projection[16];
211         int viewport[4];
212 } bglMats;
213 void bgl_get_mats(bglMats *mats);
214
215 /* **** Color management helper functions for GLSL display/transform ***** */
216
217 /* Draw imbuf on a screen, preferably using GLSL display transform */
218 void glaDrawImBuf_glsl(struct ImBuf *ibuf, float x, float y, int zoomfilter,
219                        struct ColorManagedViewSettings *view_settings,
220                        struct ColorManagedDisplaySettings *display_settings);
221
222 /* Draw imbuf on a screen, preferably using GLSL display transform */
223 void glaDrawImBuf_glsl_ctx(const struct bContext *C, struct ImBuf *ibuf, float x, float y, int zoomfilter);
224
225 /* Transform buffer from role to scene linear space using GLSL OCIO conversion */
226 int glaBufferTransformFromRole_glsl(float *buffer, int width, int height, int role);
227
228 #endif /* __BIF_GLUTIL_H__ */
229