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

Branch : - branch - master - tag -

• Show log

  Commit

• Author : sammy
  Date : 2009-07-19 13:05:50
  Hash : cab1fafd
  Message : Update my e-mail address everywhere.

• src/FTGL/FTBuffer.h

• /*
   * FTGL - OpenGL font library
   *
   * Copyright (c) 2008 Sam Hocevar <sam@hocevar.net>
   *
   * 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 Please use <FTGL/ftgl.h> instead of <FTBuffer.h>.
  #   include <FTGL/ftgl.h>
  #endif
  
  #ifndef __FTBuffer__
  #define __FTBuffer__
  
  #ifdef __cplusplus
  
  /**
   * FTBuffer is a helper class for pixel buffers.
   *
   * It provides the interface between FTBufferFont and FTBufferGlyph to
   * optimise rendering operations.
   *
   * @see FTBufferGlyph
   * @see FTBufferFont
   */
  class FTGL_EXPORT FTBuffer
  {
      public:
          /**
           * Default constructor.
           */
          FTBuffer();
  
          /**
           * Destructor
           */
          ~FTBuffer();
  
          /**
           * Get the pen's position in the buffer.
           *
           * @return  The pen's position as an FTPoint object.
           */
          inline FTPoint Pos() const
          {
              return pos;
          }
  
          /**
           * Set the pen's position in the buffer.
           *
           * @param arg  An FTPoint object with the desired pen's position.
           */
          inline void Pos(FTPoint arg)
          {
              pos = arg;
          }
  
          /**
           * Set the buffer's size.
           *
           * @param w  The buffer's desired width, in pixels.
           * @param h  The buffer's desired height, in pixels.
           */
          void Size(int w, int h);
  
          /**
           * Get the buffer's width.
           *
           * @return  The buffer's width, in pixels.
           */
          inline int Width() const { return width; }
  
          /**
           * Get the buffer's height.
           *
           * @return  The buffer's height, in pixels.
           */
          inline int Height() const { return height; }
  
          /**
           * Get the buffer's direct pixel buffer.
           *
           * @return  A read-write pointer to the buffer's pixels.
           */
          inline unsigned char *Pixels() const { return pixels; }
  
      private:
          /**
           * Buffer's width and height.
           */
          int width, height;
  
          /**
           * Buffer's pixel buffer.
           */
          unsigned char *pixels;
  
          /**
           * Buffer's internal pen position.
           */
          FTPoint pos;
  };
  
  #endif //__cplusplus
  
  #endif // __FTBuffer__