SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
gl2ps.h
Go to the documentation of this file.
1 /*
2  * GL2PS, an OpenGL to PostScript Printing Library
3  * Copyright (C) 1999-2012 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:4996)
48 # endif
49 # define NOMINMAX
50 # include <windows.h>
51 # undef NOMINMAX
52 # if defined(GL2PSDLL)
53 # if defined(GL2PSDLL_EXPORTS)
54 # define GL2PSDLL_API __declspec(dllexport)
55 # else
56 # define GL2PSDLL_API __declspec(dllimport)
57 # endif
58 # else
59 # define GL2PSDLL_API
60 # endif
61 #else
62 # define GL2PSDLL_API
63 #endif
64 
65 #if defined(__APPLE__) || defined(HAVE_OPENGL_GL_H)
66 # include <OpenGL/gl.h>
67 #else
68 # include <GL/gl.h>
69 #endif
70 
71 /* Support for compressed PostScript/PDF/SVG and for embedded PNG
72  images in SVG */
73 
74 #if defined(HAVE_ZLIB) || defined(HAVE_LIBZ)
75 # define GL2PS_HAVE_ZLIB
76 # if defined(HAVE_LIBPNG) || defined(HAVE_PNG)
77 # define GL2PS_HAVE_LIBPNG
78 # endif
79 #endif
80 
81 #if defined(HAVE_NO_VSNPRINTF)
82 # define GL2PS_HAVE_NO_VSNPRINTF
83 #endif
84 
85 /* Version number */
86 
87 #define GL2PS_MAJOR_VERSION 1
88 #define GL2PS_MINOR_VERSION 3
89 #define GL2PS_PATCH_VERSION 8
90 #define GL2PS_EXTRA_VERSION ""
91 
92 #define GL2PS_VERSION (GL2PS_MAJOR_VERSION + \
93  0.01 * GL2PS_MINOR_VERSION + \
94  0.0001 * GL2PS_PATCH_VERSION)
95 
96 #define GL2PS_COPYRIGHT "(C) 1999-2012 C. Geuzaine"
97 
98 /* Output file formats (the values and the ordering are important!) */
99 
100 #define GL2PS_PS 0
101 #define GL2PS_EPS 1
102 #define GL2PS_TEX 2
103 #define GL2PS_PDF 3
104 #define GL2PS_SVG 4
105 #define GL2PS_PGF 5
106 
107 /* Sorting algorithms */
108 
109 #define GL2PS_NO_SORT 1
110 #define GL2PS_SIMPLE_SORT 2
111 #define GL2PS_BSP_SORT 3
112 
113 /* Message levels and error codes */
114 
115 #define GL2PS_SUCCESS 0
116 #define GL2PS_INFO 1
117 #define GL2PS_WARNING 2
118 #define GL2PS_ERROR 3
119 #define GL2PS_NO_FEEDBACK 4
120 #define GL2PS_OVERFLOW 5
121 #define GL2PS_UNINITIALIZED 6
122 
123 /* Options for gl2psBeginPage */
124 
125 #define GL2PS_NONE 0
126 #define GL2PS_DRAW_BACKGROUND (1<<0)
127 #define GL2PS_SIMPLE_LINE_OFFSET (1<<1)
128 #define GL2PS_SILENT (1<<2)
129 #define GL2PS_BEST_ROOT (1<<3)
130 #define GL2PS_OCCLUSION_CULL (1<<4)
131 #define GL2PS_NO_TEXT (1<<5)
132 #define GL2PS_LANDSCAPE (1<<6)
133 #define GL2PS_NO_PS3_SHADING (1<<7)
134 #define GL2PS_NO_PIXMAP (1<<8)
135 #define GL2PS_USE_CURRENT_VIEWPORT (1<<9)
136 #define GL2PS_COMPRESS (1<<10)
137 #define GL2PS_NO_BLENDING (1<<11)
138 #define GL2PS_TIGHT_BOUNDING_BOX (1<<12)
139 
140 /* Arguments for gl2psEnable/gl2psDisable */
141 
142 #define GL2PS_POLYGON_OFFSET_FILL 1
143 #define GL2PS_POLYGON_BOUNDARY 2
144 #define GL2PS_LINE_STIPPLE 3
145 #define GL2PS_BLEND 4
146 
147 /* Text alignment (o=raster position; default mode is BL):
148  +---+ +---+ +---+ +---+ +---+ +---+ +-o-+ o---+ +---o
149  | o | o | | o | | | | | | | | | | | |
150  +---+ +---+ +---+ +-o-+ o---+ +---o +---+ +---+ +---+
151  C CL CR B BL BR T TL TR */
152 
153 #define GL2PS_TEXT_C 1
154 #define GL2PS_TEXT_CL 2
155 #define GL2PS_TEXT_CR 3
156 #define GL2PS_TEXT_B 4
157 #define GL2PS_TEXT_BL 5
158 #define GL2PS_TEXT_BR 6
159 #define GL2PS_TEXT_T 7
160 #define GL2PS_TEXT_TL 8
161 #define GL2PS_TEXT_TR 9
162 
163 typedef GLfloat GL2PSrgba[4];
164 
165 #if defined(__cplusplus)
166 extern "C" {
167 #endif
168 
169 GL2PSDLL_API GLint gl2psBeginPage(const char *title, const char *producer,
170  GLint viewport[4], GLint format, GLint sort,
171  GLint options, GLint colormode,
172  GLint colorsize, GL2PSrgba *colormap,
173  GLint nr, GLint ng, GLint nb, GLint buffersize,
174  FILE *stream, const char *filename);
175 GL2PSDLL_API GLint gl2psEndPage(void);
176 GL2PSDLL_API GLint gl2psSetOptions(GLint options);
177 GL2PSDLL_API GLint gl2psGetOptions(GLint *options);
178 GL2PSDLL_API GLint gl2psBeginViewport(GLint viewport[4]);
179 GL2PSDLL_API GLint gl2psEndViewport(void);
180 GL2PSDLL_API GLint gl2psText(const char *str, const char *fontname,
181  GLshort fontsize);
182 GL2PSDLL_API GLint gl2psTextOpt(const char *str, const char *fontname,
183  GLshort fontsize, GLint align, GLfloat angle);
184 GL2PSDLL_API GLint gl2psTextOptColor(const char *str, const char *fontname,
185  GLshort fontsize, GLint align, GLfloat angle,
186  GL2PSrgba color);
187 GL2PSDLL_API GLint gl2psSpecial(GLint format, const char *str);
188 GL2PSDLL_API GLint gl2psDrawPixels(GLsizei width, GLsizei height,
189  GLint xorig, GLint yorig,
190  GLenum format, GLenum type, const void *pixels);
191 GL2PSDLL_API GLint gl2psEnable(GLint mode);
192 GL2PSDLL_API GLint gl2psDisable(GLint mode);
193 GL2PSDLL_API GLint gl2psPointSize(GLfloat value);
194 GL2PSDLL_API GLint gl2psLineWidth(GLfloat value);
195 GL2PSDLL_API GLint gl2psBlendFunc(GLenum sfactor, GLenum dfactor);
196 
197 /* undocumented */
198 GL2PSDLL_API GLint gl2psDrawImageMap(GLsizei width, GLsizei height,
199  const GLfloat position[3],
200  const unsigned char *imagemap);
201 GL2PSDLL_API const char *gl2psGetFileExtension(GLint format);
202 GL2PSDLL_API const char *gl2psGetFormatDescription(GLint format);
204 
205 #if defined(__cplusplus)
206 }
207 #endif
208 
209 #endif /* __GL2PS_H__ */
GL2PSDLL_API GLint gl2psDrawPixels(GLsizei width, GLsizei height, GLint xorig, GLint yorig, GLenum format, GLenum type, const void *pixels)
Definition: gl2ps.c:5892
GL2PSDLL_API GLint gl2psBeginPage(const char *title, const char *producer, GLint viewport[4], GLint format, GLint sort, GLint options, GLint colormode, GLint colorsize, GL2PSrgba *colormap, GLint nr, GLint ng, GLint nb, GLint buffersize, FILE *stream, const char *filename)
Definition: gl2ps.c:5650
GLfloat GL2PSrgba[4]
Definition: gl2ps.h:163
GL2PSDLL_API GLint gl2psBeginViewport(GLint viewport[4])
Definition: gl2ps.c:5844
GL2PSDLL_API GLint gl2psText(const char *str, const char *fontname, GLshort fontsize)
Definition: gl2ps.c:5881
GL2PSDLL_API GLint gl2psBlendFunc(GLenum sfactor, GLenum dfactor)
Definition: gl2ps.c:6081
GL2PSDLL_API GLint gl2psTextOptColor(const char *str, const char *fontname, GLshort fontsize, GLint align, GLfloat angle, GL2PSrgba color)
Definition: gl2ps.c:5867
GL2PSDLL_API GLint gl2psGetOptions(GLint *options)
Definition: gl2ps.c:6105
GL2PSDLL_API GLint gl2psEndViewport(void)
Definition: gl2ps.c:5853
GL2PSDLL_API const char * gl2psGetFileExtension(GLint format)
Definition: gl2ps.c:6117
GL2PSDLL_API GLint gl2psDisable(GLint mode)
Definition: gl2ps.c:6036
GL2PSDLL_API GLint gl2psSetOptions(GLint options)
Definition: gl2ps.c:6096
GL2PSDLL_API GLint gl2psEndPage(void)
Definition: gl2ps.c:5817
GL2PSDLL_API GLint gl2psTextOpt(const char *str, const char *fontname, GLshort fontsize, GLint align, GLfloat angle)
Definition: gl2ps.c:5875
GL2PSDLL_API GLint gl2psPointSize(GLfloat value)
Definition: gl2ps.c:6061
GL2PSDLL_API const char * gl2psGetFormatDescription(GLint format)
Definition: gl2ps.c:6125
GL2PSDLL_API GLint gl2psLineWidth(GLfloat value)
Definition: gl2ps.c:6071
GL2PSDLL_API GLint gl2psGetFileFormat()
Definition: gl2ps.c:6133
#define GL2PSDLL_API
Definition: gl2ps.h:62
GL2PSDLL_API GLint gl2psDrawImageMap(GLsizei width, GLsizei height, const GLfloat position[3], const unsigned char *imagemap)
Definition: gl2ps.c:5978
GL2PSDLL_API GLint gl2psSpecial(GLint format, const char *str)
Definition: gl2ps.c:5887
GL2PSDLL_API GLint gl2psEnable(GLint mode)
Definition: gl2ps.c:6003