include/FTGL/FTPolyGlyph.h

0001 /*
0002  * FTGL - OpenGL font library
0003  *
0004  * Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz>
0005  * Copyright (c) 2008 Sam Hocevar <sam@hocevar.net>
0006  * Copyright (c) 2008 Sean Morrison <learner@brlcad.org>
0007  *
0008  * Permission is hereby granted, free of charge, to any person obtaining
0009  * a copy of this software and associated documentation files (the
0010  * "Software"), to deal in the Software without restriction, including
0011  * without limitation the rights to use, copy, modify, merge, publish,
0012  * distribute, sublicense, and/or sell copies of the Software, and to
0013  * permit persons to whom the Software is furnished to do so, subject to
0014  * the following conditions:
0015  *
0016  * The above copyright notice and this permission notice shall be
0017  * included in all copies or substantial portions of the Software.
0018  *
0019  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
0020  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0021  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
0022  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
0023  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
0024  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0025  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0026  */
0027
0028 #ifndef __ftgl__
0029 #   warning This header is deprecated. Please use <FTGL/ftgl.h> from now.
0030 #   include <FTGL/ftgl.h>
0031 #endif
0032
0033 #ifndef __FTPolygonGlyph__
0034 #define __FTPolygonGlyph__
0035
0036 #ifdef __cplusplus
0037
0038
0039 /**
0040  * FTPolygonGlyph is a specialisation of FTGlyph for creating tessellated
0041  * polygon glyphs.
0042  */
0043 class FTGL_EXPORT FTPolygonGlyph : public FTGlyph
0044 {
0045     public:
0046         /**
0047          * Constructor. Sets the Error to Invalid_Outline if the glyphs
0048          * isn't an outline.
0049          *
0050          * @param glyph The Freetype glyph to be processed
0051          * @param outset  The outset distance
0052          * @param useDisplayList Enable or disable the use of Display Lists
0053          *                       for this glyph
0054          *                       <code>true</code> turns ON display lists.
0055          *                       <code>false</code> turns OFF display lists.
0056          */
0057         FTPolygonGlyph(FT_GlyphSlot glyph, float outset, bool useDisplayList);
0058
0059         /**
0060          * Destructor
0061          */
0062         virtual ~FTPolygonGlyph();
0063
0064         /**
0065          * Render this glyph at the current pen position.
0066          *
0067          * @param pen  The current pen position.
0068          * @param renderMode  Render mode to display
0069          * @return  The advance distance for this glyph.
0070          */
0071         virtual const FTPoint& Render(const FTPoint& pen, int renderMode);
0072 };
0073
0074 #define FTPolyGlyph FTPolygonGlyph
0075
0076 #endif //__cplusplus
0077
0078 FTGL_BEGIN_C_DECLS
0079
0080 /**
0081  * Create a specialisation of FTGLglyph for creating tessellated
0082  * polygon glyphs.
0083  *
0084  * @param glyph The Freetype glyph to be processed
0085  * @param outset outset contour size
0086  * @param useDisplayList Enable or disable the use of Display Lists
0087  *                       for this glyph
0088  *                       <code>true</code> turns ON display lists.
0089  *                       <code>false</code> turns OFF display lists.
0090  * @return  An FTGLglyph* object.
0091  */
0092 FTGL_EXPORT FTGLglyph *ftglCreatePolygonGlyph(FT_GlyphSlot glyph, float outset,
0093                                               int useDisplayList);
0094
0095 FTGL_END_C_DECLS
0096
0097 #endif  //  __FTPolygonGlyph__
0098