Edit

kc3-lang/ftgl/src/FTGL/FTGLPixmapFont.h

Branch :

  • Show log

    Commit

  • Author : sammy
    Date : 2008-04-30 16:27:34
    Hash : 2aa2aeb5
    Message : * Move include/* to src/FTGL/* so the files in there can directly be referred to as "FTGL/*.h". This is convenient because they will be installed in a similar location. * Put a warning in each legacy public header to advise users to only include the generic <FTGL/ftgl.h> header instead.

  • src/FTGL/FTGLPixmapFont.h
  • /*
     * FTGL - OpenGL font library
     *
     * Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz>
     *
     * Permission is hereby granted, free of charge, to any person obtaining
     * a copy of this software and associated documentation files (the
     * "Software"), to deal in the Software without restriction, including
     * without limitation the rights to use, copy, modify, merge, publish,
     * distribute, sublicense, and/or sell copies of the Software, and to
     * permit persons to whom the Software is furnished to do so, subject to
     * the following conditions:
     *
     * The above copyright notice and this permission notice shall be
     * included in all copies or substantial portions of the Software.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
     * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
     * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
     * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
     * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     */
    
    #ifndef __ftgl__
    #   warning This header is deprecated. Please use <FTGL/ftgl.h> from now.
    #   include <FTGL/ftgl.h>
    #endif
    
    #ifndef __FTGLPixmapFont__
    #define __FTGLPixmapFont__
    
    #ifdef __cplusplus
    
    
    /**
     * FTGLPixmapFont is a specialisation of the FTFont class for handling
     * Pixmap (Grey Scale) fonts
     *
     * @see     FTFont
     */
    class FTGL_EXPORT FTGLPixmapFont : public FTFont
    {
        public:
            /**
             * Open and read a font file. Sets Error flag.
             *
             * @param fontFilePath  font file path.
             */
            FTGLPixmapFont(const char* fontFilePath);
    
            /**
             * Open and read a font from a buffer in memory. Sets Error flag.
             * The buffer is owned by the client and is NOT copied by FTGL. The
             * pointer must be valid while using FTGL.
             *
             * @param pBufferBytes  the in-memory buffer
             * @param bufferSizeInBytes  the length of the buffer in bytes
             */
            FTGLPixmapFont(const unsigned char *pBufferBytes,
                           size_t bufferSizeInBytes);
    
            /**
             * Destructor
             */
            ~FTGLPixmapFont();
    };
    
    #endif // __cplusplus
    
    FTGL_BEGIN_C_DECLS
        FTGL_EXPORT FTGLfont *ftglCreatePixmapFont(const char *fontname);
    FTGL_END_C_DECLS
    
    #endif  //  __FTGLPixmapFont__