src/msw/bitmap.cpp

   1 ////////////////////////////////////////////////////////////////////////////
   2 // Name:        bitmap.cpp
   3 // Purpose:     wxBitmap
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "bitmap.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include <stdio.h>
  33
  34     #include "wx/list.h"
  35     #include "wx/utils.h"
  36     #include "wx/app.h"
  37     #include "wx/palette.h"
  38     #include "wx/dcmemory.h"
  39     #include "wx/bitmap.h"
  40     #include "wx/icon.h"
  41 #endif
  42
  43 #include "wx/msw/private.h"
  44 #include "wx/log.h"
  45
  46 #if wxUSE_WXDIB
  47 #include "wx/msw/dib.h"
  48 #endif
  49
  50 #include "wx/image.h"
  51 #include "wx/xpmdecod.h"
  52
  53 #ifdef wxHAVE_RAW_BITMAP
  54 #include "wx/rawbmp.h"
  55 #endif
  56
  57 // missing from mingw32 header
  58 #ifndef CLR_INVALID
  59     #define CLR_INVALID ((COLORREF)-1)
  60 #endif // no CLR_INVALID
  61
  62 // ----------------------------------------------------------------------------
  63 // Bitmap data
  64 // ----------------------------------------------------------------------------
  65
  66 class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
  67 {
  68 public:
  69     wxBitmapRefData();
  70     wxBitmapRefData(const wxBitmapRefData& data);
  71     virtual ~wxBitmapRefData() { Free(); }
  72
  73     virtual void Free();
  74
  75     // set the mask object to use as the mask, we take ownership of it
  76     void SetMask(wxMask *mask)
  77     {
  78         delete m_bitmapMask;
  79         m_bitmapMask = mask;
  80     }
  81
  82     // set the HBITMAP to use as the mask
  83     void SetMask(HBITMAP hbmpMask)
  84     {
  85         SetMask(new wxMask((WXHBITMAP)hbmpMask));
  86     }
  87
  88     // return the mask
  89     wxMask *GetMask() const { return m_bitmapMask; }
  90
  91 public:
  92 #if wxUSE_PALETTE
  93     wxPalette     m_bitmapPalette;
  94 #endif // wxUSE_PALETTE
  95
  96     // MSW-specific
  97     // ------------
  98
  99 #ifdef __WXDEBUG__
 100     // this field is solely for error checking: we detect selecting a bitmap
 101     // into more than one DC at once or deleting a bitmap still selected into a
 102     // DC (both are serious programming errors under Windows)
 103     wxDC         *m_selectedInto;
 104 #endif // __WXDEBUG__
 105
 106 #if wxUSE_WXDIB
 107     // when GetRawData() is called for a DDB we need to convert it to a DIB
 108     // first to be able to provide direct access to it and we cache that DIB
 109     // here and convert it back to DDB when UngetRawData() is called
 110     wxDIB *m_dib;
 111 #endif
 112
 113     // true if we have alpha transparency info and can be drawn using
 114     // AlphaBlend()
 115     bool m_hasAlpha;
 116
 117     // true if our HBITMAP is a DIB section, false if it is a DDB
 118     bool m_isDIB;
 119
 120 private:
 121     // optional mask for transparent drawing
 122     wxMask       *m_bitmapMask;
 123
 124
 125     // not implemented
 126     wxBitmapRefData& operator=(const wxBitmapRefData&);
 127 };
 128
 129 // ----------------------------------------------------------------------------
 130 // macros
 131 // ----------------------------------------------------------------------------
 132
 133 IMPLEMENT_DYNAMIC_CLASS(wxBitmap, wxGDIObject)
 134 IMPLEMENT_DYNAMIC_CLASS(wxMask, wxObject)
 135
 136 IMPLEMENT_DYNAMIC_CLASS(wxBitmapHandler, wxObject)
 137
 138 // ============================================================================
 139 // implementation
 140 // ============================================================================
 141
 142 // ----------------------------------------------------------------------------
 143 // helper functions
 144 // ----------------------------------------------------------------------------
 145
 146 // decide whether we should create a DIB or a DDB for the given parameters
 147 //
 148 // NB: we always use DIBs under Windows CE as this is much simpler (even if
 149 //     also less efficient...) and we obviously can't use them if there is no
 150 //     DIB support compiled in at all
 151 #ifdef __WXWINCE__
 152     static inline bool wxShouldCreateDIB(int, int, int, WXHDC) { return true; }
 153
 154     #define ALWAYS_USE_DIB
 155 #elif !wxUSE_WXDIB
 156     // no sense in defining wxShouldCreateDIB() as we can't compile code
 157     // executed if it is true, so we have to use #if's anyhow
 158     #define NEVER_USE_DIB
 159 #else // wxUSE_WXDIB && !__WXWINCE__
 160     static inline bool wxShouldCreateDIB(int w, int h, int d, WXHDC hdc)
 161     {
 162         // here is the logic:
 163         //
 164         //  (a) if hdc is specified, the caller explicitly wants DDB
 165         //  (b) otherwise, create a DIB if depth >= 24 (we don't support 16bpp
 166         //      or less DIBs anyhow)
 167         //  (c) finally, create DIBs under Win9x even if the depth hasn't been
 168         //      explicitly specified but the current display depth is 24 or
 169         //      more and the image is "big", i.e. > 16Mb which is the
 170         //      theoretical limit for DDBs under Win9x
 171         //
 172         // consequences (all of which seem to make sense):
 173         //
 174         //  (i)     by default, DDBs are created (depth == -1 usually)
 175         //  (ii)    DIBs can be created by explicitly specifying the depth
 176         //  (iii)   using a DC always forces creating a DDB
 177         return !hdc &&
 178                 (d >= 24 ||
 179                     (d == -1 &&
 180                         wxDIB::GetLineSize(w, wxDisplayDepth())*h > 16*1024*1024));
 181     }
 182
 183     #define SOMETIMES_USE_DIB
 184 #endif // different DIB usage scenarious
 185
 186 // ----------------------------------------------------------------------------
 187 // wxBitmapRefData
 188 // ----------------------------------------------------------------------------
 189
 190 wxBitmapRefData::wxBitmapRefData()
 191 {
 192 #ifdef __WXDEBUG__
 193     m_selectedInto = NULL;
 194 #endif
 195     m_bitmapMask = NULL;
 196
 197     m_hBitmap = (WXHBITMAP) NULL;
 198 #if wxUSE_WXDIB
 199     m_dib = NULL;
 200 #endif
 201
 202     m_isDIB =
 203     m_hasAlpha = false;
 204 }
 205
 206 wxBitmapRefData::wxBitmapRefData(const wxBitmapRefData& data)
 207                : wxGDIImageRefData(data)
 208 {
 209 #ifdef __WXDEBUG__
 210     m_selectedInto = NULL;
 211 #endif
 212
 213     // can't copy the mask as the other bitmap destroys it
 214     m_bitmapMask = NULL;
 215
 216     wxASSERT_MSG( !data.m_isDIB,
 217                     _T("can't copy bitmap locked for raw access!") );
 218     m_isDIB = false;
 219
 220     m_hasAlpha = data.m_hasAlpha;
 221 }
 222
 223 void wxBitmapRefData::Free()
 224 {
 225     wxASSERT_MSG( !m_selectedInto,
 226                   wxT("deleting bitmap still selected into wxMemoryDC") );
 227
 228 #if wxUSE_WXDIB
 229     wxASSERT_MSG( !m_dib, _T("forgot to call wxBitmap::UngetRawData()!") );
 230 #endif
 231
 232     if ( m_hBitmap)
 233     {
 234         if ( !::DeleteObject((HBITMAP)m_hBitmap) )
 235         {
 236             wxLogLastError(wxT("DeleteObject(hbitmap)"));
 237         }
 238     }
 239
 240     delete m_bitmapMask;
 241     m_bitmapMask = NULL;
 242 }
 243
 244 // ----------------------------------------------------------------------------
 245 // wxBitmap creation
 246 // ----------------------------------------------------------------------------
 247
 248 // this function should be called from all wxBitmap ctors
 249 void wxBitmap::Init()
 250 {
 251     // m_refData = NULL; done in the base class ctor
 252 }
 253
 254 wxGDIImageRefData *wxBitmap::CreateData() const
 255 {
 256     return new wxBitmapRefData;
 257 }
 258
 259 wxObjectRefData *wxBitmap::CloneRefData(const wxObjectRefData *dataOrig) const
 260 {
 261     const wxBitmapRefData *
 262         data = wx_static_cast(const wxBitmapRefData *, dataOrig);
 263     if ( !data )
 264         return NULL;
 265
 266     wxBitmap *self = wx_const_cast(wxBitmap *, this);
 267
 268 #if wxUSE_WXDIB
 269     // copy the other bitmap
 270     if ( data->m_hBitmap )
 271     {
 272         wxDIB dib((HBITMAP)(data->m_hBitmap));
 273         self->CopyFromDIB(dib);
 274     }
 275     else
 276 #endif // wxUSE_WXDIB
 277     {
 278         // don't copy the bitmap data, but do copy the size, depth, ...
 279         self->m_refData = new wxBitmapRefData(*data);
 280     }
 281
 282     return m_refData;
 283 }
 284
 285 #ifdef __WIN32__
 286
 287 bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage& icon)
 288 {
 289 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 290     // it may be either HICON or HCURSOR
 291     HICON hicon = (HICON)icon.GetHandle();
 292
 293     ICONINFO iconInfo;
 294     if ( !::GetIconInfo(hicon, &iconInfo) )
 295     {
 296         wxLogLastError(wxT("GetIconInfo"));
 297
 298         return false;
 299     }
 300
 301     wxBitmapRefData *refData = new wxBitmapRefData;
 302     m_refData = refData;
 303
 304     int w = icon.GetWidth(),
 305         h = icon.GetHeight();
 306
 307     refData->m_width = w;
 308     refData->m_height = h;
 309     refData->m_depth = wxDisplayDepth();
 310
 311     refData->m_hBitmap = (WXHBITMAP)iconInfo.hbmColor;
 312
 313 #if wxUSE_WXDIB
 314     // If the icon is 32 bits per pixel then it may have alpha channel data,
 315     // although there are some icons that are 32 bpp but have no alpha... So
 316     // convert to a DIB and manually check the 4th byte for each pixel.
 317     BITMAP bm;
 318     if ( ::GetObject(iconInfo.hbmColor, sizeof(BITMAP), (LPVOID)&bm)
 319          && bm.bmBitsPixel == 32)
 320     {
 321         wxDIB dib(iconInfo.hbmColor);
 322         if (dib.IsOk())
 323         {
 324             unsigned char* pixels = dib.GetData();
 325             for (int idx=0; idx<w*h*4; idx+=4)
 326             {
 327                 if (pixels[idx+3] != 0)
 328                 {
 329                     // If there is an alpha byte that is non-zero then set the
 330                     // alpha flag and bail out of the loop.
 331                     refData->m_hasAlpha = true;
 332                     break;
 333                 }
 334             }
 335         }
 336     }
 337 #endif
 338     if ( !refData->m_hasAlpha )
 339     {
 340         // the mask returned by GetIconInfo() is inverted compared to the usual
 341         // wxWin convention
 342         refData->SetMask(wxInvertMask(iconInfo.hbmMask, w, h));
 343     }
 344
 345     // delete the old one now as we don't need it any more
 346     ::DeleteObject(iconInfo.hbmMask);
 347
 348     return true;
 349 #else
 350     wxUnusedVar(icon);
 351     return false;
 352 #endif
 353 }
 354
 355 #endif // Win32
 356
 357 bool wxBitmap::CopyFromCursor(const wxCursor& cursor)
 358 {
 359     UnRef();
 360
 361     if ( !cursor.Ok() )
 362         return false;
 363
 364     return CopyFromIconOrCursor(cursor);
 365 }
 366
 367 bool wxBitmap::CopyFromIcon(const wxIcon& icon)
 368 {
 369     UnRef();
 370
 371     if ( !icon.Ok() )
 372         return false;
 373
 374     return CopyFromIconOrCursor(icon);
 375 }
 376
 377 #ifndef NEVER_USE_DIB
 378
 379 bool wxBitmap::CopyFromDIB(const wxDIB& dib)
 380 {
 381     wxCHECK_MSG( dib.IsOk(), false, _T("invalid DIB in CopyFromDIB") );
 382
 383 #ifdef SOMETIMES_USE_DIB
 384     HBITMAP hbitmap = dib.CreateDDB();
 385     if ( !hbitmap )
 386         return false;
 387 #else // ALWAYS_USE_DIB
 388     HBITMAP hbitmap = ((wxDIB &)dib).Detach();  // const_cast
 389 #endif // SOMETIMES_USE_DIB/ALWAYS_USE_DIB
 390
 391     UnRef();
 392
 393     wxBitmapRefData *refData = new wxBitmapRefData;
 394     m_refData = refData;
 395
 396     refData->m_width = dib.GetWidth();
 397     refData->m_height = dib.GetHeight();
 398     refData->m_depth = dib.GetDepth();
 399
 400     refData->m_hBitmap = (WXHBITMAP)hbitmap;
 401
 402 #if wxUSE_PALETTE
 403     wxPalette *palette = dib.CreatePalette();
 404     if ( palette )
 405     {
 406         refData->m_bitmapPalette = *palette;
 407     }
 408
 409     delete palette;
 410 #endif // wxUSE_PALETTE
 411
 412     return true;
 413 }
 414
 415 #endif // NEVER_USE_DIB
 416
 417 wxBitmap::~wxBitmap()
 418 {
 419 }
 420
 421 wxBitmap::wxBitmap(const char bits[], int width, int height, int depth)
 422 {
 423     Init();
 424
 425 #ifndef __WXMICROWIN__
 426     wxBitmapRefData *refData = new wxBitmapRefData;
 427     m_refData = refData;
 428
 429     refData->m_width = width;
 430     refData->m_height = height;
 431     refData->m_depth = depth;
 432
 433     char *data;
 434     if ( depth == 1 )
 435     {
 436         // we assume that it is in XBM format which is not quite the same as
 437         // the format CreateBitmap() wants because the order of bytes in the
 438         // line is reversed!
 439         const size_t bytesPerLine = (width + 7) / 8;
 440         const size_t padding = bytesPerLine % 2;
 441         const size_t len = height * ( padding + bytesPerLine );
 442         data = (char *)malloc(len);
 443         const char *src = bits;
 444         char *dst = data;
 445
 446         for ( int rows = 0; rows < height; rows++ )
 447         {
 448             for ( size_t cols = 0; cols < bytesPerLine; cols++ )
 449             {
 450                 unsigned char val = *src++;
 451                 unsigned char reversed = 0;
 452
 453                 for ( int bits = 0; bits < 8; bits++)
 454                 {
 455                     reversed <<= 1;
 456                     reversed |= (unsigned char)(val & 0x01);
 457                     val >>= 1;
 458                 }
 459                 *dst++ = reversed;
 460             }
 461
 462             if ( padding )
 463                 *dst++ = 0;
 464         }
 465     }
 466     else
 467     {
 468         // bits should already be in Windows standard format
 469         data = (char *)bits;    // const_cast is harmless
 470     }
 471
 472     HBITMAP hbmp = ::CreateBitmap(width, height, 1, depth, data);
 473     if ( !hbmp )
 474     {
 475         wxLogLastError(wxT("CreateBitmap"));
 476     }
 477
 478     if ( data != bits )
 479     {
 480         free(data);
 481     }
 482
 483     SetHBITMAP((WXHBITMAP)hbmp);
 484 #endif
 485 }
 486
 487 // Create from XPM data
 488 bool wxBitmap::CreateFromXpm(const char **data)
 489 {
 490 #if wxUSE_IMAGE && wxUSE_XPM
 491     Init();
 492
 493     wxCHECK_MSG( data != NULL, false, wxT("invalid bitmap data") )
 494
 495     wxXPMDecoder decoder;
 496     wxImage img = decoder.ReadData(data);
 497     wxCHECK_MSG( img.Ok(), false, wxT("invalid bitmap data") )
 498
 499     *this = wxBitmap(img);
 500     return true;
 501 #else
 502     wxUnusedVar(data);
 503     return false;
 504 #endif
 505 }
 506
 507 wxBitmap::wxBitmap(int w, int h, int d)
 508 {
 509     Init();
 510
 511     (void)Create(w, h, d);
 512 }
 513
 514 wxBitmap::wxBitmap(int w, int h, const wxDC& dc)
 515 {
 516     Init();
 517
 518     (void)Create(w, h, dc);
 519 }
 520
 521 wxBitmap::wxBitmap(void *data, long type, int width, int height, int depth)
 522 {
 523     Init();
 524
 525     (void)Create(data, type, width, height, depth);
 526 }
 527
 528 wxBitmap::wxBitmap(const wxString& filename, wxBitmapType type)
 529 {
 530     Init();
 531
 532     LoadFile(filename, (int)type);
 533 }
 534
 535 bool wxBitmap::Create(int width, int height, int depth)
 536 {
 537     return DoCreate(width, height, depth, 0);
 538 }
 539
 540 bool wxBitmap::Create(int width, int height, const wxDC& dc)
 541 {
 542     wxCHECK_MSG( dc.Ok(), false, _T("invalid HDC in wxBitmap::Create()") );
 543
 544     return DoCreate(width, height, -1, dc.GetHDC());
 545 }
 546
 547 bool wxBitmap::DoCreate(int w, int h, int d, WXHDC hdc)
 548 {
 549     UnRef();
 550
 551     m_refData = new wxBitmapRefData;
 552
 553     GetBitmapData()->m_width = w;
 554     GetBitmapData()->m_height = h;
 555
 556     HBITMAP hbmp    wxDUMMY_INITIALIZE(0);
 557
 558 #ifndef NEVER_USE_DIB
 559     if ( wxShouldCreateDIB(w, h, d, hdc) )
 560     {
 561         if ( d == -1 )
 562         {
 563             // create DIBs without alpha channel by default
 564             d = 24;
 565         }
 566
 567         wxDIB dib(w, h, d);
 568         if ( !dib.IsOk() )
 569            return false;
 570
 571         // don't delete the DIB section in dib object dtor
 572         hbmp = dib.Detach();
 573
 574         GetBitmapData()->m_isDIB = true;
 575         GetBitmapData()->m_depth = d;
 576     }
 577     else // create a DDB
 578 #endif // NEVER_USE_DIB
 579     {
 580 #ifndef ALWAYS_USE_DIB
 581 #ifndef __WXMICROWIN__
 582         if ( d > 0 )
 583         {
 584             hbmp = ::CreateBitmap(w, h, 1, d, NULL);
 585             if ( !hbmp )
 586             {
 587                 wxLogLastError(wxT("CreateBitmap"));
 588             }
 589
 590             GetBitmapData()->m_depth = d;
 591         }
 592         else // d == 0, create bitmap compatible with the screen
 593 #endif // !__WXMICROWIN__
 594         {
 595             ScreenHDC dc;
 596             hbmp = ::CreateCompatibleBitmap(dc, w, h);
 597             if ( !hbmp )
 598             {
 599                 wxLogLastError(wxT("CreateCompatibleBitmap"));
 600             }
 601
 602             GetBitmapData()->m_depth = wxDisplayDepth();
 603         }
 604 #endif // !ALWAYS_USE_DIB
 605     }
 606
 607     SetHBITMAP((WXHBITMAP)hbmp);
 608
 609     return Ok();
 610 }
 611
 612 #if wxUSE_IMAGE
 613
 614 // ----------------------------------------------------------------------------
 615 // wxImage to/from conversions for Microwin
 616 // ----------------------------------------------------------------------------
 617
 618 // Microwin versions are so different from normal ones that it really doesn't
 619 // make sense to use #ifdefs inside the function bodies
 620 #ifdef __WXMICROWIN__
 621
 622 bool wxBitmap::CreateFromImage(const wxImage& image, int depth, const wxDC& dc)
 623 {
 624     // Set this to 1 to experiment with mask code,
 625     // which currently doesn't work
 626     #define USE_MASKS 0
 627
 628     m_refData = new wxBitmapRefData();
 629
 630     // Initial attempt at a simple-minded implementation.
 631     // The bitmap will always be created at the screen depth,
 632     // so the 'depth' argument is ignored.
 633
 634     HDC hScreenDC = ::GetDC(NULL);
 635     int screenDepth = ::GetDeviceCaps(hScreenDC, BITSPIXEL);
 636
 637     HBITMAP hBitmap = ::CreateCompatibleBitmap(hScreenDC, image.GetWidth(), image.GetHeight());
 638     HBITMAP hMaskBitmap = NULL;
 639     HBITMAP hOldMaskBitmap = NULL;
 640     HDC hMaskDC = NULL;
 641     unsigned char maskR = 0;
 642     unsigned char maskG = 0;
 643     unsigned char maskB = 0;
 644
 645     //    printf("Created bitmap %d\n", (int) hBitmap);
 646     if (hBitmap == NULL)
 647     {
 648         ::ReleaseDC(NULL, hScreenDC);
 649         return false;
 650     }
 651     HDC hMemDC = ::CreateCompatibleDC(hScreenDC);
 652
 653     HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap);
 654     ::ReleaseDC(NULL, hScreenDC);
 655
 656     // created an mono-bitmap for the possible mask
 657     bool hasMask = image.HasMask();
 658
 659     if ( hasMask )
 660     {
 661 #if USE_MASKS
 662         // FIXME: we should be able to pass bpp = 1, but
 663         // GdBlit can't handle a different depth
 664 #if 0
 665         hMaskBitmap = ::CreateBitmap( (WORD)image.GetWidth(), (WORD)image.GetHeight(), 1, 1, NULL );
 666 #else
 667         hMaskBitmap = ::CreateCompatibleBitmap( hMemDC, (WORD)image.GetWidth(), (WORD)image.GetHeight());
 668 #endif
 669         maskR = image.GetMaskRed();
 670         maskG = image.GetMaskGreen();
 671         maskB = image.GetMaskBlue();
 672
 673         if (!hMaskBitmap)
 674         {
 675             hasMask = false;
 676         }
 677         else
 678         {
 679             hScreenDC = ::GetDC(NULL);
 680             hMaskDC = ::CreateCompatibleDC(hScreenDC);
 681            ::ReleaseDC(NULL, hScreenDC);
 682
 683             hOldMaskBitmap = ::SelectObject( hMaskDC, hMaskBitmap);
 684         }
 685 #else
 686         hasMask = false;
 687 #endif
 688     }
 689
 690     int i, j;
 691     for (i = 0; i < image.GetWidth(); i++)
 692     {
 693         for (j = 0; j < image.GetHeight(); j++)
 694         {
 695             unsigned char red = image.GetRed(i, j);
 696             unsigned char green = image.GetGreen(i, j);
 697             unsigned char blue = image.GetBlue(i, j);
 698
 699             ::SetPixel(hMemDC, i, j, PALETTERGB(red, green, blue));
 700
 701             if (hasMask)
 702             {
 703                 // scan the bitmap for the transparent colour and set the corresponding
 704                 // pixels in the mask to BLACK and the rest to WHITE
 705                 if (maskR == red && maskG == green && maskB == blue)
 706                     ::SetPixel(hMaskDC, i, j, PALETTERGB(0, 0, 0));
 707                 else
 708                     ::SetPixel(hMaskDC, i, j, PALETTERGB(255, 255, 255));
 709             }
 710         }
 711     }
 712
 713     ::SelectObject(hMemDC, hOldBitmap);
 714     ::DeleteDC(hMemDC);
 715     if (hasMask)
 716     {
 717         ::SelectObject(hMaskDC, hOldMaskBitmap);
 718         ::DeleteDC(hMaskDC);
 719
 720         ((wxBitmapRefData*)m_refData)->SetMask(hMaskBitmap);
 721     }
 722
 723     SetWidth(image.GetWidth());
 724     SetHeight(image.GetHeight());
 725     SetDepth(screenDepth);
 726     SetHBITMAP( (WXHBITMAP) hBitmap );
 727
 728 #if wxUSE_PALETTE
 729     // Copy the palette from the source image
 730     SetPalette(image.GetPalette());
 731 #endif // wxUSE_PALETTE
 732
 733     return true;
 734 }
 735
 736 wxImage wxBitmap::ConvertToImage() const
 737 {
 738     // Initial attempt at a simple-minded implementation.
 739     // The bitmap will always be created at the screen depth,
 740     // so the 'depth' argument is ignored.
 741     // TODO: transparency (create a mask image)
 742
 743     if (!Ok())
 744     {
 745         wxFAIL_MSG( wxT("bitmap is invalid") );
 746         return wxNullImage;
 747     }
 748
 749     wxImage image;
 750
 751     wxCHECK_MSG( Ok(), wxNullImage, wxT("invalid bitmap") );
 752
 753     // create an wxImage object
 754     int width = GetWidth();
 755     int height = GetHeight();
 756     image.Create( width, height );
 757     unsigned char *data = image.GetData();
 758     if( !data )
 759     {
 760         wxFAIL_MSG( wxT("could not allocate data for image") );
 761         return wxNullImage;
 762     }
 763
 764     HDC hScreenDC = ::GetDC(NULL);
 765
 766     HDC hMemDC = ::CreateCompatibleDC(hScreenDC);
 767     ::ReleaseDC(NULL, hScreenDC);
 768
 769     HBITMAP hBitmap = (HBITMAP) GetHBITMAP();
 770
 771     HBITMAP hOldBitmap = ::SelectObject(hMemDC, hBitmap);
 772
 773     int i, j;
 774     for (i = 0; i < GetWidth(); i++)
 775     {
 776         for (j = 0; j < GetHeight(); j++)
 777         {
 778             COLORREF color = ::GetPixel(hMemDC, i, j);
 779             unsigned char red = GetRValue(color);
 780             unsigned char green = GetGValue(color);
 781             unsigned char blue = GetBValue(color);
 782
 783             image.SetRGB(i, j, red, green, blue);
 784         }
 785     }
 786
 787     ::SelectObject(hMemDC, hOldBitmap);
 788     ::DeleteDC(hMemDC);
 789
 790 #if wxUSE_PALETTE
 791     // Copy the palette from the source image
 792     if (GetPalette())
 793         image.SetPalette(* GetPalette());
 794 #endif // wxUSE_PALETTE
 795
 796     return image;
 797 }
 798
 799 #endif // __WXMICROWIN__
 800
 801 // ----------------------------------------------------------------------------
 802 // wxImage to/from conversions
 803 // ----------------------------------------------------------------------------
 804
 805 #if wxUSE_WXDIB
 806
 807 bool wxBitmap::CreateFromImage(const wxImage& image, int depth)
 808 {
 809     return CreateFromImage(image, depth, 0);
 810 }
 811
 812 bool wxBitmap::CreateFromImage(const wxImage& image, const wxDC& dc)
 813 {
 814     wxCHECK_MSG( dc.Ok(), false,
 815                     _T("invalid HDC in wxBitmap::CreateFromImage()") );
 816
 817     return CreateFromImage(image, -1, dc.GetHDC());
 818 }
 819
 820 bool wxBitmap::CreateFromImage(const wxImage& image, int depth, WXHDC hdc)
 821 {
 822     wxCHECK_MSG( image.Ok(), false, wxT("invalid image") );
 823
 824     UnRef();
 825
 826     // first convert the image to DIB
 827     const int h = image.GetHeight();
 828     const int w = image.GetWidth();
 829
 830     wxDIB dib(image);
 831     if ( !dib.IsOk() )
 832         return false;
 833
 834
 835     // store the bitmap parameters
 836     wxBitmapRefData *refData = new wxBitmapRefData;
 837     refData->m_width = w;
 838     refData->m_height = h;
 839     refData->m_hasAlpha = image.HasAlpha();
 840
 841     m_refData = refData;
 842
 843
 844     // next either store DIB as is or create a DDB from it
 845     HBITMAP hbitmap     wxDUMMY_INITIALIZE(0);
 846
 847     // are we going to use DIB?
 848     //
 849     // NB: DDBs don't support alpha so if we have alpha channel we must use DIB
 850     if ( image.HasAlpha() || wxShouldCreateDIB(w, h, depth, hdc) )
 851     {
 852         // don't delete the DIB section in dib object dtor
 853         hbitmap = dib.Detach();
 854
 855         refData->m_isDIB = true;
 856         refData->m_depth = dib.GetDepth();
 857     }
 858 #ifndef ALWAYS_USE_DIB
 859     else // we need to convert DIB to DDB
 860     {
 861         hbitmap = dib.CreateDDB((HDC)hdc);
 862
 863         refData->m_depth = depth == -1 ? dib.GetDepth() : depth;
 864     }
 865 #endif // !ALWAYS_USE_DIB
 866
 867     // validate this object
 868     SetHBITMAP((WXHBITMAP)hbitmap);
 869
 870     // finally also set the mask if we have one
 871     if ( image.HasMask() )
 872     {
 873         const size_t len  = 2*((w+15)/16);
 874         BYTE *src  = image.GetData();
 875         BYTE *data = new BYTE[h*len];
 876         memset(data, 0, h*len);
 877         BYTE r = image.GetMaskRed(),
 878              g = image.GetMaskGreen(),
 879              b = image.GetMaskBlue();
 880         BYTE *dst = data;
 881         for ( int y = 0; y < h; y++, dst += len )
 882         {
 883             BYTE *dstLine = dst;
 884             BYTE mask = 0x80;
 885             for ( int x = 0; x < w; x++, src += 3 )
 886             {
 887                 if (src[0] != r || src[1] != g || src[2] != b)
 888                     *dstLine |= mask;
 889
 890                 if ( (mask >>= 1) == 0 )
 891                 {
 892                     dstLine++;
 893                     mask = 0x80;
 894                 }
 895             }
 896         }
 897
 898         hbitmap = ::CreateBitmap(w, h, 1, 1, data);
 899         if ( !hbitmap )
 900         {
 901             wxLogLastError(_T("CreateBitmap(mask)"));
 902         }
 903         else
 904         {
 905             SetMask(new wxMask((WXHBITMAP)hbitmap));
 906         }
 907
 908         delete[] data;
 909     }
 910
 911     return true;
 912 }
 913
 914 wxImage wxBitmap::ConvertToImage() const
 915 {
 916     // convert DDB to DIB
 917     wxDIB dib(*this);
 918
 919     if ( !dib.IsOk() )
 920     {
 921         return wxNullImage;
 922     }
 923
 924     // and then DIB to our wxImage
 925     wxImage image = dib.ConvertToImage();
 926     if ( !image.Ok() )
 927     {
 928         return wxNullImage;
 929     }
 930
 931     // now do the same for the mask, if we have any
 932     HBITMAP hbmpMask = GetMask() ? (HBITMAP) GetMask()->GetMaskBitmap() : NULL;
 933     if ( hbmpMask )
 934     {
 935         wxDIB dibMask(hbmpMask);
 936         if ( dibMask.IsOk() )
 937         {
 938             // TODO: use wxRawBitmap to iterate over DIB
 939
 940             // we hard code the mask colour for now but we could also make an
 941             // effort (and waste time) to choose a colour not present in the
 942             // image already to avoid having to fudge the pixels below --
 943             // whether it's worth to do it is unclear however
 944             static const int MASK_RED = 1;
 945             static const int MASK_GREEN = 2;
 946             static const int MASK_BLUE = 3;
 947             static const int MASK_BLUE_REPLACEMENT = 2;
 948
 949             const int h = dibMask.GetHeight();
 950             const int w = dibMask.GetWidth();
 951             const int bpp = dibMask.GetDepth();
 952             const int maskBytesPerPixel = bpp >> 3;
 953             const int maskBytesPerLine = wxDIB::GetLineSize(w, bpp);
 954             unsigned char *data = image.GetData();
 955
 956             // remember that DIBs are stored in bottom to top order
 957             unsigned char *
 958                 maskLineStart = dibMask.GetData() + ((h - 1) * maskBytesPerLine);
 959
 960             for ( int y = 0; y < h; y++, maskLineStart -= maskBytesPerLine )
 961             {
 962                 // traverse one mask DIB line
 963                 unsigned char *mask = maskLineStart;
 964                 for ( int x = 0; x < w; x++, mask += maskBytesPerPixel )
 965                 {
 966                     // should this pixel be transparent?
 967                     if ( *mask )
 968                     {
 969                         // no, check that it isn't transparent by accident
 970                         if ( (data[0] == MASK_RED) &&
 971                                 (data[1] == MASK_GREEN) &&
 972                                     (data[2] == MASK_BLUE) )
 973                         {
 974                             // we have to fudge the colour a bit to prevent
 975                             // this pixel from appearing transparent
 976                             data[2] = MASK_BLUE_REPLACEMENT;
 977                         }
 978
 979                         data += 3;
 980                     }
 981                     else // yes, transparent pixel
 982                     {
 983                         *data++ = MASK_RED;
 984                         *data++ = MASK_GREEN;
 985                         *data++ = MASK_BLUE;
 986                     }
 987                 }
 988             }
 989
 990             image.SetMaskColour(MASK_RED, MASK_GREEN, MASK_BLUE);
 991         }
 992     }
 993
 994     return image;
 995 }
 996
 997 #endif // wxUSE_WXDIB
 998
 999 #endif // wxUSE_IMAGE
1000
1001 // ----------------------------------------------------------------------------
1002 // loading and saving bitmaps
1003 // ----------------------------------------------------------------------------
1004
1005 bool wxBitmap::LoadFile(const wxString& filename, long type)
1006 {
1007     UnRef();
1008
1009     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
1010
1011     if ( handler )
1012     {
1013         m_refData = new wxBitmapRefData;
1014
1015         return handler->LoadFile(this, filename, type, -1, -1);
1016     }
1017 #if wxUSE_IMAGE
1018     else // no bitmap handler found
1019     {
1020         wxImage image;
1021         if ( image.LoadFile( filename, type ) && image.Ok() )
1022         {
1023             *this = wxBitmap(image);
1024
1025             return true;
1026         }
1027     }
1028 #endif // wxUSE_IMAGE
1029
1030     return false;
1031 }
1032
1033 bool wxBitmap::Create(void *data, long type, int width, int height, int depth)
1034 {
1035     UnRef();
1036
1037     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
1038
1039     if ( !handler )
1040     {
1041         wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %ld defined."), type);
1042
1043         return false;
1044     }
1045
1046     m_refData = new wxBitmapRefData;
1047
1048     return handler->Create(this, data, type, width, height, depth);
1049 }
1050
1051 bool wxBitmap::SaveFile(const wxString& filename,
1052                         int type,
1053                         const wxPalette *palette)
1054 {
1055     wxBitmapHandler *handler = wxDynamicCast(FindHandler(type), wxBitmapHandler);
1056
1057     if ( handler )
1058     {
1059         return handler->SaveFile(this, filename, type, palette);
1060     }
1061 #if wxUSE_IMAGE
1062     else // no bitmap handler found
1063     {
1064         // FIXME what about palette? shouldn't we use it?
1065         wxImage image = ConvertToImage();
1066         if ( image.Ok() )
1067         {
1068             return image.SaveFile(filename, type);
1069         }
1070     }
1071 #endif // wxUSE_IMAGE
1072
1073     return false;
1074 }
1075
1076 // ----------------------------------------------------------------------------
1077 // sub bitmap extraction
1078 // ----------------------------------------------------------------------------
1079
1080 wxBitmap wxBitmap::GetSubBitmap( const wxRect& rect) const
1081 {
1082     wxCHECK_MSG( Ok() &&
1083                  (rect.x >= 0) && (rect.y >= 0) &&
1084                  (rect.x+rect.width <= GetWidth()) &&
1085                  (rect.y+rect.height <= GetHeight()),
1086                  wxNullBitmap, wxT("Invalid bitmap or bitmap region") );
1087
1088     wxBitmap ret( rect.width, rect.height, GetDepth() );
1089     wxASSERT_MSG( ret.Ok(), wxT("GetSubBitmap error") );
1090
1091 #ifndef __WXMICROWIN__
1092     // handle alpha channel, if any
1093     if (HasAlpha())
1094         ret.UseAlpha();
1095
1096     // copy bitmap data
1097     MemoryHDC dcSrc,
1098               dcDst;
1099
1100     {
1101         SelectInHDC selectSrc(dcSrc, GetHbitmap()),
1102                     selectDst(dcDst, GetHbitmapOf(ret));
1103
1104         if ( !selectSrc || !selectDst )
1105         {
1106             wxLogLastError(_T("SelectObjct(hBitmap)"));
1107         }
1108
1109         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
1110                        dcSrc, rect.x, rect.y, SRCCOPY) )
1111         {
1112             wxLogLastError(_T("BitBlt"));
1113         }
1114     }
1115
1116     // copy mask if there is one
1117     if ( GetMask() )
1118     {
1119         HBITMAP hbmpMask = ::CreateBitmap(rect.width, rect.height, 1, 1, 0);
1120
1121         SelectInHDC selectSrc(dcSrc, (HBITMAP) GetMask()->GetMaskBitmap()),
1122                     selectDst(dcDst, hbmpMask);
1123
1124         if ( !::BitBlt(dcDst, 0, 0, rect.width, rect.height,
1125                        dcSrc, rect.x, rect.y, SRCCOPY) )
1126         {
1127             wxLogLastError(_T("BitBlt"));
1128         }
1129
1130         wxMask *mask = new wxMask((WXHBITMAP) hbmpMask);
1131         ret.SetMask(mask);
1132     }
1133 #endif // !__WXMICROWIN__
1134
1135     return ret;
1136 }
1137
1138 // ----------------------------------------------------------------------------
1139 // wxBitmap accessors
1140 // ----------------------------------------------------------------------------
1141
1142 #if wxUSE_PALETTE
1143 wxPalette* wxBitmap::GetPalette() const
1144 {
1145     return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette
1146                            : (wxPalette *) NULL;
1147 }
1148 #endif
1149
1150 wxMask *wxBitmap::GetMask() const
1151 {
1152     return GetBitmapData() ? GetBitmapData()->GetMask() : (wxMask *) NULL;
1153 }
1154
1155 wxBitmap wxBitmap::GetMaskBitmap() const
1156 {
1157     wxBitmap bmp;
1158     wxMask *mask = GetMask();
1159     if ( mask )
1160         bmp.SetHBITMAP(mask->GetMaskBitmap());
1161     return bmp;
1162 }
1163
1164 #ifdef __WXDEBUG__
1165
1166 wxDC *wxBitmap::GetSelectedInto() const
1167 {
1168     return GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC *) NULL;
1169 }
1170
1171 #endif
1172
1173 #if WXWIN_COMPATIBILITY_2_4
1174
1175 int wxBitmap::GetQuality() const
1176 {
1177     return 0;
1178 }
1179
1180 #endif // WXWIN_COMPATIBILITY_2_4
1181
1182 void wxBitmap::UseAlpha()
1183 {
1184     if ( GetBitmapData() )
1185         GetBitmapData()->m_hasAlpha = true;
1186 }
1187
1188 bool wxBitmap::HasAlpha() const
1189 {
1190     return GetBitmapData() && GetBitmapData()->m_hasAlpha;
1191 }
1192
1193 // ----------------------------------------------------------------------------
1194 // wxBitmap setters
1195 // ----------------------------------------------------------------------------
1196
1197 #ifdef __WXDEBUG__
1198
1199 void wxBitmap::SetSelectedInto(wxDC *dc)
1200 {
1201     if ( GetBitmapData() )
1202         GetBitmapData()->m_selectedInto = dc;
1203 }
1204
1205 #endif
1206
1207 #if wxUSE_PALETTE
1208
1209 void wxBitmap::SetPalette(const wxPalette& palette)
1210 {
1211     AllocExclusive();
1212
1213     GetBitmapData()->m_bitmapPalette = palette;
1214 }
1215
1216 #endif // wxUSE_PALETTE
1217
1218 void wxBitmap::SetMask(wxMask *mask)
1219 {
1220     AllocExclusive();
1221
1222     GetBitmapData()->SetMask(mask);
1223 }
1224
1225 #if WXWIN_COMPATIBILITY_2_4
1226
1227 void wxBitmap::SetQuality(int WXUNUSED(quality))
1228 {
1229 }
1230
1231 #endif // WXWIN_COMPATIBILITY_2_4
1232
1233 // ----------------------------------------------------------------------------
1234 // raw bitmap access support
1235 // ----------------------------------------------------------------------------
1236
1237 #ifdef wxHAVE_RAW_BITMAP
1238 void *wxBitmap::GetRawData(wxPixelDataBase& data, int bpp)
1239 {
1240 #if wxUSE_WXDIB
1241     if ( !Ok() )
1242     {
1243         // no bitmap, no data (raw or otherwise)
1244         return NULL;
1245     }
1246
1247     // if we're already a DIB we can access our data directly, but if not we
1248     // need to convert this DDB to a DIB section and use it for raw access and
1249     // then convert it back
1250     HBITMAP hDIB;
1251     if ( !GetBitmapData()->m_isDIB )
1252     {
1253         wxCHECK_MSG( !GetBitmapData()->m_dib, NULL,
1254                         _T("GetRawData() may be called only once") );
1255
1256         wxDIB *dib = new wxDIB(*this);
1257         if ( !dib->IsOk() )
1258         {
1259             delete dib;
1260
1261             return NULL;
1262         }
1263
1264         // we'll free it in UngetRawData()
1265         GetBitmapData()->m_dib = dib;
1266
1267         hDIB = dib->GetHandle();
1268     }
1269     else // we're a DIB
1270     {
1271         hDIB = GetHbitmap();
1272     }
1273
1274     DIBSECTION ds;
1275     if ( ::GetObject(hDIB, sizeof(ds), &ds) != sizeof(DIBSECTION) )
1276     {
1277         wxFAIL_MSG( _T("failed to get DIBSECTION from a DIB?") );
1278
1279         return NULL;
1280     }
1281
1282     // check that the bitmap is in correct format
1283     if ( ds.dsBm.bmBitsPixel != bpp )
1284     {
1285         wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
1286
1287         return NULL;
1288     }
1289
1290     // ok, store the relevant info in wxPixelDataBase
1291     const LONG h = ds.dsBm.bmHeight;
1292
1293     data.m_width = ds.dsBm.bmWidth;
1294     data.m_height = h;
1295
1296     // remember that DIBs are stored in top to bottom order!
1297     // (We can't just use ds.dsBm.bmWidthBytes here, because it isn't always a
1298     // multiple of 2, as required by the documentation.  So we use the official
1299     // formula, which we already use elsewhere.)
1300     const LONG bytesPerRow =
1301         wxDIB::GetLineSize(ds.dsBm.bmWidth, ds.dsBm.bmBitsPixel);
1302     data.m_stride = -bytesPerRow;
1303
1304     char *bits = (char *)ds.dsBm.bmBits;
1305     if ( h > 1 )
1306     {
1307         bits += (h - 1)*bytesPerRow;
1308     }
1309
1310     return bits;
1311 #else
1312     return NULL;
1313 #endif
1314 }
1315
1316 void wxBitmap::UngetRawData(wxPixelDataBase& dataBase)
1317 {
1318 #if wxUSE_WXDIB
1319     if ( !Ok() )
1320         return;
1321
1322     if ( !&dataBase )
1323     {
1324         // invalid data, don't crash -- but don't assert neither as we're
1325         // called automatically from wxPixelDataBase dtor and so there is no
1326         // way to prevent this from happening
1327         return;
1328     }
1329
1330     // if we're a DDB we need to convert DIB back to DDB now to make the
1331     // changes made via raw bitmap access effective
1332     if ( !GetBitmapData()->m_isDIB )
1333     {
1334         wxDIB *dib = GetBitmapData()->m_dib;
1335         GetBitmapData()->m_dib = NULL;
1336
1337         // TODO: convert
1338
1339         delete dib;
1340     }
1341 #endif // wxUSE_WXDIB
1342 }
1343 #endif // #ifdef wxHAVE_RAW_BITMAP
1344
1345 // ----------------------------------------------------------------------------
1346 // wxMask
1347 // ----------------------------------------------------------------------------
1348
1349 wxMask::wxMask()
1350 {
1351     m_maskBitmap = 0;
1352 }
1353
1354 // Construct a mask from a bitmap and a colour indicating
1355 // the transparent area
1356 wxMask::wxMask(const wxBitmap& bitmap, const wxColour& colour)
1357 {
1358     m_maskBitmap = 0;
1359     Create(bitmap, colour);
1360 }
1361
1362 // Construct a mask from a bitmap and a palette index indicating
1363 // the transparent area
1364 wxMask::wxMask(const wxBitmap& bitmap, int paletteIndex)
1365 {
1366     m_maskBitmap = 0;
1367     Create(bitmap, paletteIndex);
1368 }
1369
1370 // Construct a mask from a mono bitmap (copies the bitmap).
1371 wxMask::wxMask(const wxBitmap& bitmap)
1372 {
1373     m_maskBitmap = 0;
1374     Create(bitmap);
1375 }
1376
1377 wxMask::~wxMask()
1378 {
1379     if ( m_maskBitmap )
1380         ::DeleteObject((HBITMAP) m_maskBitmap);
1381 }
1382
1383 // Create a mask from a mono bitmap (copies the bitmap).
1384 bool wxMask::Create(const wxBitmap& bitmap)
1385 {
1386 #ifndef __WXMICROWIN__
1387     wxCHECK_MSG( bitmap.Ok() && bitmap.GetDepth() == 1, false,
1388                  _T("can't create mask from invalid or not monochrome bitmap") );
1389
1390     if ( m_maskBitmap )
1391     {
1392         ::DeleteObject((HBITMAP) m_maskBitmap);
1393         m_maskBitmap = 0;
1394     }
1395
1396     m_maskBitmap = (WXHBITMAP) CreateBitmap(
1397                                             bitmap.GetWidth(),
1398                                             bitmap.GetHeight(),
1399                                             1, 1, 0
1400                                            );
1401     HDC srcDC = CreateCompatibleDC(0);
1402     SelectObject(srcDC, (HBITMAP) bitmap.GetHBITMAP());
1403     HDC destDC = CreateCompatibleDC(0);
1404     SelectObject(destDC, (HBITMAP) m_maskBitmap);
1405     BitBlt(destDC, 0, 0, bitmap.GetWidth(), bitmap.GetHeight(), srcDC, 0, 0, SRCCOPY);
1406     SelectObject(srcDC, 0);
1407     DeleteDC(srcDC);
1408     SelectObject(destDC, 0);
1409     DeleteDC(destDC);
1410     return true;
1411 #else
1412     wxUnusedVar(bitmap);
1413     return false;
1414 #endif
1415 }
1416
1417 // Create a mask from a bitmap and a palette index indicating
1418 // the transparent area
1419 bool wxMask::Create(const wxBitmap& bitmap, int paletteIndex)
1420 {
1421     if ( m_maskBitmap )
1422     {
1423         ::DeleteObject((HBITMAP) m_maskBitmap);
1424         m_maskBitmap = 0;
1425     }
1426
1427 #if wxUSE_PALETTE
1428     if (bitmap.Ok() && bitmap.GetPalette()->Ok())
1429     {
1430         unsigned char red, green, blue;
1431         if (bitmap.GetPalette()->GetRGB(paletteIndex, &red, &green, &blue))
1432         {
1433             wxColour transparentColour(red, green, blue);
1434             return Create(bitmap, transparentColour);
1435         }
1436     }
1437 #endif // wxUSE_PALETTE
1438
1439     return false;
1440 }
1441
1442 // Create a mask from a bitmap and a colour indicating
1443 // the transparent area
1444 bool wxMask::Create(const wxBitmap& bitmap, const wxColour& colour)
1445 {
1446 #ifndef __WXMICROWIN__
1447     wxCHECK_MSG( bitmap.Ok(), false, _T("invalid bitmap in wxMask::Create") );
1448
1449     if ( m_maskBitmap )
1450     {
1451         ::DeleteObject((HBITMAP) m_maskBitmap);
1452         m_maskBitmap = 0;
1453     }
1454
1455     int width = bitmap.GetWidth(),
1456         height = bitmap.GetHeight();
1457
1458     // scan the bitmap for the transparent colour and set the corresponding
1459     // pixels in the mask to BLACK and the rest to WHITE
1460     COLORREF maskColour = wxColourToPalRGB(colour);
1461     m_maskBitmap = (WXHBITMAP)::CreateBitmap(width, height, 1, 1, 0);
1462
1463     HDC srcDC = ::CreateCompatibleDC(NULL);
1464     HDC destDC = ::CreateCompatibleDC(NULL);
1465     if ( !srcDC || !destDC )
1466     {
1467         wxLogLastError(wxT("CreateCompatibleDC"));
1468     }
1469
1470     bool ok = true;
1471
1472     // SelectObject() will fail
1473     wxASSERT_MSG( !bitmap.GetSelectedInto(),
1474                   _T("bitmap can't be selected in another DC") );
1475
1476     HGDIOBJ hbmpSrcOld = ::SelectObject(srcDC, GetHbitmapOf(bitmap));
1477     if ( !hbmpSrcOld )
1478     {
1479         wxLogLastError(wxT("SelectObject"));
1480
1481         ok = false;
1482     }
1483
1484     HGDIOBJ hbmpDstOld = ::SelectObject(destDC, (HBITMAP)m_maskBitmap);
1485     if ( !hbmpDstOld )
1486     {
1487         wxLogLastError(wxT("SelectObject"));
1488
1489         ok = false;
1490     }
1491
1492     if ( ok )
1493     {
1494         // this will create a monochrome bitmap with 0 points for the pixels
1495         // which have the same value as the background colour and 1 for the
1496         // others
1497         ::SetBkColor(srcDC, maskColour);
1498         ::BitBlt(destDC, 0, 0, width, height, srcDC, 0, 0, NOTSRCCOPY);
1499     }
1500
1501     ::SelectObject(srcDC, hbmpSrcOld);
1502     ::DeleteDC(srcDC);
1503     ::SelectObject(destDC, hbmpDstOld);
1504     ::DeleteDC(destDC);
1505
1506     return ok;
1507 #else // __WXMICROWIN__
1508     wxUnusedVar(bitmap);
1509     wxUnusedVar(colour);
1510     return false;
1511 #endif // __WXMICROWIN__/!__WXMICROWIN__
1512 }
1513
1514 // ----------------------------------------------------------------------------
1515 // wxBitmapHandler
1516 // ----------------------------------------------------------------------------
1517
1518 bool wxBitmapHandler::Create(wxGDIImage *image,
1519                              void *data,
1520                              long flags,
1521                              int width, int height, int depth)
1522 {
1523     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1524
1525     return bitmap ? Create(bitmap, data, flags, width, height, depth) : false;
1526 }
1527
1528 bool wxBitmapHandler::Load(wxGDIImage *image,
1529                            const wxString& name,
1530                            long flags,
1531                            int width, int height)
1532 {
1533     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1534
1535     return bitmap ? LoadFile(bitmap, name, flags, width, height) : false;
1536 }
1537
1538 bool wxBitmapHandler::Save(wxGDIImage *image,
1539                            const wxString& name,
1540                            int type)
1541 {
1542     wxBitmap *bitmap = wxDynamicCast(image, wxBitmap);
1543
1544     return bitmap ? SaveFile(bitmap, name, type) : false;
1545 }
1546
1547 bool wxBitmapHandler::Create(wxBitmap *WXUNUSED(bitmap),
1548                              void *WXUNUSED(data),
1549                              long WXUNUSED(type),
1550                              int WXUNUSED(width),
1551                              int WXUNUSED(height),
1552                              int WXUNUSED(depth))
1553 {
1554     return false;
1555 }
1556
1557 bool wxBitmapHandler::LoadFile(wxBitmap *WXUNUSED(bitmap),
1558                                const wxString& WXUNUSED(name),
1559                                long WXUNUSED(type),
1560                                int WXUNUSED(desiredWidth),
1561                                int WXUNUSED(desiredHeight))
1562 {
1563     return false;
1564 }
1565
1566 bool wxBitmapHandler::SaveFile(wxBitmap *WXUNUSED(bitmap),
1567                                const wxString& WXUNUSED(name),
1568                                int WXUNUSED(type),
1569                                const wxPalette *WXUNUSED(palette))
1570 {
1571     return false;
1572 }
1573
1574 // ----------------------------------------------------------------------------
1575 // DIB functions
1576 // ----------------------------------------------------------------------------
1577
1578 #ifndef __WXMICROWIN__
1579 bool wxCreateDIB(long xSize, long ySize, long bitsPerPixel,
1580                  HPALETTE hPal, LPBITMAPINFO* lpDIBHeader)
1581 {
1582    unsigned long   i, headerSize;
1583
1584    // Allocate space for a DIB header
1585    headerSize = (sizeof(BITMAPINFOHEADER) + (256 * sizeof(PALETTEENTRY)));
1586    LPBITMAPINFO lpDIBheader = (BITMAPINFO *) malloc(headerSize);
1587    LPPALETTEENTRY lpPe = (PALETTEENTRY *)((BYTE*)lpDIBheader + sizeof(BITMAPINFOHEADER));
1588
1589    GetPaletteEntries(hPal, 0, 256, lpPe);
1590
1591    memset(lpDIBheader, 0x00, sizeof(BITMAPINFOHEADER));
1592
1593    // Fill in the static parts of the DIB header
1594    lpDIBheader->bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
1595    lpDIBheader->bmiHeader.biWidth = xSize;
1596    lpDIBheader->bmiHeader.biHeight = ySize;
1597    lpDIBheader->bmiHeader.biPlanes = 1;
1598
1599    // this value must be 1, 4, 8 or 24 so PixelDepth can only be
1600    lpDIBheader->bmiHeader.biBitCount = (WORD)(bitsPerPixel);
1601    lpDIBheader->bmiHeader.biCompression = BI_RGB;
1602    lpDIBheader->bmiHeader.biSizeImage = (xSize * abs(ySize) * bitsPerPixel) >> 3;
1603    lpDIBheader->bmiHeader.biClrUsed = 256;
1604
1605
1606    // Initialize the DIB palette
1607    for (i = 0; i < 256; i++) {
1608       lpDIBheader->bmiColors[i].rgbReserved = lpPe[i].peFlags;
1609       lpDIBheader->bmiColors[i].rgbRed = lpPe[i].peRed;
1610       lpDIBheader->bmiColors[i].rgbGreen = lpPe[i].peGreen;
1611       lpDIBheader->bmiColors[i].rgbBlue = lpPe[i].peBlue;
1612    }
1613
1614    *lpDIBHeader = lpDIBheader;
1615
1616    return true;
1617 }
1618
1619 void wxFreeDIB(LPBITMAPINFO lpDIBHeader)
1620 {
1621     free(lpDIBHeader);
1622 }
1623 #endif
1624
1625 // ----------------------------------------------------------------------------
1626 // global helper functions implemented here
1627 // ----------------------------------------------------------------------------
1628
1629 // helper of wxBitmapToHICON/HCURSOR
1630 static
1631 HICON wxBitmapToIconOrCursor(const wxBitmap& bmp,
1632                              bool iconWanted,
1633                              int hotSpotX,
1634                              int hotSpotY)
1635 {
1636     if ( !bmp.Ok() )
1637     {
1638         // we can't create an icon/cursor form nothing
1639         return 0;
1640     }
1641
1642     wxMask* mask;
1643     wxBitmap newbmp;
1644     if ( bmp.HasAlpha() )
1645     {
1646         // Convert alpha to a mask.  NOTE: It would be better to actually put
1647         // the alpha into the icon instead of making a mask, but I don't have
1648         // time to figure that out today.
1649         wxImage img = bmp.ConvertToImage();
1650         img.ConvertAlphaToMask();
1651         newbmp = wxBitmap(img);
1652         mask = newbmp.GetMask();
1653     }
1654     else
1655     {
1656         mask = bmp.GetMask();
1657     }
1658
1659     if ( !mask )
1660     {
1661         // we must have a mask for an icon, so even if it's probably incorrect,
1662         // do create it (grey is the "standard" transparent colour)
1663         mask = new wxMask(bmp, *wxLIGHT_GREY);
1664     }
1665
1666     ICONINFO iconInfo;
1667     wxZeroMemory(iconInfo);
1668     iconInfo.fIcon = iconWanted;  // do we want an icon or a cursor?
1669     if ( !iconWanted )
1670     {
1671         iconInfo.xHotspot = hotSpotX;
1672         iconInfo.yHotspot = hotSpotY;
1673     }
1674
1675     iconInfo.hbmMask = wxInvertMask((HBITMAP)mask->GetMaskBitmap());
1676     iconInfo.hbmColor = GetHbitmapOf(bmp);
1677
1678     // black out the transparent area to preserve background colour, because
1679     // Windows blits the original bitmap using SRCINVERT (XOR) after applying
1680     // the mask to the dest rect.
1681     {
1682         MemoryHDC dcSrc, dcDst;
1683         SelectInHDC selectMask(dcSrc, (HBITMAP)mask->GetMaskBitmap()),
1684                     selectBitmap(dcDst, iconInfo.hbmColor);
1685
1686         if ( !::BitBlt(dcDst, 0, 0, bmp.GetWidth(), bmp.GetHeight(),
1687                        dcSrc, 0, 0, SRCAND) )
1688         {
1689             wxLogLastError(_T("BitBlt"));
1690         }
1691     }
1692
1693     HICON hicon = ::CreateIconIndirect(&iconInfo);
1694
1695     if ( !bmp.GetMask() && !bmp.HasAlpha() )
1696     {
1697         // we created the mask, now delete it
1698         delete mask;
1699     }
1700
1701     // delete the inverted mask bitmap we created as well
1702     ::DeleteObject(iconInfo.hbmMask);
1703
1704     return hicon;
1705 }
1706
1707 HICON wxBitmapToHICON(const wxBitmap& bmp)
1708 {
1709     return wxBitmapToIconOrCursor(bmp, true, 0, 0);
1710 }
1711
1712 HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY)
1713 {
1714     return (HCURSOR)wxBitmapToIconOrCursor(bmp, false, hotSpotX, hotSpotY);
1715 }
1716
1717 HBITMAP wxInvertMask(HBITMAP hbmpMask, int w, int h)
1718 {
1719 #ifndef __WXMICROWIN__
1720     wxCHECK_MSG( hbmpMask, 0, _T("invalid bitmap in wxInvertMask") );
1721
1722     // get width/height from the bitmap if not given
1723     if ( !w || !h )
1724     {
1725         BITMAP bm;
1726         ::GetObject(hbmpMask, sizeof(BITMAP), (LPVOID)&bm);
1727         w = bm.bmWidth;
1728         h = bm.bmHeight;
1729     }
1730
1731     HDC hdcSrc = ::CreateCompatibleDC(NULL);
1732     HDC hdcDst = ::CreateCompatibleDC(NULL);
1733     if ( !hdcSrc || !hdcDst )
1734     {
1735         wxLogLastError(wxT("CreateCompatibleDC"));
1736     }
1737
1738     HBITMAP hbmpInvMask = ::CreateBitmap(w, h, 1, 1, 0);
1739     if ( !hbmpInvMask )
1740     {
1741         wxLogLastError(wxT("CreateBitmap"));
1742     }
1743
1744     HGDIOBJ srcTmp = ::SelectObject(hdcSrc, hbmpMask);
1745     HGDIOBJ dstTmp = ::SelectObject(hdcDst, hbmpInvMask);
1746     if ( !::BitBlt(hdcDst, 0, 0, w, h,
1747                    hdcSrc, 0, 0,
1748                    NOTSRCCOPY) )
1749     {
1750         wxLogLastError(wxT("BitBlt"));
1751     }
1752
1753     // Deselect objects
1754     SelectObject(hdcSrc,srcTmp);
1755     SelectObject(hdcDst,dstTmp);
1756
1757     ::DeleteDC(hdcSrc);
1758     ::DeleteDC(hdcDst);
1759
1760     return hbmpInvMask;
1761 #else
1762     return 0;
1763 #endif
1764 }