src/msw/bitmap.cpp

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