include/FTGL/FTTextureGlyph.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 __FTTextureGlyph__
0034 #define __FTTextureGlyph__
0035
0036 #ifdef __cplusplus
0037
0038
0039 /**
0040  * FTTextureGlyph is a specialisation of FTGlyph for creating texture
0041  * glyphs.
0042  */
0043 class FTGL_EXPORT FTTextureGlyph : public FTGlyph
0044 {
0045     public:
0046         /**
0047          * Constructor
0048          *
0049          * @param glyph     The Freetype glyph to be processed
0050          * @param id        The id of the texture that this glyph will be
0051          *                  drawn in
0052          * @param xOffset   The x offset into the parent texture to draw
0053          *                  this glyph
0054          * @param yOffset   The y offset into the parent texture to draw
0055          *                  this glyph
0056          * @param width     The width of the parent texture
0057          * @param height    The height (number of rows) of the parent texture
0058          */
0059         FTTextureGlyph(FT_GlyphSlot glyph, int id, int xOffset, int yOffset,
0060                        int width, int height);
0061
0062         /**
0063          * Destructor
0064          */
0065         virtual ~FTTextureGlyph();
0066
0067         /**
0068          * Render this glyph at the current pen position.
0069          *
0070          * @param pen  The current pen position.
0071          * @param renderMode  Render mode to display
0072          * @return  The advance distance for this glyph.
0073          */
0074         virtual const FTPoint& Render(const FTPoint& pen, int renderMode);
0075 };
0076
0077 #endif //__cplusplus
0078
0079 FTGL_BEGIN_C_DECLS
0080
0081 /**
0082  * Create a specialisation of FTGLglyph for creating pixmaps.
0083  *
0084  * @param glyph The Freetype glyph to be processed.
0085  * @param id  The id of the texture that this glyph will be drawn in.
0086  * @param xOffset  The x offset into the parent texture to draw this glyph.
0087  * @param yOffset  The y offset into the parent texture to draw this glyph.
0088  * @param width  The width of the parent texture.
0089  * @param height  The height (number of rows) of the parent texture.
0090  * @return  An FTGLglyph* object.
0091  */
0092 FTGL_EXPORT FTGLglyph *ftglCreateTextureGlyph(FT_GlyphSlot glyph, int id,
0093                                               int xOffset, int yOffset,
0094                                               int width, int height);
0095
0096 FTGL_END_C_DECLS
0097
0098 #endif  //  __FTTextureGlyph__
0099