modules/gui/skins2/src/file_bitmap.hpp

   1 /*****************************************************************************
   2  * file_bitmap.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef FILE_BITMAP_HPP
  26 #define FILE_BITMAP_HPP
  27
  28 #include "generic_bitmap.hpp"
  29 #include <string>
  30
  31
  32 /// Class for file bitmaps
  33 class FileBitmap: public GenericBitmap
  34 {
  35 public:
  36     /// Load a bitmap from a file. aColor is the transparency
  37     /// color, in the format 0xRRGGBB
  38     FileBitmap( intf_thread_t *pIntf, image_handler_t *pImageHandler,
  39                 string fileName, uint32_t aColor, int nbFrames = 1,
  40                 int fps = 0, int nbLoops = 0 );
  41
  42     virtual ~FileBitmap();
  43
  44     /// Get the width of the bitmap
  45     virtual int getWidth() const { return m_width; }
  46
  47     /// Get the heighth of the bitmap
  48     virtual int getHeight() const { return m_height; }
  49
  50     /// Get a linear buffer containing the image data.
  51     /// Each pixel is stored in 4 bytes in the order B,G,R,A
  52     virtual uint8_t *getData() const;
  53
  54 private:
  55     /// Size of the bitmap.
  56     int m_width, m_height;
  57     /// Buffer containing the image data.
  58     uint8_t *m_pData;
  59 };
  60
  61
  62 #endif