1 ////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/bitmap.cpp
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
27 #include "wx/bitmap.h"
35 #include "wx/palette.h"
36 #include "wx/dcmemory.h"
42 #include "wx/msw/private.h"
45 #include "wx/msw/dib.h"
48 #ifdef wxHAVE_RAW_BITMAP
49 #include "wx/rawbmp.h"
52 // missing from mingw32 header
54 #define CLR_INVALID ((COLORREF)-1)
55 #endif // no CLR_INVALID
57 // ----------------------------------------------------------------------------
59 // ----------------------------------------------------------------------------
61 class WXDLLEXPORT wxBitmapRefData
: public wxGDIImageRefData
65 wxBitmapRefData(const wxBitmapRefData
& data
);
66 virtual ~wxBitmapRefData() { Free(); }
70 // set the mask object to use as the mask, we take ownership of it
71 void SetMask(wxMask
*mask
)
77 // set the HBITMAP to use as the mask
78 void SetMask(HBITMAP hbmpMask
)
80 SetMask(new wxMask((WXHBITMAP
)hbmpMask
));
84 wxMask
*GetMask() const { return m_bitmapMask
; }
88 wxPalette m_bitmapPalette
;
89 #endif // wxUSE_PALETTE
95 // this field is solely for error checking: we detect selecting a bitmap
96 // into more than one DC at once or deleting a bitmap still selected into a
97 // DC (both are serious programming errors under Windows)
102 // when GetRawData() is called for a DDB we need to convert it to a DIB
103 // first to be able to provide direct access to it and we cache that DIB
104 // here and convert it back to DDB when UngetRawData() is called
108 // true if we have alpha transparency info and can be drawn using
112 // true if our HBITMAP is a DIB section, false if it is a DDB
116 // optional mask for transparent drawing
117 wxMask
*m_bitmapMask
;
121 wxBitmapRefData
& operator=(const wxBitmapRefData
&);
124 // ----------------------------------------------------------------------------
126 // ----------------------------------------------------------------------------
128 IMPLEMENT_DYNAMIC_CLASS(wxBitmap
, wxGDIObject
)
129 IMPLEMENT_DYNAMIC_CLASS(wxMask
, wxObject
)
131 IMPLEMENT_DYNAMIC_CLASS(wxBitmapHandler
, wxObject
)
133 // ============================================================================
135 // ============================================================================
137 // ----------------------------------------------------------------------------
139 // ----------------------------------------------------------------------------
141 // decide whether we should create a DIB or a DDB for the given parameters
143 // NB: we always use DIBs under Windows CE as this is much simpler (even if
144 // also less efficient...) and we obviously can't use them if there is no
145 // DIB support compiled in at all
147 static inline bool wxShouldCreateDIB(int, int, int, WXHDC
) { return true; }
149 #define ALWAYS_USE_DIB
151 // no sense in defining wxShouldCreateDIB() as we can't compile code
152 // executed if it is true, so we have to use #if's anyhow
153 #define NEVER_USE_DIB
154 #else // wxUSE_WXDIB && !__WXWINCE__
155 static inline bool wxShouldCreateDIB(int w
, int h
, int d
, WXHDC hdc
)
157 // here is the logic:
159 // (a) if hdc is specified, the caller explicitly wants DDB
160 // (b) otherwise, create a DIB if depth >= 24 (we don't support 16bpp
161 // or less DIBs anyhow)
162 // (c) finally, create DIBs under Win9x even if the depth hasn't been
163 // explicitly specified but the current display depth is 24 or
164 // more and the image is "big", i.e. > 16Mb which is the
165 // theoretical limit for DDBs under Win9x
167 // consequences (all of which seem to make sense):
169 // (i) by default, DDBs are created (depth == -1 usually)
170 // (ii) DIBs can be created by explicitly specifying the depth
171 // (iii) using a DC always forces creating a DDB
175 wxDIB::GetLineSize(w
, wxDisplayDepth())*h
> 16*1024*1024));
178 #define SOMETIMES_USE_DIB
179 #endif // different DIB usage scenarious
181 // ----------------------------------------------------------------------------
183 // ----------------------------------------------------------------------------
185 wxBitmapRefData::wxBitmapRefData()
188 m_selectedInto
= NULL
;
192 m_hBitmap
= (WXHBITMAP
) NULL
;
201 wxBitmapRefData::wxBitmapRefData(const wxBitmapRefData
& data
)
202 : wxGDIImageRefData(data
)
205 m_selectedInto
= NULL
;
208 // (deep) copy the mask if present
210 if (data
.m_bitmapMask
)
211 m_bitmapMask
= new wxMask(*data
.m_bitmapMask
);
213 // FIXME: we don't copy m_hBitmap currently but we should, see wxBitmap::
216 wxASSERT_MSG( !data
.m_isDIB
,
217 _T("can't copy bitmap locked for raw access!") );
220 m_hasAlpha
= data
.m_hasAlpha
;
223 void wxBitmapRefData::Free()
225 wxASSERT_MSG( !m_selectedInto
,
226 wxT("deleting bitmap still selected into wxMemoryDC") );
229 wxASSERT_MSG( !m_dib
, _T("forgot to call wxBitmap::UngetRawData()!") );
234 if ( !::DeleteObject((HBITMAP
)m_hBitmap
) )
236 wxLogLastError(wxT("DeleteObject(hbitmap)"));
244 // ----------------------------------------------------------------------------
246 // ----------------------------------------------------------------------------
248 wxGDIImageRefData
*wxBitmap::CreateData() const
250 return new wxBitmapRefData
;
253 wxObjectRefData
*wxBitmap::CloneRefData(const wxObjectRefData
*dataOrig
) const
255 const wxBitmapRefData
*
256 data
= wx_static_cast(const wxBitmapRefData
*, dataOrig
);
260 // FIXME: this method is backwards, it should just create a new
261 // wxBitmapRefData using its copy ctor but instead it modifies this
262 // bitmap itself and then returns its m_refData -- which works, of
263 // course (except in !wxUSE_WXDIB), but is completely illogical
264 wxBitmap
*self
= wx_const_cast(wxBitmap
*, this);
267 // copy the other bitmap
268 if ( data
->m_hBitmap
)
270 wxDIB
dib((HBITMAP
)(data
->m_hBitmap
));
271 self
->CopyFromDIB(dib
);
274 #endif // wxUSE_WXDIB
276 // copy the bitmap data
277 self
->m_refData
= new wxBitmapRefData(*data
);
280 // copy also the mask
281 wxMask
* const maskSrc
= data
->GetMask();
284 wxBitmapRefData
*selfdata
= wx_static_cast(wxBitmapRefData
*, m_refData
);
286 selfdata
->SetMask(new wxMask(*maskSrc
));
292 bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage
& icon
,
293 wxBitmapTransparency transp
)
295 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
296 // it may be either HICON or HCURSOR
297 HICON hicon
= (HICON
)icon
.GetHandle();
300 if ( !::GetIconInfo(hicon
, &iconInfo
) )
302 wxLogLastError(wxT("GetIconInfo"));
307 wxBitmapRefData
*refData
= new wxBitmapRefData
;
310 int w
= icon
.GetWidth(),
311 h
= icon
.GetHeight();
313 refData
->m_width
= w
;
314 refData
->m_height
= h
;
315 refData
->m_depth
= wxDisplayDepth();
317 refData
->m_hBitmap
= (WXHBITMAP
)iconInfo
.hbmColor
;
322 wxFAIL_MSG( _T("unknown wxBitmapTransparency value") );
324 case wxBitmapTransparency_None
:
325 // nothing to do, refData->m_hasAlpha is false by default
328 case wxBitmapTransparency_Auto
:
330 // If the icon is 32 bits per pixel then it may have alpha channel
331 // data, although there are some icons that are 32 bpp but have no
332 // alpha... So convert to a DIB and manually check the 4th byte for
336 if ( ::GetObject(iconInfo
.hbmColor
, sizeof(bm
), &bm
) &&
337 (bm
.bmBitsPixel
== 32) )
339 wxDIB
dib(iconInfo
.hbmColor
);
342 const unsigned char* pixels
= dib
.GetData();
343 for (int idx
= 0; idx
< w
*h
*4; idx
+=4)
345 if (pixels
[idx
+3] != 0)
347 // If there is an alpha byte that is non-zero
348 // then set the alpha flag and stop checking
349 refData
->m_hasAlpha
= true;
357 #endif // wxUSE_WXDIB
359 case wxBitmapTransparency_Always
:
360 refData
->m_hasAlpha
= true;
364 if ( !refData
->m_hasAlpha
)
366 // the mask returned by GetIconInfo() is inverted compared to the usual
368 refData
->SetMask(wxInvertMask(iconInfo
.hbmMask
, w
, h
));
371 // delete the old one now as we don't need it any more
372 ::DeleteObject(iconInfo
.hbmMask
);
375 #else // __WXMICROWIN__ || __WXWINCE__
380 #endif // !__WXWINCE__/__WXWINCE__
383 bool wxBitmap::CopyFromCursor(const wxCursor
& cursor
, wxBitmapTransparency transp
)
390 return CopyFromIconOrCursor(cursor
, transp
);
393 bool wxBitmap::CopyFromIcon(const wxIcon
& icon
, wxBitmapTransparency transp
)
400 return CopyFromIconOrCursor(icon
, transp
);
403 #ifndef NEVER_USE_DIB
405 bool wxBitmap::CopyFromDIB(const wxDIB
& dib
)
407 wxCHECK_MSG( dib
.IsOk(), false, _T("invalid DIB in CopyFromDIB") );
409 #ifdef SOMETIMES_USE_DIB
410 HBITMAP hbitmap
= dib
.CreateDDB();
413 #else // ALWAYS_USE_DIB
414 HBITMAP hbitmap
= ((wxDIB
&)dib
).Detach(); // const_cast
415 #endif // SOMETIMES_USE_DIB/ALWAYS_USE_DIB
419 wxBitmapRefData
*refData
= new wxBitmapRefData
;
422 refData
->m_width
= dib
.GetWidth();
423 refData
->m_height
= dib
.GetHeight();
424 refData
->m_depth
= dib
.GetDepth();
426 refData
->m_hBitmap
= (WXHBITMAP
)hbitmap
;
429 wxPalette
*palette
= dib
.CreatePalette();
432 refData
->m_bitmapPalette
= *palette
;
436 #endif // wxUSE_PALETTE
441 #endif // NEVER_USE_DIB
443 wxBitmap::~wxBitmap()
447 wxBitmap::wxBitmap(const char bits
[], int width
, int height
, int depth
)
449 #ifndef __WXMICROWIN__
450 wxBitmapRefData
*refData
= new wxBitmapRefData
;
453 refData
->m_width
= width
;
454 refData
->m_height
= height
;
455 refData
->m_depth
= depth
;
460 // we assume that it is in XBM format which is not quite the same as
461 // the format CreateBitmap() wants because the order of bytes in the
463 const size_t bytesPerLine
= (width
+ 7) / 8;
464 const size_t padding
= bytesPerLine
% 2;
465 const size_t len
= height
* ( padding
+ bytesPerLine
);
466 data
= (char *)malloc(len
);
467 const char *src
= bits
;
470 for ( int rows
= 0; rows
< height
; rows
++ )
472 for ( size_t cols
= 0; cols
< bytesPerLine
; cols
++ )
474 unsigned char val
= *src
++;
475 unsigned char reversed
= 0;
477 for ( int bits
= 0; bits
< 8; bits
++)
480 reversed
|= (unsigned char)(val
& 0x01);
492 // bits should already be in Windows standard format
493 data
= (char *)bits
; // const_cast is harmless
496 HBITMAP hbmp
= ::CreateBitmap(width
, height
, 1, depth
, data
);
499 wxLogLastError(wxT("CreateBitmap"));
507 SetHBITMAP((WXHBITMAP
)hbmp
);
511 wxBitmap::wxBitmap(int w
, int h
, int d
)
513 (void)Create(w
, h
, d
);
516 wxBitmap::wxBitmap(int w
, int h
, const wxDC
& dc
)
518 (void)Create(w
, h
, dc
);
521 wxBitmap::wxBitmap(const void* data
, long type
, int width
, int height
, int depth
)
523 (void)Create(data
, type
, width
, height
, depth
);
526 wxBitmap::wxBitmap(const wxString
& filename
, wxBitmapType type
)
528 LoadFile(filename
, (int)type
);
531 bool wxBitmap::Create(int width
, int height
, int depth
)
533 return DoCreate(width
, height
, depth
, 0);
536 bool wxBitmap::Create(int width
, int height
, const wxDC
& dc
)
538 wxCHECK_MSG( dc
.Ok(), false, _T("invalid HDC in wxBitmap::Create()") );
540 return DoCreate(width
, height
, -1, dc
.GetHDC());
543 bool wxBitmap::DoCreate(int w
, int h
, int d
, WXHDC hdc
)
547 m_refData
= new wxBitmapRefData
;
549 GetBitmapData()->m_width
= w
;
550 GetBitmapData()->m_height
= h
;
552 HBITMAP hbmp
wxDUMMY_INITIALIZE(0);
554 #ifndef NEVER_USE_DIB
555 if ( wxShouldCreateDIB(w
, h
, d
, hdc
) )
559 // create DIBs without alpha channel by default
567 // don't delete the DIB section in dib object dtor
570 GetBitmapData()->m_isDIB
= true;
571 GetBitmapData()->m_depth
= d
;
574 #endif // NEVER_USE_DIB
576 #ifndef ALWAYS_USE_DIB
577 #ifndef __WXMICROWIN__
580 hbmp
= ::CreateBitmap(w
, h
, 1, d
, NULL
);
583 wxLogLastError(wxT("CreateBitmap"));
586 GetBitmapData()->m_depth
= d
;
588 else // d == 0, create bitmap compatible with the screen
589 #endif // !__WXMICROWIN__
592 hbmp
= ::CreateCompatibleBitmap(dc
, w
, h
);
595 wxLogLastError(wxT("CreateCompatibleBitmap"));
598 GetBitmapData()->m_depth
= wxDisplayDepth();
600 #endif // !ALWAYS_USE_DIB
603 SetHBITMAP((WXHBITMAP
)hbmp
);
610 // ----------------------------------------------------------------------------
611 // wxImage to/from conversions for Microwin
612 // ----------------------------------------------------------------------------
614 // Microwin versions are so different from normal ones that it really doesn't
615 // make sense to use #ifdefs inside the function bodies
616 #ifdef __WXMICROWIN__
618 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
, const wxDC
& dc
)
620 // Set this to 1 to experiment with mask code,
621 // which currently doesn't work
624 m_refData
= new wxBitmapRefData();
626 // Initial attempt at a simple-minded implementation.
627 // The bitmap will always be created at the screen depth,
628 // so the 'depth' argument is ignored.
630 HDC hScreenDC
= ::GetDC(NULL
);
631 int screenDepth
= ::GetDeviceCaps(hScreenDC
, BITSPIXEL
);
633 HBITMAP hBitmap
= ::CreateCompatibleBitmap(hScreenDC
, image
.GetWidth(), image
.GetHeight());
634 HBITMAP hMaskBitmap
= NULL
;
635 HBITMAP hOldMaskBitmap
= NULL
;
637 unsigned char maskR
= 0;
638 unsigned char maskG
= 0;
639 unsigned char maskB
= 0;
641 // printf("Created bitmap %d\n", (int) hBitmap);
644 ::ReleaseDC(NULL
, hScreenDC
);
647 HDC hMemDC
= ::CreateCompatibleDC(hScreenDC
);
649 HBITMAP hOldBitmap
= ::SelectObject(hMemDC
, hBitmap
);
650 ::ReleaseDC(NULL
, hScreenDC
);
652 // created an mono-bitmap for the possible mask
653 bool hasMask
= image
.HasMask();
658 // FIXME: we should be able to pass bpp = 1, but
659 // GdBlit can't handle a different depth
661 hMaskBitmap
= ::CreateBitmap( (WORD
)image
.GetWidth(), (WORD
)image
.GetHeight(), 1, 1, NULL
);
663 hMaskBitmap
= ::CreateCompatibleBitmap( hMemDC
, (WORD
)image
.GetWidth(), (WORD
)image
.GetHeight());
665 maskR
= image
.GetMaskRed();
666 maskG
= image
.GetMaskGreen();
667 maskB
= image
.GetMaskBlue();
675 hScreenDC
= ::GetDC(NULL
);
676 hMaskDC
= ::CreateCompatibleDC(hScreenDC
);
677 ::ReleaseDC(NULL
, hScreenDC
);
679 hOldMaskBitmap
= ::SelectObject( hMaskDC
, hMaskBitmap
);
687 for (i
= 0; i
< image
.GetWidth(); i
++)
689 for (j
= 0; j
< image
.GetHeight(); j
++)
691 unsigned char red
= image
.GetRed(i
, j
);
692 unsigned char green
= image
.GetGreen(i
, j
);
693 unsigned char blue
= image
.GetBlue(i
, j
);
695 ::SetPixel(hMemDC
, i
, j
, PALETTERGB(red
, green
, blue
));
699 // scan the bitmap for the transparent colour and set the corresponding
700 // pixels in the mask to BLACK and the rest to WHITE
701 if (maskR
== red
&& maskG
== green
&& maskB
== blue
)
702 ::SetPixel(hMaskDC
, i
, j
, PALETTERGB(0, 0, 0));
704 ::SetPixel(hMaskDC
, i
, j
, PALETTERGB(255, 255, 255));
709 ::SelectObject(hMemDC
, hOldBitmap
);
713 ::SelectObject(hMaskDC
, hOldMaskBitmap
);
716 ((wxBitmapRefData
*)m_refData
)->SetMask(hMaskBitmap
);
719 SetWidth(image
.GetWidth());
720 SetHeight(image
.GetHeight());
721 SetDepth(screenDepth
);
722 SetHBITMAP( (WXHBITMAP
) hBitmap
);
725 // Copy the palette from the source image
726 SetPalette(image
.GetPalette());
727 #endif // wxUSE_PALETTE
732 wxImage
wxBitmap::ConvertToImage() const
734 // Initial attempt at a simple-minded implementation.
735 // The bitmap will always be created at the screen depth,
736 // so the 'depth' argument is ignored.
737 // TODO: transparency (create a mask image)
741 wxFAIL_MSG( wxT("bitmap is invalid") );
747 wxCHECK_MSG( Ok(), wxNullImage
, wxT("invalid bitmap") );
749 // create an wxImage object
750 int width
= GetWidth();
751 int height
= GetHeight();
752 image
.Create( width
, height
);
753 unsigned char *data
= image
.GetData();
756 wxFAIL_MSG( wxT("could not allocate data for image") );
760 HDC hScreenDC
= ::GetDC(NULL
);
762 HDC hMemDC
= ::CreateCompatibleDC(hScreenDC
);
763 ::ReleaseDC(NULL
, hScreenDC
);
765 HBITMAP hBitmap
= (HBITMAP
) GetHBITMAP();
767 HBITMAP hOldBitmap
= ::SelectObject(hMemDC
, hBitmap
);
770 for (i
= 0; i
< GetWidth(); i
++)
772 for (j
= 0; j
< GetHeight(); j
++)
774 COLORREF color
= ::GetPixel(hMemDC
, i
, j
);
775 unsigned char red
= GetRValue(color
);
776 unsigned char green
= GetGValue(color
);
777 unsigned char blue
= GetBValue(color
);
779 image
.SetRGB(i
, j
, red
, green
, blue
);
783 ::SelectObject(hMemDC
, hOldBitmap
);
787 // Copy the palette from the source image
789 image
.SetPalette(* GetPalette());
790 #endif // wxUSE_PALETTE
795 #endif // __WXMICROWIN__
797 // ----------------------------------------------------------------------------
798 // wxImage to/from conversions
799 // ----------------------------------------------------------------------------
801 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
)
803 return CreateFromImage(image
, depth
, 0);
806 bool wxBitmap::CreateFromImage(const wxImage
& image
, const wxDC
& dc
)
808 wxCHECK_MSG( dc
.Ok(), false,
809 _T("invalid HDC in wxBitmap::CreateFromImage()") );
811 return CreateFromImage(image
, -1, dc
.GetHDC());
816 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
, WXHDC hdc
)
818 wxCHECK_MSG( image
.Ok(), false, wxT("invalid image") );
822 // first convert the image to DIB
823 const int h
= image
.GetHeight();
824 const int w
= image
.GetWidth();
831 depth
= dib
.GetDepth(); // Get depth from image if none specified
833 // store the bitmap parameters
834 wxBitmapRefData
*refData
= new wxBitmapRefData
;
835 refData
->m_width
= w
;
836 refData
->m_height
= h
;
837 refData
->m_hasAlpha
= image
.HasAlpha();
842 // next either store DIB as is or create a DDB from it
843 HBITMAP hbitmap
wxDUMMY_INITIALIZE(0);
845 // are we going to use DIB?
847 // NB: DDBs don't support alpha so if we have alpha channel we must use DIB
848 if ( image
.HasAlpha() || wxShouldCreateDIB(w
, h
, depth
, hdc
) )
850 // don't delete the DIB section in dib object dtor
851 hbitmap
= dib
.Detach();
853 refData
->m_isDIB
= true;
854 refData
->m_depth
= depth
;
856 #ifndef ALWAYS_USE_DIB
857 else // we need to convert DIB to DDB
859 hbitmap
= dib
.CreateDDB((HDC
)hdc
);
861 refData
->m_depth
= depth
;
863 #endif // !ALWAYS_USE_DIB
865 // validate this object
866 SetHBITMAP((WXHBITMAP
)hbitmap
);
868 // finally also set the mask if we have one
869 if ( image
.HasMask() )
871 const size_t len
= 2*((w
+15)/16);
872 BYTE
*src
= image
.GetData();
873 BYTE
*data
= new BYTE
[h
*len
];
874 memset(data
, 0, h
*len
);
875 BYTE r
= image
.GetMaskRed(),
876 g
= image
.GetMaskGreen(),
877 b
= image
.GetMaskBlue();
879 for ( int y
= 0; y
< h
; y
++, dst
+= len
)
883 for ( int x
= 0; x
< w
; x
++, src
+= 3 )
885 if (src
[0] != r
|| src
[1] != g
|| src
[2] != b
)
888 if ( (mask
>>= 1) == 0 )
896 hbitmap
= ::CreateBitmap(w
, h
, 1, 1, data
);
899 wxLogLastError(_T("CreateBitmap(mask)"));
903 SetMask(new wxMask((WXHBITMAP
)hbitmap
));
912 wxImage
wxBitmap::ConvertToImage() const
914 // convert DDB to DIB
922 // and then DIB to our wxImage
923 wxImage image
= dib
.ConvertToImage();
929 // now do the same for the mask, if we have any
930 HBITMAP hbmpMask
= GetMask() ? (HBITMAP
) GetMask()->GetMaskBitmap() : NULL
;
933 wxDIB
dibMask(hbmpMask
);
934 if ( dibMask
.IsOk() )
936 // TODO: use wxRawBitmap to iterate over DIB
938 // we hard code the mask colour for now but we could also make an
939 // effort (and waste time) to choose a colour not present in the
940 // image already to avoid having to fudge the pixels below --
941 // whether it's worth to do it is unclear however
942 static const int MASK_RED
= 1;
943 static const int MASK_GREEN
= 2;
944 static const int MASK_BLUE
= 3;
945 static const int MASK_BLUE_REPLACEMENT
= 2;
947 const int h
= dibMask
.GetHeight();
948 const int w
= dibMask
.GetWidth();
949 const int bpp
= dibMask
.GetDepth();
950 const int maskBytesPerPixel
= bpp
>> 3;
951 const int maskBytesPerLine
= wxDIB::GetLineSize(w
, bpp
);
952 unsigned char *data
= image
.GetData();
954 // remember that DIBs are stored in bottom to top order
956 maskLineStart
= dibMask
.GetData() + ((h
- 1) * maskBytesPerLine
);
958 for ( int y
= 0; y
< h
; y
++, maskLineStart
-= maskBytesPerLine
)
960 // traverse one mask DIB line
961 unsigned char *mask
= maskLineStart
;
962 for ( int x
= 0; x
< w
; x
++, mask
+= maskBytesPerPixel
)
964 // should this pixel be transparent?
967 // no, check that it isn't transparent by accident
968 if ( (data
[0] == MASK_RED
) &&
969 (data
[1] == MASK_GREEN
) &&
970 (data
[2] == MASK_BLUE
) )
972 // we have to fudge the colour a bit to prevent
973 // this pixel from appearing transparent
974 data
[2] = MASK_BLUE_REPLACEMENT
;
979 else // yes, transparent pixel
982 *data
++ = MASK_GREEN
;
988 image
.SetMaskColour(MASK_RED
, MASK_GREEN
, MASK_BLUE
);
995 #else // !wxUSE_WXDIB
998 wxBitmap::CreateFromImage(const wxImage
& WXUNUSED(image
),
1000 WXHDC
WXUNUSED(hdc
))
1005 wxImage
wxBitmap::ConvertToImage() const
1010 #endif // wxUSE_WXDIB/!wxUSE_WXDIB
1012 #endif // wxUSE_IMAGE
1014 // ----------------------------------------------------------------------------
1015 // loading and saving bitmaps
1016 // ----------------------------------------------------------------------------
1018 bool wxBitmap::LoadFile(const wxString
& filename
, long type
)
1022 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
1026 m_refData
= new wxBitmapRefData
;
1028 return handler
->LoadFile(this, filename
, type
, -1, -1);
1030 #if wxUSE_IMAGE && wxUSE_WXDIB
1031 else // no bitmap handler found
1034 if ( image
.LoadFile( filename
, type
) && image
.Ok() )
1036 *this = wxBitmap(image
);
1041 #endif // wxUSE_IMAGE
1046 bool wxBitmap::Create(const void* data
, long type
, int width
, int height
, int depth
)
1050 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
1054 wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %ld defined."), type
);
1059 m_refData
= new wxBitmapRefData
;
1061 return handler
->Create(this, data
, type
, width
, height
, depth
);
1064 bool wxBitmap::SaveFile(const wxString
& filename
,
1066 const wxPalette
*palette
)
1068 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
1072 return handler
->SaveFile(this, filename
, type
, palette
);
1074 #if wxUSE_IMAGE && wxUSE_WXDIB
1075 else // no bitmap handler found
1077 // FIXME what about palette? shouldn't we use it?
1078 wxImage image
= ConvertToImage();
1081 return image
.SaveFile(filename
, type
);
1084 #endif // wxUSE_IMAGE
1089 // ----------------------------------------------------------------------------
1090 // sub bitmap extraction
1091 // ----------------------------------------------------------------------------
1093 wxBitmap
wxBitmap::GetSubBitmap( const wxRect
& rect
) const
1095 wxCHECK_MSG( Ok() &&
1096 (rect
.x
>= 0) && (rect
.y
>= 0) &&
1097 (rect
.x
+rect
.width
<= GetWidth()) &&
1098 (rect
.y
+rect
.height
<= GetHeight()),
1099 wxNullBitmap
, wxT("Invalid bitmap or bitmap region") );
1101 wxBitmap
ret( rect
.width
, rect
.height
, GetDepth() );
1102 wxASSERT_MSG( ret
.Ok(), wxT("GetSubBitmap error") );
1104 #ifndef __WXMICROWIN__
1105 // handle alpha channel, if any
1114 SelectInHDC
selectSrc(dcSrc
, GetHbitmap()),
1115 selectDst(dcDst
, GetHbitmapOf(ret
));
1117 if ( !selectSrc
|| !selectDst
)
1119 wxLogLastError(_T("SelectObjct(hBitmap)"));
1122 if ( !::BitBlt(dcDst
, 0, 0, rect
.width
, rect
.height
,
1123 dcSrc
, rect
.x
, rect
.y
, SRCCOPY
) )
1125 wxLogLastError(_T("BitBlt"));
1129 // copy mask if there is one
1132 HBITMAP hbmpMask
= ::CreateBitmap(rect
.width
, rect
.height
, 1, 1, 0);
1134 SelectInHDC
selectSrc(dcSrc
, (HBITMAP
) GetMask()->GetMaskBitmap()),
1135 selectDst(dcDst
, hbmpMask
);
1137 if ( !::BitBlt(dcDst
, 0, 0, rect
.width
, rect
.height
,
1138 dcSrc
, rect
.x
, rect
.y
, SRCCOPY
) )
1140 wxLogLastError(_T("BitBlt"));
1143 wxMask
*mask
= new wxMask((WXHBITMAP
) hbmpMask
);
1146 #endif // !__WXMICROWIN__
1151 // ----------------------------------------------------------------------------
1152 // wxBitmap accessors
1153 // ----------------------------------------------------------------------------
1156 wxPalette
* wxBitmap::GetPalette() const
1158 return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette
1159 : (wxPalette
*) NULL
;
1163 wxMask
*wxBitmap::GetMask() const
1165 return GetBitmapData() ? GetBitmapData()->GetMask() : (wxMask
*) NULL
;
1168 wxBitmap
wxBitmap::GetMaskBitmap() const
1171 wxMask
*mask
= GetMask();
1173 bmp
.SetHBITMAP(mask
->GetMaskBitmap());
1179 wxDC
*wxBitmap::GetSelectedInto() const
1181 return GetBitmapData() ? GetBitmapData()->m_selectedInto
: (wxDC
*) NULL
;
1186 void wxBitmap::UseAlpha()
1188 if ( GetBitmapData() )
1189 GetBitmapData()->m_hasAlpha
= true;
1192 bool wxBitmap::HasAlpha() const
1194 return GetBitmapData() && GetBitmapData()->m_hasAlpha
;
1197 // ----------------------------------------------------------------------------
1199 // ----------------------------------------------------------------------------
1203 void wxBitmap::SetSelectedInto(wxDC
*dc
)
1205 if ( GetBitmapData() )
1206 GetBitmapData()->m_selectedInto
= dc
;
1213 void wxBitmap::SetPalette(const wxPalette
& palette
)
1217 GetBitmapData()->m_bitmapPalette
= palette
;
1220 #endif // wxUSE_PALETTE
1222 void wxBitmap::SetMask(wxMask
*mask
)
1226 GetBitmapData()->SetMask(mask
);
1229 // ----------------------------------------------------------------------------
1230 // raw bitmap access support
1231 // ----------------------------------------------------------------------------
1233 #ifdef wxHAVE_RAW_BITMAP
1234 void *wxBitmap::GetRawData(wxPixelDataBase
& data
, int bpp
)
1239 // no bitmap, no data (raw or otherwise)
1243 // if we're already a DIB we can access our data directly, but if not we
1244 // need to convert this DDB to a DIB section and use it for raw access and
1245 // then convert it back
1247 if ( !GetBitmapData()->m_isDIB
)
1249 wxCHECK_MSG( !GetBitmapData()->m_dib
, NULL
,
1250 _T("GetRawData() may be called only once") );
1252 wxDIB
*dib
= new wxDIB(*this);
1260 // we'll free it in UngetRawData()
1261 GetBitmapData()->m_dib
= dib
;
1263 hDIB
= dib
->GetHandle();
1267 hDIB
= GetHbitmap();
1271 if ( ::GetObject(hDIB
, sizeof(ds
), &ds
) != sizeof(DIBSECTION
) )
1273 wxFAIL_MSG( _T("failed to get DIBSECTION from a DIB?") );
1278 // check that the bitmap is in correct format
1279 if ( ds
.dsBm
.bmBitsPixel
!= bpp
)
1281 wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
1286 // ok, store the relevant info in wxPixelDataBase
1287 const LONG h
= ds
.dsBm
.bmHeight
;
1289 data
.m_width
= ds
.dsBm
.bmWidth
;
1292 // remember that DIBs are stored in top to bottom order!
1293 // (We can't just use ds.dsBm.bmWidthBytes here, because it isn't always a
1294 // multiple of 2, as required by the documentation. So we use the official
1295 // formula, which we already use elsewhere.)
1296 const LONG bytesPerRow
=
1297 wxDIB::GetLineSize(ds
.dsBm
.bmWidth
, ds
.dsBm
.bmBitsPixel
);
1298 data
.m_stride
= -bytesPerRow
;
1300 char *bits
= (char *)ds
.dsBm
.bmBits
;
1303 bits
+= (h
- 1)*bytesPerRow
;
1312 void wxBitmap::UngetRawData(wxPixelDataBase
& dataBase
)
1320 // invalid data, don't crash -- but don't assert neither as we're
1321 // called automatically from wxPixelDataBase dtor and so there is no
1322 // way to prevent this from happening
1326 // if we're a DDB we need to convert DIB back to DDB now to make the
1327 // changes made via raw bitmap access effective
1328 if ( !GetBitmapData()->m_isDIB
)
1330 wxDIB
*dib
= GetBitmapData()->m_dib
;
1331 GetBitmapData()->m_dib
= NULL
;
1337 #endif // wxUSE_WXDIB
1339 #endif // #ifdef wxHAVE_RAW_BITMAP
1341 // ----------------------------------------------------------------------------
1343 // ----------------------------------------------------------------------------
1351 wxMask::wxMask(const wxMask
&mask
)
1356 HDC srcDC
= CreateCompatibleDC(0);
1357 HDC destDC
= CreateCompatibleDC(0);
1359 // GetBitmapDimensionEx won't work if SetBitmapDimensionEx wasn't used
1360 // so we'll use GetObject() API here:
1361 if (::GetObject((HGDIOBJ
)mask
.m_maskBitmap
, sizeof(bmp
), &bmp
) == 0)
1363 wxFAIL_MSG(wxT("Cannot retrieve the dimensions of the wxMask to copy"));
1367 // create our HBITMAP
1368 int w
= bmp
.bmWidth
, h
= bmp
.bmHeight
;
1369 m_maskBitmap
= (WXHBITMAP
)CreateCompatibleBitmap(srcDC
, w
, h
);
1371 // copy the mask's HBITMAP into our HBITMAP
1372 SelectObject(srcDC
, (HBITMAP
) mask
.m_maskBitmap
);
1373 SelectObject(destDC
, (HBITMAP
) m_maskBitmap
);
1375 BitBlt(destDC
, 0, 0, w
, h
, srcDC
, 0, 0, SRCCOPY
);
1377 SelectObject(srcDC
, 0);
1379 SelectObject(destDC
, 0);
1383 // Construct a mask from a bitmap and a colour indicating
1384 // the transparent area
1385 wxMask::wxMask(const wxBitmap
& bitmap
, const wxColour
& colour
)
1388 Create(bitmap
, colour
);
1391 // Construct a mask from a bitmap and a palette index indicating
1392 // the transparent area
1393 wxMask::wxMask(const wxBitmap
& bitmap
, int paletteIndex
)
1396 Create(bitmap
, paletteIndex
);
1399 // Construct a mask from a mono bitmap (copies the bitmap).
1400 wxMask::wxMask(const wxBitmap
& bitmap
)
1409 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1412 // Create a mask from a mono bitmap (copies the bitmap).
1413 bool wxMask::Create(const wxBitmap
& bitmap
)
1415 #ifndef __WXMICROWIN__
1416 wxCHECK_MSG( bitmap
.Ok() && bitmap
.GetDepth() == 1, false,
1417 _T("can't create mask from invalid or not monochrome bitmap") );
1421 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1425 m_maskBitmap
= (WXHBITMAP
) CreateBitmap(
1430 HDC srcDC
= CreateCompatibleDC(0);
1431 SelectObject(srcDC
, (HBITMAP
) bitmap
.GetHBITMAP());
1432 HDC destDC
= CreateCompatibleDC(0);
1433 SelectObject(destDC
, (HBITMAP
) m_maskBitmap
);
1434 BitBlt(destDC
, 0, 0, bitmap
.GetWidth(), bitmap
.GetHeight(), srcDC
, 0, 0, SRCCOPY
);
1435 SelectObject(srcDC
, 0);
1437 SelectObject(destDC
, 0);
1441 wxUnusedVar(bitmap
);
1446 // Create a mask from a bitmap and a palette index indicating
1447 // the transparent area
1448 bool wxMask::Create(const wxBitmap
& bitmap
, int paletteIndex
)
1452 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1457 if (bitmap
.Ok() && bitmap
.GetPalette()->Ok())
1459 unsigned char red
, green
, blue
;
1460 if (bitmap
.GetPalette()->GetRGB(paletteIndex
, &red
, &green
, &blue
))
1462 wxColour
transparentColour(red
, green
, blue
);
1463 return Create(bitmap
, transparentColour
);
1466 #endif // wxUSE_PALETTE
1471 // Create a mask from a bitmap and a colour indicating
1472 // the transparent area
1473 bool wxMask::Create(const wxBitmap
& bitmap
, const wxColour
& colour
)
1475 #ifndef __WXMICROWIN__
1476 wxCHECK_MSG( bitmap
.Ok(), false, _T("invalid bitmap in wxMask::Create") );
1480 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1484 int width
= bitmap
.GetWidth(),
1485 height
= bitmap
.GetHeight();
1487 // scan the bitmap for the transparent colour and set the corresponding
1488 // pixels in the mask to BLACK and the rest to WHITE
1489 COLORREF maskColour
= wxColourToPalRGB(colour
);
1490 m_maskBitmap
= (WXHBITMAP
)::CreateBitmap(width
, height
, 1, 1, 0);
1492 HDC srcDC
= ::CreateCompatibleDC(NULL
);
1493 HDC destDC
= ::CreateCompatibleDC(NULL
);
1494 if ( !srcDC
|| !destDC
)
1496 wxLogLastError(wxT("CreateCompatibleDC"));
1501 // SelectObject() will fail
1502 wxASSERT_MSG( !bitmap
.GetSelectedInto(),
1503 _T("bitmap can't be selected in another DC") );
1505 HGDIOBJ hbmpSrcOld
= ::SelectObject(srcDC
, GetHbitmapOf(bitmap
));
1508 wxLogLastError(wxT("SelectObject"));
1513 HGDIOBJ hbmpDstOld
= ::SelectObject(destDC
, (HBITMAP
)m_maskBitmap
);
1516 wxLogLastError(wxT("SelectObject"));
1523 // this will create a monochrome bitmap with 0 points for the pixels
1524 // which have the same value as the background colour and 1 for the
1526 ::SetBkColor(srcDC
, maskColour
);
1527 ::BitBlt(destDC
, 0, 0, width
, height
, srcDC
, 0, 0, NOTSRCCOPY
);
1530 ::SelectObject(srcDC
, hbmpSrcOld
);
1532 ::SelectObject(destDC
, hbmpDstOld
);
1536 #else // __WXMICROWIN__
1537 wxUnusedVar(bitmap
);
1538 wxUnusedVar(colour
);
1540 #endif // __WXMICROWIN__/!__WXMICROWIN__
1543 // ----------------------------------------------------------------------------
1545 // ----------------------------------------------------------------------------
1547 bool wxBitmapHandler::Create(wxGDIImage
*image
,
1550 int width
, int height
, int depth
)
1552 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1554 return bitmap
&& Create(bitmap
, data
, flags
, width
, height
, depth
);
1557 bool wxBitmapHandler::Load(wxGDIImage
*image
,
1558 const wxString
& name
,
1560 int width
, int height
)
1562 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1564 return bitmap
&& LoadFile(bitmap
, name
, flags
, width
, height
);
1567 bool wxBitmapHandler::Save(wxGDIImage
*image
,
1568 const wxString
& name
,
1571 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1573 return bitmap
&& SaveFile(bitmap
, name
, type
);
1576 bool wxBitmapHandler::Create(wxBitmap
*WXUNUSED(bitmap
),
1577 const void* WXUNUSED(data
),
1578 long WXUNUSED(type
),
1579 int WXUNUSED(width
),
1580 int WXUNUSED(height
),
1581 int WXUNUSED(depth
))
1586 bool wxBitmapHandler::LoadFile(wxBitmap
*WXUNUSED(bitmap
),
1587 const wxString
& WXUNUSED(name
),
1588 long WXUNUSED(type
),
1589 int WXUNUSED(desiredWidth
),
1590 int WXUNUSED(desiredHeight
))
1595 bool wxBitmapHandler::SaveFile(wxBitmap
*WXUNUSED(bitmap
),
1596 const wxString
& WXUNUSED(name
),
1598 const wxPalette
*WXUNUSED(palette
))
1603 // ----------------------------------------------------------------------------
1604 // global helper functions implemented here
1605 // ----------------------------------------------------------------------------
1607 // helper of wxBitmapToHICON/HCURSOR
1609 HICON
wxBitmapToIconOrCursor(const wxBitmap
& bmp
,
1616 // we can't create an icon/cursor form nothing
1620 if ( bmp
.HasAlpha() )
1622 // Create an empty mask bitmap.
1623 // it doesn't seem to work if we mess with the mask at all.
1624 HBITMAP hMonoBitmap
= CreateBitmap(bmp
.GetWidth(),bmp
.GetHeight(),1,1,NULL
);
1627 wxZeroMemory(iconInfo
);
1628 iconInfo
.fIcon
= iconWanted
; // do we want an icon or a cursor?
1631 iconInfo
.xHotspot
= hotSpotX
;
1632 iconInfo
.yHotspot
= hotSpotY
;
1635 iconInfo
.hbmMask
= hMonoBitmap
;
1636 iconInfo
.hbmColor
= GetHbitmapOf(bmp
);
1638 HICON hicon
= ::CreateIconIndirect(&iconInfo
);
1640 ::DeleteObject(hMonoBitmap
);
1645 wxMask
* mask
= bmp
.GetMask();
1649 // we must have a mask for an icon, so even if it's probably incorrect,
1650 // do create it (grey is the "standard" transparent colour)
1651 mask
= new wxMask(bmp
, *wxLIGHT_GREY
);
1655 wxZeroMemory(iconInfo
);
1656 iconInfo
.fIcon
= iconWanted
; // do we want an icon or a cursor?
1659 iconInfo
.xHotspot
= hotSpotX
;
1660 iconInfo
.yHotspot
= hotSpotY
;
1663 iconInfo
.hbmMask
= wxInvertMask((HBITMAP
)mask
->GetMaskBitmap());
1664 iconInfo
.hbmColor
= GetHbitmapOf(bmp
);
1666 // black out the transparent area to preserve background colour, because
1667 // Windows blits the original bitmap using SRCINVERT (XOR) after applying
1668 // the mask to the dest rect.
1670 MemoryHDC dcSrc
, dcDst
;
1671 SelectInHDC
selectMask(dcSrc
, (HBITMAP
)mask
->GetMaskBitmap()),
1672 selectBitmap(dcDst
, iconInfo
.hbmColor
);
1674 if ( !::BitBlt(dcDst
, 0, 0, bmp
.GetWidth(), bmp
.GetHeight(),
1675 dcSrc
, 0, 0, SRCAND
) )
1677 wxLogLastError(_T("BitBlt"));
1681 HICON hicon
= ::CreateIconIndirect(&iconInfo
);
1683 if ( !bmp
.GetMask() && !bmp
.HasAlpha() )
1685 // we created the mask, now delete it
1689 // delete the inverted mask bitmap we created as well
1690 ::DeleteObject(iconInfo
.hbmMask
);
1695 HICON
wxBitmapToHICON(const wxBitmap
& bmp
)
1697 return wxBitmapToIconOrCursor(bmp
, true, 0, 0);
1700 HCURSOR
wxBitmapToHCURSOR(const wxBitmap
& bmp
, int hotSpotX
, int hotSpotY
)
1702 return (HCURSOR
)wxBitmapToIconOrCursor(bmp
, false, hotSpotX
, hotSpotY
);
1705 HBITMAP
wxInvertMask(HBITMAP hbmpMask
, int w
, int h
)
1707 #ifndef __WXMICROWIN__
1708 wxCHECK_MSG( hbmpMask
, 0, _T("invalid bitmap in wxInvertMask") );
1710 // get width/height from the bitmap if not given
1714 ::GetObject(hbmpMask
, sizeof(BITMAP
), (LPVOID
)&bm
);
1719 HDC hdcSrc
= ::CreateCompatibleDC(NULL
);
1720 HDC hdcDst
= ::CreateCompatibleDC(NULL
);
1721 if ( !hdcSrc
|| !hdcDst
)
1723 wxLogLastError(wxT("CreateCompatibleDC"));
1726 HBITMAP hbmpInvMask
= ::CreateBitmap(w
, h
, 1, 1, 0);
1729 wxLogLastError(wxT("CreateBitmap"));
1732 HGDIOBJ srcTmp
= ::SelectObject(hdcSrc
, hbmpMask
);
1733 HGDIOBJ dstTmp
= ::SelectObject(hdcDst
, hbmpInvMask
);
1734 if ( !::BitBlt(hdcDst
, 0, 0, w
, h
,
1738 wxLogLastError(wxT("BitBlt"));
1742 SelectObject(hdcSrc
,srcTmp
);
1743 SelectObject(hdcDst
,dstTmp
);