src/Utils/MiscUI/DIB.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2008 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 /**
  22  * \ingroup Utils
  23  *
  24  * A wrapper class for DIB's. It provides only a very small
  25  * amount of methods (just the ones I need). Especially for
  26  * creating 32bit 'image fields' which can be used for
  27  * implementing image filters.
  28  */
  29 class CDib : public CObject
  30 {
  31 public:
  32         CDib();
  33         virtual ~CDib();
  34
  35         /**
  36          * Clears all member variables and frees allocated memory.
  37          */
  38         void            DeleteObject();
  39         /**
  40          * Gets the number of bytes per horizontal line in the image.
  41          * \param nWidth the width of the image
  42          * \param nBitsPerPixel number of bits per pixel (color depth)
  43          */
  44         static int      BytesPerLine(int nWidth, int nBitsPerPixel);
  45         /**
  46          * Returns the height of the image in pixels
  47          */
  48         int                     GetHeight() const { return m_BMinfo.bmiHeader.biHeight; }
  49         /**
  50          * Returns the width of the image in pixels
  51          */
  52         int                     GetWidth() const { return m_BMinfo.bmiHeader.biWidth; }
  53         /**
  54          * Returns the size of the image in pixels
  55          */
  56         CSize           GetSize() const { return CSize(GetWidth(), GetHeight()); }
  57         /**
  58          * Returns the image byte field which can be used to work on.
  59          */
  60         LPVOID          GetDIBits() { return m_pBits; }
  61         /**
  62          * Creates a DIB from a CPictureHolder object with the specified width and height.
  63          * \param pPicture the CPictureHolder object
  64          * \param iWidth the width of the resulting picture
  65          * \param iHeight the height of the resulting picture
  66          */
  67         void            Create32BitFromPicture (CPictureHolder* pPicture, int iWidth, int iHeight);
  68
  69         /**
  70          * Returns a 32-bit RGB color
  71          */
  72         static COLORREF FixColorRef             (COLORREF clr);
  73         /**
  74          * Sets the created Bitmap-image (from Create32BitFromPicture) to the internal
  75          * member variables and fills in all required values for this class.
  76          * \param lpBitmapInfo a pointer to a BITMAPINFO structure
  77          * \param lpBits pointer to the image byte field
  78          */
  79         BOOL            SetBitmap(const LPBITMAPINFO lpBitmapInfo, const LPVOID lpBits);
  80
  81 public:
  82         /**
  83          * Draws the image on the specified device context at the specified point.
  84          * No stretching is done!
  85          * \param pDC the device context to draw on
  86          * \param ptDest the upper left corner to where the picture should be drawn to
  87          */
  88         BOOL            Draw(CDC* pDC, CPoint ptDest);
  89
  90 protected:
  91         HBITMAP         m_hBitmap;
  92         BITMAPINFO  m_BMinfo;
  93         VOID            *m_pBits;
  94 };
  95