include/FTGL/FTBufferGlyph.h

0001 /*
0002  * FTGL - OpenGL font library
0003  *
0004  * Copyright (c) 2008 Sam Hocevar <sam@hocevar.net>
0005  *
0006  * Permission is hereby granted, free of charge, to any person obtaining
0007  * a copy of this software and associated documentation files (the
0008  * "Software"), to deal in the Software without restriction, including
0009  * without limitation the rights to use, copy, modify, merge, publish,
0010  * distribute, sublicense, and/or sell copies of the Software, and to
0011  * permit persons to whom the Software is furnished to do so, subject to
0012  * the following conditions:
0013  *
0014  * The above copyright notice and this permission notice shall be
0015  * included in all copies or substantial portions of the Software.
0016  *
0017  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
0018  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
0020  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
0021  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
0022  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0023  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0024  */
0025
0026 #ifndef __ftgl__
0027 #   warning Please use <FTGL/ftgl.h> instead of <FTBufferGlyph.h>.
0028 #   include <FTGL/ftgl.h>
0029 #endif
0030
0031 #ifndef __FTBufferGlyph__
0032 #define __FTBufferGlyph__
0033
0034 #ifdef __cplusplus
0035
0036
0037 /**
0038  * FTBufferGlyph is a specialisation of FTGlyph for memory buffer rendering.
0039  */
0040 class FTGL_EXPORT FTBufferGlyph : public FTGlyph
0041 {
0042     public:
0043         /**
0044          * Constructor
0045          *
0046          * @param glyph The Freetype glyph to be processed
0047          * @param buffer  An FTBuffer object in which to render the glyph.
0048          */
0049         FTBufferGlyph(FT_GlyphSlot glyph, FTBuffer *buffer);
0050
0051         /**
0052          * Destructor
0053          */
0054         virtual ~FTBufferGlyph();
0055
0056         /**
0057          * Render this glyph at the current pen position.
0058          *
0059          * @param pen  The current pen position.
0060          * @param renderMode  Render mode to display
0061          * @return  The advance distance for this glyph.
0062          */
0063         virtual const FTPoint& Render(const FTPoint& pen, int renderMode);
0064 };
0065
0066 #endif //__cplusplus
0067
0068 #endif  //  __FTBufferGlyph__
0069