1 /*
2  * GL2PS, an OpenGL to PostScript Printing Library
3  * Copyright (C) 1999-2020 C. Geuzaine
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of either:
7  *
8  * a) the GNU Library General Public License as published by the Free
9  * Software Foundation, either version 2 of the License, or (at your
10  * option) any later version; or
11  *
12  * b) the GL2PS License as published by Christophe Geuzaine, either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either
18  * the GNU Library General Public License or the GL2PS License for
19  * more details.
20  *
21  * You should have received a copy of the GNU Library General Public
22  * License along with this library in the file named "COPYING.LGPL";
23  * if not, write to the Free Software Foundation, Inc., 51 Franklin
24  * Street, Fifth Floor, Boston, MA 02110-1301, USA.
25  *
26  * You should have received a copy of the GL2PS License with this
27  * library in the file named "COPYING.GL2PS"; if not, I will be glad
28  * to provide one.
29  *
30  * For the latest info about gl2ps and a full list of contributors,
31  * see http://www.geuz.org/gl2ps/.
32  *
33  * Please report all bugs and problems to <gl2ps@geuz.org>.
34  */
35 
36 #ifndef GL2PS_H
37 #define GL2PS_H
38 
39 #include <stdio.h>
40 #include <stdlib.h>
41 
42 /* Define GL2PSDLL at compile time to build a Windows DLL */
43 
44 #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
45 #  if defined(_MSC_VER)
46 #    pragma warning(disable:4115)
47 #    pragma warning(disable:4127)
48 #    pragma warning(disable:4996)
49 #  endif
50 #  if !defined(NOMINMAX)
51 #    define NOMINMAX
52 #  endif
53 #  include <windows.h>
54 #  undef NOMINMAX
55 #  if defined(GL2PSDLL)
56 #    if defined(GL2PSDLL_EXPORTS)
57 #      define GL2PSDLL_API __declspec(dllexport)
58 #    else
59 #      define GL2PSDLL_API __declspec(dllimport)
60 #    endif
61 #  else
62 #    define GL2PSDLL_API
63 #  endif
64 #else
65 #  define GL2PSDLL_API
66 #endif
67 
68 #if defined(__APPLE__) || defined(HAVE_OPENGL_GL_H)
69 #  include <OpenGL/gl.h>
70 #else
71 #  include <GL/gl.h>
72 #endif
73 
74 /* Support for compressed PostScript/PDF/SVG and for embedded PNG
75    images in SVG */
76 
77 #if defined(HAVE_ZLIB) || defined(HAVE_LIBZ)
78 #  define GL2PS_HAVE_ZLIB
79 #  if defined(HAVE_LIBPNG) || defined(HAVE_PNG)
80 #    define GL2PS_HAVE_LIBPNG
81 #  endif
82 #endif
83 
84 #if defined(HAVE_NO_VSNPRINTF)
85 #  define GL2PS_HAVE_NO_VSNPRINTF
86 #endif
87 
88 /* Version number */
89 
90 #define GL2PS_MAJOR_VERSION 1
91 #define GL2PS_MINOR_VERSION 4
92 #define GL2PS_PATCH_VERSION 2
93 #define GL2PS_EXTRA_VERSION ""
94 
95 #define GL2PS_VERSION (GL2PS_MAJOR_VERSION + \
96                        0.01 * GL2PS_MINOR_VERSION + \
97                        0.0001 * GL2PS_PATCH_VERSION)
98 
99 #define GL2PS_COPYRIGHT "(C) 1999-2020 C. Geuzaine"
100 
101 /* Output file formats (the values and the ordering are important!) */
102 
103 #define GL2PS_PS  0
104 #define GL2PS_EPS 1
105 #define GL2PS_TEX 2
106 #define GL2PS_PDF 3
107 #define GL2PS_SVG 4
108 #define GL2PS_PGF 5
109 
110 /* Sorting algorithms */
111 
112 #define GL2PS_NO_SORT     1
113 #define GL2PS_SIMPLE_SORT 2
114 #define GL2PS_BSP_SORT    3
115 
116 /* Message levels and error codes */
117 
118 #define GL2PS_SUCCESS       0
119 #define GL2PS_INFO          1
120 #define GL2PS_WARNING       2
121 #define GL2PS_ERROR         3
122 #define GL2PS_NO_FEEDBACK   4
123 #define GL2PS_OVERFLOW      5
124 #define GL2PS_UNINITIALIZED 6
125 
126 /* Options for gl2psBeginPage */
127 
128 #define GL2PS_NONE                 0
129 #define GL2PS_DRAW_BACKGROUND      (1<<0)
130 #define GL2PS_SIMPLE_LINE_OFFSET   (1<<1)
131 #define GL2PS_SILENT               (1<<2)
132 #define GL2PS_BEST_ROOT            (1<<3)
133 #define GL2PS_OCCLUSION_CULL       (1<<4)
134 #define GL2PS_NO_TEXT              (1<<5)
135 #define GL2PS_LANDSCAPE            (1<<6)
136 #define GL2PS_NO_PS3_SHADING       (1<<7)
137 #define GL2PS_NO_PIXMAP            (1<<8)
138 #define GL2PS_USE_CURRENT_VIEWPORT (1<<9)
139 #define GL2PS_COMPRESS             (1<<10)
140 #define GL2PS_NO_BLENDING          (1<<11)
141 #define GL2PS_TIGHT_BOUNDING_BOX   (1<<12)
142 #define GL2PS_NO_OPENGL_CONTEXT    (1<<13)
143 #define GL2PS_NO_TEX_FONTSIZE      (1<<14)
144 
145 /* Arguments for gl2psEnable/gl2psDisable */
146 
147 #define GL2PS_POLYGON_OFFSET_FILL 1
148 #define GL2PS_POLYGON_BOUNDARY    2
149 #define GL2PS_LINE_STIPPLE        3
150 #define GL2PS_BLEND               4
151 
152 /* Arguments for gl2psLineCap/Join */
153 
154 #define GL2PS_LINE_CAP_BUTT       0
155 #define GL2PS_LINE_CAP_ROUND      1
156 #define GL2PS_LINE_CAP_SQUARE     2
157 
158 #define GL2PS_LINE_JOIN_MITER     0
159 #define GL2PS_LINE_JOIN_ROUND     1
160 #define GL2PS_LINE_JOIN_BEVEL     2
161 
162 /* Text alignment (o=raster position; default mode is BL):
163    +---+ +---+ +---+ +---+ +---+ +---+ +-o-+ o---+ +---o
164    | o | o   | |   o |   | |   | |   | |   | |   | |   |
165    +---+ +---+ +---+ +-o-+ o---+ +---o +---+ +---+ +---+
166     C     CL    CR    B     BL    BR    T     TL    TR */
167 
168 #define GL2PS_TEXT_C  1
169 #define GL2PS_TEXT_CL 2
170 #define GL2PS_TEXT_CR 3
171 #define GL2PS_TEXT_B  4
172 #define GL2PS_TEXT_BL 5
173 #define GL2PS_TEXT_BR 6
174 #define GL2PS_TEXT_T  7
175 #define GL2PS_TEXT_TL 8
176 #define GL2PS_TEXT_TR 9
177 
178 typedef GLfloat GL2PSrgba[4];
179 typedef GLfloat GL2PSxyz[3];
180 
181 typedef struct {
182   GL2PSxyz xyz;
183   GL2PSrgba rgba;
184 } GL2PSvertex;
185 
186 /* Primitive types */
187 #define GL2PS_NO_TYPE          -1
188 #define GL2PS_TEXT             1
189 #define GL2PS_POINT            2
190 #define GL2PS_LINE             3
191 #define GL2PS_QUADRANGLE       4
192 #define GL2PS_TRIANGLE         5
193 #define GL2PS_PIXMAP           6
194 #define GL2PS_IMAGEMAP         7
195 #define GL2PS_IMAGEMAP_WRITTEN 8
196 #define GL2PS_IMAGEMAP_VISIBLE 9
197 #define GL2PS_SPECIAL          10
198 
199 #if defined(__cplusplus)
200 extern "C" {
201 #endif
202 
203 GL2PSDLL_API GLint gl2psBeginPage(const char *title, const char *producer,
204                                   GLint viewport[4], GLint format, GLint sort,
205                                   GLint options, GLint colormode,
206                                   GLint colorsize, GL2PSrgba *colormap,
207                                   GLint nr, GLint ng, GLint nb, GLint buffersize,
208                                   FILE *stream, const char *filename);
209 GL2PSDLL_API GLint gl2psEndPage(void);
210 GL2PSDLL_API GLint gl2psSetOptions(GLint options);
211 GL2PSDLL_API GLint gl2psGetOptions(GLint *options);
212 GL2PSDLL_API GLint gl2psBeginViewport(GLint viewport[4]);
213 GL2PSDLL_API GLint gl2psEndViewport(void);
214 GL2PSDLL_API GLint gl2psText(const char *str, const char *fontname,
215                              GLshort fontsize);
216 GL2PSDLL_API GLint gl2psTextOpt(const char *str, const char *fontname,
217                                 GLshort fontsize, GLint align, GLfloat angle);
218 GL2PSDLL_API GLint gl2psTextOptColor(const char *str, const char *fontname,
219                                      GLshort fontsize, GLint align, GLfloat angle,
220                                      GL2PSrgba color);
221 GL2PSDLL_API GLint gl2psTextOptColorBL(const char *str, const char *fontname,
222                                        GLshort fontsize, GLint align, GLfloat angle,
223                                        GL2PSrgba color, GLfloat blx, GLfloat bly);
224 GL2PSDLL_API GLint gl2psSpecial(GLint format, const char *str);
225 GL2PSDLL_API GLint gl2psSpecialColor(GLint format, const char *str, GL2PSrgba rgba);
226 GL2PSDLL_API GLint gl2psDrawPixels(GLsizei width, GLsizei height,
227                                    GLint xorig, GLint yorig,
228                                    GLenum format, GLenum type, const void *pixels);
229 GL2PSDLL_API GLint gl2psEnable(GLint mode);
230 GL2PSDLL_API GLint gl2psDisable(GLint mode);
231 GL2PSDLL_API GLint gl2psPointSize(GLfloat value);
232 GL2PSDLL_API GLint gl2psLineCap(GLint value);
233 GL2PSDLL_API GLint gl2psLineJoin(GLint value);
234 GL2PSDLL_API GLint gl2psLineWidth(GLfloat value);
235 GL2PSDLL_API GLint gl2psBlendFunc(GLenum sfactor, GLenum dfactor);
236 GL2PSDLL_API GLint gl2psSorting(GLint mode);
237 
238 /* referenced in the documentation, but not fully documented */
239 GL2PSDLL_API GLint gl2psForceRasterPos(GL2PSvertex *vert);
240 GL2PSDLL_API void gl2psAddPolyPrimitive(GLshort type, GLshort numverts,
241                                         GL2PSvertex *verts, GLint offset,
242                                         GLfloat ofactor, GLfloat ounits,
243                                         GLushort pattern, GLint factor,
244                                         GLfloat width, GLint linecap,
245                                         GLint linejoin, char boundary);
246 
247 /* undocumented */
248 GL2PSDLL_API GLint gl2psDrawImageMap(GLsizei width, GLsizei height,
249                                      const GLfloat position[3],
250                                      const unsigned char *imagemap);
251 GL2PSDLL_API const char *gl2psGetFileExtension(GLint format);
252 GL2PSDLL_API const char *gl2psGetFormatDescription(GLint format);
253 GL2PSDLL_API GLint gl2psGetFileFormat();
254 GL2PSDLL_API GLint gl2psSetTexScaling(GLfloat scaling);
255 
256 #if defined(__cplusplus)
257 }
258 #endif
259 
260 #endif
261