1 ////////////////////////////////////////////////////////////////////////////
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "bitmap.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
37 #include "wx/palette.h"
38 #include "wx/dcmemory.h"
39 #include "wx/bitmap.h"
43 #include "wx/msw/private.h"
46 #if !defined(__WXMICROWIN__)
47 #include "wx/msw/dib.h"
51 #include "wx/xpmdecod.h"
53 #ifdef wxHAVE_RAW_BITMAP
54 #include "wx/rawbmp.h"
57 // missing from mingw32 header
59 #define CLR_INVALID ((COLORREF)-1)
60 #endif // no CLR_INVALID
62 // ----------------------------------------------------------------------------
64 // ----------------------------------------------------------------------------
66 class WXDLLEXPORT wxBitmapRefData
: public wxGDIImageRefData
70 virtual ~wxBitmapRefData() { Free(); }
74 // set the mask object to use as the mask, we take ownership of it
75 void SetMask(wxMask
*mask
)
81 // set the HBITMAP to use as the mask
82 void SetMask(HBITMAP hbmpMask
)
84 SetMask(new wxMask((WXHBITMAP
)hbmpMask
));
88 wxMask
*GetMask() const { return m_bitmapMask
; }
92 wxPalette m_bitmapPalette
;
93 #endif // wxUSE_PALETTE
99 // this field is solely for error checking: we detect selecting a bitmap
100 // into more than one DC at once or deleting a bitmap still selected into a
101 // DC (both are serious programming errors under Windows)
102 wxDC
*m_selectedInto
;
103 #endif // __WXDEBUG__
105 // when GetRawData() is called for a DDB we need to convert it to a DIB
106 // first to be able to provide direct access to it and we cache that DIB
107 // here and convert it back to DDB when UngetRawData() is called
110 // true if we have alpha transparency info and can be drawn using
114 // true if our HBITMAP is a DIB section, false if it is a DDB
118 // optional mask for transparent drawing
119 wxMask
*m_bitmapMask
;
121 DECLARE_NO_COPY_CLASS(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
142 static bool wxShouldCreateDIB(int w
, int h
, int d
, WXHDC hdc
)
144 // here is the logic:
146 // (a) if hdc is specified, the caller explicitly wants DDB
147 // (b) otherwise, create a DIB if depth >= 24 (we don't support 16bpp or
149 // (c) finally, create DIBs under Win9x even if the depth hasn't been
150 // explicitly specified but the current display depth is 24 or more
151 // and the image is "big", i.e. > 16Mb which is the theoretical limit
152 // for DDBs under Win9x
154 // consequences (all of which seem to make sense):
156 // (i) by default, DDBs are created (depth == -1 usually)
157 // (ii) DIBs can be created by explicitly specifying the depth
158 // (iii) using a DC always forces creating a DDB
162 wxDIB::GetLineSize(w
, wxDisplayDepth())*h
> 16*1024*1024));
165 // ----------------------------------------------------------------------------
167 // ----------------------------------------------------------------------------
169 wxBitmapRefData::wxBitmapRefData()
172 m_selectedInto
= NULL
;
176 m_hBitmap
= (WXHBITMAP
) NULL
;
183 void wxBitmapRefData::Free()
185 wxASSERT_MSG( !m_selectedInto
,
186 wxT("deleting bitmap still selected into wxMemoryDC") );
188 wxASSERT_MSG( !m_dib
, _T("forgot to call wxBitmap::UngetRawData()!") );
192 if ( !::DeleteObject((HBITMAP
)m_hBitmap
) )
194 wxLogLastError(wxT("DeleteObject(hbitmap)"));
202 // ----------------------------------------------------------------------------
204 // ----------------------------------------------------------------------------
206 // this function should be called from all wxBitmap ctors
207 void wxBitmap::Init()
209 // m_refData = NULL; done in the base class ctor
212 wxGDIImageRefData
*wxBitmap::CreateData() const
214 return new wxBitmapRefData
;
219 bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage
& icon
)
221 #ifndef __WXMICROWIN__
222 // it may be either HICON or HCURSOR
223 HICON hicon
= (HICON
)icon
.GetHandle();
226 if ( !::GetIconInfo(hicon
, &iconInfo
) )
228 wxLogLastError(wxT("GetIconInfo"));
233 wxBitmapRefData
*refData
= new wxBitmapRefData
;
236 int w
= icon
.GetWidth(),
237 h
= icon
.GetHeight();
239 refData
->m_width
= w
;
240 refData
->m_height
= h
;
241 refData
->m_depth
= wxDisplayDepth();
243 refData
->m_hBitmap
= (WXHBITMAP
)iconInfo
.hbmColor
;
245 // the mask returned by GetIconInfo() is inversed compared to the usual
247 refData
->SetMask(wxInvertMask(iconInfo
.hbmMask
, w
, h
));
250 // delete the old one now as we don't need it any more
251 ::DeleteObject(iconInfo
.hbmMask
);
253 #if WXWIN_COMPATIBILITY_2
254 refData
->m_ok
= TRUE
;
255 #endif // WXWIN_COMPATIBILITY_2
265 bool wxBitmap::CopyFromCursor(const wxCursor
& cursor
)
273 wxFAIL_MSG( _T("don't know how to convert cursor to bitmap") );
277 return CopyFromIconOrCursor(cursor
);
281 bool wxBitmap::CopyFromIcon(const wxIcon
& icon
)
288 // GetIconInfo() doesn't exist under Win16 and I don't know any other way
289 // to create a bitmap from icon there - but using this way we won't have
292 int width
= icon
.GetWidth(),
293 height
= icon
.GetHeight();
295 // copy the icon to the bitmap
297 HDC hdc
= ::CreateCompatibleDC(hdcScreen
);
298 HBITMAP hbitmap
= ::CreateCompatibleBitmap(hdcScreen
, width
, height
);
299 HBITMAP hbmpOld
= (HBITMAP
)::SelectObject(hdc
, hbitmap
);
301 ::DrawIcon(hdc
, 0, 0, GetHiconOf(icon
));
303 ::SelectObject(hdc
, hbmpOld
);
306 wxBitmapRefData
*refData
= new wxBitmapRefData
;
309 refData
->m_width
= width
;
310 refData
->m_height
= height
;
311 refData
->m_depth
= wxDisplayDepth();
313 refData
->m_hBitmap
= (WXHBITMAP
)hbitmap
;
315 #if WXWIN_COMPATIBILITY_2
316 refData
->m_ok
= TRUE
;
317 #endif // WXWIN_COMPATIBILITY_2
321 return CopyFromIconOrCursor(icon
);
322 #endif // Win16/Win32
325 bool wxBitmap::CopyFromDIB(const wxDIB
& dib
)
327 wxCHECK_MSG( dib
.IsOk(), FALSE
, _T("invalid DIB in CopyFromDIB") );
329 HBITMAP hbitmap
= dib
.CreateDDB();
335 wxBitmapRefData
*refData
= new wxBitmapRefData
;
338 refData
->m_width
= dib
.GetWidth();
339 refData
->m_height
= dib
.GetHeight();
340 refData
->m_depth
= dib
.GetDepth();
342 refData
->m_hBitmap
= (WXHBITMAP
)hbitmap
;
345 wxPalette
*palette
= dib
.CreatePalette();
348 refData
->m_bitmapPalette
= *palette
;
352 #endif // wxUSE_PALETTE
357 wxBitmap::~wxBitmap()
361 wxBitmap::wxBitmap(const char bits
[], int width
, int height
, int depth
)
365 #ifndef __WXMICROWIN__
366 wxBitmapRefData
*refData
= new wxBitmapRefData
;
369 refData
->m_width
= width
;
370 refData
->m_height
= height
;
371 refData
->m_depth
= depth
;
376 // we assume that it is in XBM format which is not quite the same as
377 // the format CreateBitmap() wants because the order of bytes in the
379 const size_t bytesPerLine
= (width
+ 7) / 8;
380 const size_t padding
= bytesPerLine
% 2;
381 const size_t len
= height
* ( padding
+ bytesPerLine
);
382 data
= (char *)malloc(len
);
383 const char *src
= bits
;
386 for ( int rows
= 0; rows
< height
; rows
++ )
388 for ( size_t cols
= 0; cols
< bytesPerLine
; cols
++ )
390 unsigned char val
= *src
++;
391 unsigned char reversed
= 0;
393 for ( int bits
= 0; bits
< 8; bits
++)
396 reversed
|= (val
& 0x01);
408 // bits should already be in Windows standard format
409 data
= (char *)bits
; // const_cast is harmless
412 HBITMAP hbmp
= ::CreateBitmap(width
, height
, 1, depth
, data
);
415 wxLogLastError(wxT("CreateBitmap"));
423 SetHBITMAP((WXHBITMAP
)hbmp
);
427 // Create from XPM data
428 bool wxBitmap::CreateFromXpm(const char **data
)
430 #if wxUSE_IMAGE && wxUSE_XPM
433 wxCHECK_MSG( data
!= NULL
, FALSE
, wxT("invalid bitmap data") )
435 wxXPMDecoder decoder
;
436 wxImage img
= decoder
.ReadData(data
);
437 wxCHECK_MSG( img
.Ok(), FALSE
, wxT("invalid bitmap data") )
439 *this = wxBitmap(img
);
446 wxBitmap::wxBitmap(int w
, int h
, int d
)
450 (void)Create(w
, h
, d
);
453 wxBitmap::wxBitmap(int w
, int h
, const wxDC
& dc
)
457 (void)Create(w
, h
, dc
);
460 wxBitmap::wxBitmap(void *data
, long type
, int width
, int height
, int depth
)
464 (void)Create(data
, type
, width
, height
, depth
);
467 wxBitmap::wxBitmap(const wxString
& filename
, wxBitmapType type
)
471 LoadFile(filename
, (int)type
);
474 bool wxBitmap::Create(int width
, int height
, int depth
)
476 return DoCreate(width
, height
, depth
, 0);
479 bool wxBitmap::Create(int width
, int height
, const wxDC
& dc
)
481 wxCHECK_MSG( dc
.Ok(), FALSE
, _T("invalid HDC in wxBitmap::Create()") );
483 return DoCreate(width
, height
, -1, dc
.GetHDC());
486 bool wxBitmap::DoCreate(int w
, int h
, int d
, WXHDC hdc
)
490 m_refData
= new wxBitmapRefData
;
492 GetBitmapData()->m_width
= w
;
493 GetBitmapData()->m_height
= h
;
497 if ( wxShouldCreateDIB(w
, h
, d
, hdc
) )
501 // create DIBs without alpha channel by default
509 // don't delete the DIB section in dib object dtor
512 GetBitmapData()->m_isDIB
= TRUE
;
513 GetBitmapData()->m_depth
= d
;
518 d
= wxDisplayDepth();
520 GetBitmapData()->m_depth
= d
;
522 #ifndef __WXMICROWIN__
525 hbmp
= ::CreateBitmap(w
, h
, 1, d
, NULL
);
528 wxLogLastError(wxT("CreateBitmap"));
532 #endif // !__WXMICROWIN__
535 hbmp
= ::CreateCompatibleBitmap(dc
, w
, h
);
538 wxLogLastError(wxT("CreateCompatibleBitmap"));
541 GetBitmapData()->m_depth
= wxDisplayDepth();
545 SetHBITMAP((WXHBITMAP
)hbmp
);
547 #if WXWIN_COMPATIBILITY_2
548 GetBitmapData()->m_ok
= hbmp
!= 0;
549 #endif // WXWIN_COMPATIBILITY_2
556 // ----------------------------------------------------------------------------
557 // wxImage to/from conversions for Microwin
558 // ----------------------------------------------------------------------------
560 // Microwin versions are so different from normal ones that it really doesn't
561 // make sense to use #ifdefs inside the function bodies
562 #ifdef __WXMICROWIN__
564 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
, const wxDC
& dc
)
566 // Set this to 1 to experiment with mask code,
567 // which currently doesn't work
570 m_refData
= new wxBitmapRefData();
572 // Initial attempt at a simple-minded implementation.
573 // The bitmap will always be created at the screen depth,
574 // so the 'depth' argument is ignored.
576 HDC hScreenDC
= ::GetDC(NULL
);
577 int screenDepth
= ::GetDeviceCaps(hScreenDC
, BITSPIXEL
);
579 HBITMAP hBitmap
= ::CreateCompatibleBitmap(hScreenDC
, image
.GetWidth(), image
.GetHeight());
580 HBITMAP hMaskBitmap
= NULL
;
581 HBITMAP hOldMaskBitmap
= NULL
;
583 unsigned char maskR
= 0;
584 unsigned char maskG
= 0;
585 unsigned char maskB
= 0;
587 // printf("Created bitmap %d\n", (int) hBitmap);
590 ::ReleaseDC(NULL
, hScreenDC
);
593 HDC hMemDC
= ::CreateCompatibleDC(hScreenDC
);
595 HBITMAP hOldBitmap
= ::SelectObject(hMemDC
, hBitmap
);
596 ::ReleaseDC(NULL
, hScreenDC
);
598 // created an mono-bitmap for the possible mask
599 bool hasMask
= image
.HasMask();
604 // FIXME: we should be able to pass bpp = 1, but
605 // GdBlit can't handle a different depth
607 hMaskBitmap
= ::CreateBitmap( (WORD
)image
.GetWidth(), (WORD
)image
.GetHeight(), 1, 1, NULL
);
609 hMaskBitmap
= ::CreateCompatibleBitmap( hMemDC
, (WORD
)image
.GetWidth(), (WORD
)image
.GetHeight());
611 maskR
= image
.GetMaskRed();
612 maskG
= image
.GetMaskGreen();
613 maskB
= image
.GetMaskBlue();
621 hScreenDC
= ::GetDC(NULL
);
622 hMaskDC
= ::CreateCompatibleDC(hScreenDC
);
623 ::ReleaseDC(NULL
, hScreenDC
);
625 hOldMaskBitmap
= ::SelectObject( hMaskDC
, hMaskBitmap
);
633 for (i
= 0; i
< image
.GetWidth(); i
++)
635 for (j
= 0; j
< image
.GetHeight(); j
++)
637 unsigned char red
= image
.GetRed(i
, j
);
638 unsigned char green
= image
.GetGreen(i
, j
);
639 unsigned char blue
= image
.GetBlue(i
, j
);
641 ::SetPixel(hMemDC
, i
, j
, PALETTERGB(red
, green
, blue
));
645 // scan the bitmap for the transparent colour and set the corresponding
646 // pixels in the mask to BLACK and the rest to WHITE
647 if (maskR
== red
&& maskG
== green
&& maskB
== blue
)
648 ::SetPixel(hMaskDC
, i
, j
, PALETTERGB(0, 0, 0));
650 ::SetPixel(hMaskDC
, i
, j
, PALETTERGB(255, 255, 255));
655 ::SelectObject(hMemDC
, hOldBitmap
);
659 ::SelectObject(hMaskDC
, hOldMaskBitmap
);
662 ((wxBitmapRefData
*)m_refData
)->SetMask(hMaskBitmap
);
665 SetWidth(image
.GetWidth());
666 SetHeight(image
.GetHeight());
667 SetDepth(screenDepth
);
668 SetHBITMAP( (WXHBITMAP
) hBitmap
);
671 // Copy the palette from the source image
672 SetPalette(image
.GetPalette());
673 #endif // wxUSE_PALETTE
675 #if WXWIN_COMPATIBILITY_2
676 // check the wxBitmap object
677 GetBitmapData()->SetOk();
678 #endif // WXWIN_COMPATIBILITY_2
683 wxImage
wxBitmap::ConvertToImage() const
685 // Initial attempt at a simple-minded implementation.
686 // The bitmap will always be created at the screen depth,
687 // so the 'depth' argument is ignored.
688 // TODO: transparency (create a mask image)
692 wxFAIL_MSG( wxT("bitmap is invalid") );
698 wxCHECK_MSG( Ok(), wxNullImage
, wxT("invalid bitmap") );
700 // create an wxImage object
701 int width
= GetWidth();
702 int height
= GetHeight();
703 image
.Create( width
, height
);
704 unsigned char *data
= image
.GetData();
707 wxFAIL_MSG( wxT("could not allocate data for image") );
711 HDC hScreenDC
= ::GetDC(NULL
);
713 HDC hMemDC
= ::CreateCompatibleDC(hScreenDC
);
714 ::ReleaseDC(NULL
, hScreenDC
);
716 HBITMAP hBitmap
= (HBITMAP
) GetHBITMAP();
718 HBITMAP hOldBitmap
= ::SelectObject(hMemDC
, hBitmap
);
721 for (i
= 0; i
< GetWidth(); i
++)
723 for (j
= 0; j
< GetHeight(); j
++)
725 COLORREF color
= ::GetPixel(hMemDC
, i
, j
);
726 unsigned char red
= GetRValue(color
);
727 unsigned char green
= GetGValue(color
);
728 unsigned char blue
= GetBValue(color
);
730 image
.SetRGB(i
, j
, red
, green
, blue
);
734 ::SelectObject(hMemDC
, hOldBitmap
);
738 // Copy the palette from the source image
740 image
.SetPalette(* GetPalette());
741 #endif // wxUSE_PALETTE
746 #endif // __WXMICROWIN__
748 // ----------------------------------------------------------------------------
749 // wxImage to/from conversions
750 // ----------------------------------------------------------------------------
752 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
)
754 return CreateFromImage(image
, depth
, 0);
757 bool wxBitmap::CreateFromImage(const wxImage
& image
, const wxDC
& dc
)
759 wxCHECK_MSG( dc
.Ok(), FALSE
,
760 _T("invalid HDC in wxBitmap::CreateFromImage()") );
762 return CreateFromImage(image
, -1, dc
.GetHDC());
765 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
, WXHDC hdc
)
767 wxCHECK_MSG( image
.Ok(), FALSE
, wxT("invalid image") );
771 // first convert the image to DIB
772 const int h
= image
.GetHeight();
773 const int w
= image
.GetWidth();
780 // store the bitmap parameters
781 wxBitmapRefData
*refData
= new wxBitmapRefData
;
782 refData
->m_width
= w
;
783 refData
->m_height
= h
;
784 refData
->m_hasAlpha
= image
.HasAlpha();
789 // next either store DIB as is or create a DDB from it
792 // are we going to use DIB?
794 // NB: DDBs don't support alpha so if we have alpha channel we must use DIB
795 if ( image
.HasAlpha() || wxShouldCreateDIB(w
, h
, depth
, hdc
) )
797 // don't delete the DIB section in dib object dtor
798 hbitmap
= dib
.Detach();
800 refData
->m_isDIB
= TRUE
;
801 refData
->m_depth
= dib
.GetDepth();
803 else // we need to convert DIB to DDB
805 hbitmap
= dib
.CreateDDB((HDC
)hdc
);
807 refData
->m_depth
= depth
== -1 ? wxDisplayDepth() : depth
;
810 // validate this object
811 SetHBITMAP((WXHBITMAP
)hbitmap
);
813 #if WXWIN_COMPATIBILITY_2
814 m_refData
->m_ok
= TRUE
;
815 #endif // WXWIN_COMPATIBILITY_2
817 // finally also set the mask if we have one
818 if ( image
.HasMask() )
820 SetMask(new wxMask(*this, wxColour(image
.GetMaskRed(),
821 image
.GetMaskGreen(),
822 image
.GetMaskBlue())));
828 wxImage
wxBitmap::ConvertToImage() const
832 wxCHECK_MSG( Ok(), wxNullImage
, wxT("invalid bitmap") );
834 // create an wxImage object
835 int width
= GetWidth();
836 int height
= GetHeight();
837 image
.Create( width
, height
);
838 unsigned char *data
= image
.GetData();
841 wxFAIL_MSG( wxT("could not allocate data for image") );
845 // calc the number of bytes per scanline and padding in the DIB
846 int bytePerLine
= width
*3;
847 int sizeDWORD
= sizeof( DWORD
);
848 int lineBoundary
= bytePerLine
% sizeDWORD
;
850 if( lineBoundary
> 0 )
852 padding
= sizeDWORD
- lineBoundary
;
853 bytePerLine
+= padding
;
856 // create a DIB header
857 int headersize
= sizeof(BITMAPINFOHEADER
);
858 BITMAPINFO
*lpDIBh
= (BITMAPINFO
*) malloc( headersize
);
861 wxFAIL_MSG( wxT("could not allocate data for DIB header") );
865 // Fill in the DIB header
866 lpDIBh
->bmiHeader
.biSize
= headersize
;
867 lpDIBh
->bmiHeader
.biWidth
= width
;
868 lpDIBh
->bmiHeader
.biHeight
= -height
;
869 lpDIBh
->bmiHeader
.biSizeImage
= bytePerLine
* height
;
870 lpDIBh
->bmiHeader
.biPlanes
= 1;
871 lpDIBh
->bmiHeader
.biBitCount
= 24;
872 lpDIBh
->bmiHeader
.biCompression
= BI_RGB
;
873 lpDIBh
->bmiHeader
.biClrUsed
= 0;
874 // These seem not really needed for our purpose here.
875 lpDIBh
->bmiHeader
.biClrImportant
= 0;
876 lpDIBh
->bmiHeader
.biXPelsPerMeter
= 0;
877 lpDIBh
->bmiHeader
.biYPelsPerMeter
= 0;
878 // memory for DIB data
879 unsigned char *lpBits
;
880 lpBits
= (unsigned char *) malloc( lpDIBh
->bmiHeader
.biSizeImage
);
883 wxFAIL_MSG( wxT("could not allocate data for DIB") );
889 // copy data from the device-dependent bitmap to the DIB
890 HDC hdc
= ::GetDC(NULL
);
892 hbitmap
= (HBITMAP
) GetHBITMAP();
893 ::GetDIBits( hdc
, hbitmap
, 0, height
, lpBits
, lpDIBh
, DIB_RGB_COLORS
);
895 // copy DIB data into the wxImage object
897 unsigned char *ptdata
= data
;
898 unsigned char *ptbits
= lpBits
;
899 for( i
=0; i
<height
; i
++ )
901 for( j
=0; j
<width
; j
++ )
903 *(ptdata
++) = *(ptbits
+2);
904 *(ptdata
++) = *(ptbits
+1);
905 *(ptdata
++) = *(ptbits
);
911 // similarly, set data according to the possible mask bitmap
912 if( GetMask() && GetMask()->GetMaskBitmap() )
914 hbitmap
= (HBITMAP
) GetMask()->GetMaskBitmap();
915 // memory DC created, color set, data copied, and memory DC deleted
916 HDC memdc
= ::CreateCompatibleDC( hdc
);
917 ::SetTextColor( memdc
, RGB( 0, 0, 0 ) );
918 ::SetBkColor( memdc
, RGB( 255, 255, 255 ) );
919 ::GetDIBits( memdc
, hbitmap
, 0, height
, lpBits
, lpDIBh
, DIB_RGB_COLORS
);
921 // background color set to RGB(16,16,16) in consistent with wxGTK
922 unsigned char r
=16, g
=16, b
=16;
925 for( i
=0; i
<height
; i
++ )
927 for( j
=0; j
<width
; j
++ )
941 image
.SetMaskColour( r
, g
, b
);
942 image
.SetMask( TRUE
);
946 image
.SetMask( FALSE
);
948 // free allocated resources
949 ::ReleaseDC(NULL
, hdc
);
956 #endif // wxUSE_IMAGE
958 // ----------------------------------------------------------------------------
959 // loading and saving bitmaps
960 // ----------------------------------------------------------------------------
962 bool wxBitmap::LoadFile(const wxString
& filename
, long type
)
966 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
970 m_refData
= new wxBitmapRefData
;
972 return handler
->LoadFile(this, filename
, type
, -1, -1);
978 if ( image
.LoadFile( filename
, type
) && image
.Ok() )
980 *this = wxBitmap(image
);
985 #endif // wxUSE_IMAGE
990 bool wxBitmap::Create(void *data
, long type
, int width
, int height
, int depth
)
994 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
998 wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %ld defined."), type
);
1003 m_refData
= new wxBitmapRefData
;
1005 return handler
->Create(this, data
, type
, width
, height
, depth
);
1008 bool wxBitmap::SaveFile(const wxString
& filename
,
1010 const wxPalette
*palette
)
1012 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
1016 return handler
->SaveFile(this, filename
, type
, palette
);
1021 // FIXME what about palette? shouldn't we use it?
1022 wxImage image
= ConvertToImage();
1025 return image
.SaveFile(filename
, type
);
1028 #endif // wxUSE_IMAGE
1033 // ----------------------------------------------------------------------------
1034 // sub bitmap extraction
1035 // ----------------------------------------------------------------------------
1037 wxBitmap
wxBitmap::GetSubBitmap( const wxRect
& rect
) const
1039 wxCHECK_MSG( Ok() &&
1040 (rect
.x
>= 0) && (rect
.y
>= 0) &&
1041 (rect
.x
+rect
.width
<= GetWidth()) &&
1042 (rect
.y
+rect
.height
<= GetHeight()),
1043 wxNullBitmap
, wxT("Invalid bitmap or bitmap region") );
1045 wxBitmap
ret( rect
.width
, rect
.height
);
1046 wxASSERT_MSG( ret
.Ok(), wxT("GetSubBitmap error") );
1048 #ifndef __WXMICROWIN__
1049 // TODO: copy alpha channel data if any
1056 SelectInHDC
selectSrc(dcSrc
, GetHbitmap()),
1057 selectDst(dcDst
, GetHbitmapOf(ret
));
1059 if ( !selectSrc
|| !selectDst
)
1061 wxLogLastError(_T("SelectObjct(hBitmap)"));
1064 if ( !::BitBlt(dcDst
, 0, 0, rect
.width
, rect
.height
,
1065 dcSrc
, rect
.x
, rect
.y
, SRCCOPY
) )
1067 wxLogLastError(_T("BitBlt"));
1071 // copy mask if there is one
1074 HBITMAP hbmpMask
= ::CreateBitmap(rect
.width
, rect
.height
, 1, 1, 0);
1076 SelectInHDC
selectSrc(dcSrc
, (HBITMAP
) GetMask()->GetMaskBitmap()),
1077 selectDst(dcDst
, hbmpMask
);
1079 if ( !::BitBlt(dcDst
, 0, 0, rect
.width
, rect
.height
,
1080 dcSrc
, rect
.x
, rect
.y
, SRCCOPY
) )
1082 wxLogLastError(_T("BitBlt"));
1085 wxMask
*mask
= new wxMask((WXHBITMAP
) hbmpMask
);
1088 #endif // !__WXMICROWIN__
1093 // ----------------------------------------------------------------------------
1094 // wxBitmap accessors
1095 // ----------------------------------------------------------------------------
1098 wxPalette
* wxBitmap::GetPalette() const
1100 return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette
1101 : (wxPalette
*) NULL
;
1105 wxMask
*wxBitmap::GetMask() const
1107 return GetBitmapData() ? GetBitmapData()->GetMask() : (wxMask
*) NULL
;
1112 wxDC
*wxBitmap::GetSelectedInto() const
1114 return GetBitmapData() ? GetBitmapData()->m_selectedInto
: (wxDC
*) NULL
;
1119 #if WXWIN_COMPATIBILITY_2_4
1121 int wxBitmap::GetQuality() const
1126 #endif // WXWIN_COMPATIBILITY_2_4
1128 void wxBitmap::UseAlpha()
1130 if ( GetBitmapData() )
1131 GetBitmapData()->m_hasAlpha
= true;
1134 bool wxBitmap::HasAlpha() const
1136 return GetBitmapData() && GetBitmapData()->m_hasAlpha
;
1139 // ----------------------------------------------------------------------------
1141 // ----------------------------------------------------------------------------
1145 void wxBitmap::SetSelectedInto(wxDC
*dc
)
1147 if ( GetBitmapData() )
1148 GetBitmapData()->m_selectedInto
= dc
;
1155 void wxBitmap::SetPalette(const wxPalette
& palette
)
1159 GetBitmapData()->m_bitmapPalette
= palette
;
1162 #endif // wxUSE_PALETTE
1164 void wxBitmap::SetMask(wxMask
*mask
)
1168 GetBitmapData()->SetMask(mask
);
1171 #if WXWIN_COMPATIBILITY_2
1173 void wxBitmap::SetOk(bool isOk
)
1177 GetBitmapData()->m_ok
= isOk
;
1180 #endif // WXWIN_COMPATIBILITY_2
1182 #if WXWIN_COMPATIBILITY_2_4
1184 void wxBitmap::SetQuality(int WXUNUSED(quality
))
1188 #endif // WXWIN_COMPATIBILITY_2_4
1190 // ----------------------------------------------------------------------------
1191 // raw bitmap access support
1192 // ----------------------------------------------------------------------------
1194 #ifdef wxHAVE_RAW_BITMAP
1195 void *wxBitmap::GetRawData(wxPixelDataBase
& data
, int bpp
)
1199 // no bitmap, no data (raw or otherwise)
1203 // if we're already a DIB we can access our data directly, but if not we
1204 // need to convert this DDB to a DIB section and use it for raw access and
1205 // then convert it back
1207 if ( !GetBitmapData()->m_isDIB
)
1209 wxCHECK_MSG( !GetBitmapData()->m_dib
, FALSE
,
1210 _T("GetRawData() may be called only once") );
1212 wxDIB
*dib
= new wxDIB(*this);
1220 // we'll free it in UngetRawData()
1221 GetBitmapData()->m_dib
= dib
;
1223 hDIB
= dib
->GetHandle();
1227 hDIB
= GetHbitmap();
1231 if ( ::GetObject(hDIB
, sizeof(ds
), &ds
) != sizeof(DIBSECTION
) )
1233 wxFAIL_MSG( _T("failed to get DIBSECTION from a DIB?") );
1238 // check that the bitmap is in correct format
1239 if ( ds
.dsBm
.bmBitsPixel
!= bpp
)
1241 wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
1246 // ok, store the relevant info in wxPixelDataBase
1247 const LONG h
= ds
.dsBm
.bmHeight
;
1249 data
.m_width
= ds
.dsBm
.bmWidth
;
1252 // remember that DIBs are stored in top to bottom order!
1253 const LONG bytesPerRow
= ds
.dsBm
.bmWidthBytes
;
1254 data
.m_stride
= -bytesPerRow
;
1256 char *bits
= (char *)ds
.dsBm
.bmBits
;
1259 bits
+= (h
- 1)*bytesPerRow
;
1265 void wxBitmap::UngetRawData(wxPixelDataBase
& dataBase
)
1270 // the cast is ugly but we can't do without it and without making this
1271 // function template (and hence inline) unfortunately
1272 typedef wxPixelData
<wxBitmap
, wxAlphaPixelFormat
> PixelData
;
1273 PixelData
& data
= (PixelData
&)dataBase
;
1277 // invalid data, don't crash -- but don't assert neither as we're
1278 // called automatically from wxPixelDataBase dtor and so there is no
1279 // way to prevent this from happening
1283 if ( GetBitmapData()->m_hasAlpha
)
1285 // AlphaBlend() wants to have premultiplied source alpha but
1286 // wxRawBitmap API uses normal, not premultiplied, colours, so adjust
1288 PixelData::Iterator
p(data
);
1290 const int w
= data
.GetWidth();
1291 const int h
= data
.GetHeight();
1293 for ( int y
= 0; y
< h
; y
++ )
1295 PixelData::Iterator rowStart
= p
;
1297 for ( int x
= 0; x
< w
; x
++ )
1299 const unsigned alpha
= p
.Alpha();
1301 p
.Red() = (p
.Red() * alpha
+ 127) / 255;
1302 p
.Blue() = (p
.Blue() * alpha
+ 127) / 255;
1303 p
.Green() = (p
.Green() * alpha
+ 127) / 255;
1312 // if we're a DDB we need to convert DIB back to DDB now to make the
1313 // changes made via raw bitmap access effective
1314 if ( !GetBitmapData()->m_isDIB
)
1316 wxDIB
*dib
= GetBitmapData()->m_dib
;
1317 GetBitmapData()->m_dib
= NULL
;
1325 #endif // #ifdef wxHAVE_RAW_BITMAP
1327 // ----------------------------------------------------------------------------
1329 // ----------------------------------------------------------------------------
1336 // Construct a mask from a bitmap and a colour indicating
1337 // the transparent area
1338 wxMask::wxMask(const wxBitmap
& bitmap
, const wxColour
& colour
)
1341 Create(bitmap
, colour
);
1344 // Construct a mask from a bitmap and a palette index indicating
1345 // the transparent area
1346 wxMask::wxMask(const wxBitmap
& bitmap
, int paletteIndex
)
1349 Create(bitmap
, paletteIndex
);
1352 // Construct a mask from a mono bitmap (copies the bitmap).
1353 wxMask::wxMask(const wxBitmap
& bitmap
)
1362 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1365 // Create a mask from a mono bitmap (copies the bitmap).
1366 bool wxMask::Create(const wxBitmap
& bitmap
)
1368 #ifndef __WXMICROWIN__
1369 wxCHECK_MSG( bitmap
.Ok() && bitmap
.GetDepth() == 1, FALSE
,
1370 _T("can't create mask from invalid or not monochrome bitmap") );
1374 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1378 m_maskBitmap
= (WXHBITMAP
) CreateBitmap(
1383 HDC srcDC
= CreateCompatibleDC(0);
1384 SelectObject(srcDC
, (HBITMAP
) bitmap
.GetHBITMAP());
1385 HDC destDC
= CreateCompatibleDC(0);
1386 SelectObject(destDC
, (HBITMAP
) m_maskBitmap
);
1387 BitBlt(destDC
, 0, 0, bitmap
.GetWidth(), bitmap
.GetHeight(), srcDC
, 0, 0, SRCCOPY
);
1388 SelectObject(srcDC
, 0);
1390 SelectObject(destDC
, 0);
1398 // Create a mask from a bitmap and a palette index indicating
1399 // the transparent area
1400 bool wxMask::Create(const wxBitmap
& bitmap
, int paletteIndex
)
1404 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1409 if (bitmap
.Ok() && bitmap
.GetPalette()->Ok())
1411 unsigned char red
, green
, blue
;
1412 if (bitmap
.GetPalette()->GetRGB(paletteIndex
, &red
, &green
, &blue
))
1414 wxColour
transparentColour(red
, green
, blue
);
1415 return Create(bitmap
, transparentColour
);
1418 #endif // wxUSE_PALETTE
1423 // Create a mask from a bitmap and a colour indicating
1424 // the transparent area
1425 bool wxMask::Create(const wxBitmap
& bitmap
, const wxColour
& colour
)
1427 #ifndef __WXMICROWIN__
1428 wxCHECK_MSG( bitmap
.Ok(), FALSE
, _T("invalid bitmap in wxMask::Create") );
1432 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1436 int width
= bitmap
.GetWidth(),
1437 height
= bitmap
.GetHeight();
1439 // scan the bitmap for the transparent colour and set the corresponding
1440 // pixels in the mask to BLACK and the rest to WHITE
1441 COLORREF maskColour
= wxColourToPalRGB(colour
);
1442 m_maskBitmap
= (WXHBITMAP
)::CreateBitmap(width
, height
, 1, 1, 0);
1444 HDC srcDC
= ::CreateCompatibleDC(NULL
);
1445 HDC destDC
= ::CreateCompatibleDC(NULL
);
1446 if ( !srcDC
|| !destDC
)
1448 wxLogLastError(wxT("CreateCompatibleDC"));
1453 // SelectObject() will fail
1454 wxASSERT_MSG( !bitmap
.GetSelectedInto(),
1455 _T("bitmap can't be selected in another DC") );
1457 HGDIOBJ hbmpSrcOld
= ::SelectObject(srcDC
, GetHbitmapOf(bitmap
));
1460 wxLogLastError(wxT("SelectObject"));
1465 HGDIOBJ hbmpDstOld
= ::SelectObject(destDC
, (HBITMAP
)m_maskBitmap
);
1468 wxLogLastError(wxT("SelectObject"));
1475 // this will create a monochrome bitmap with 0 points for the pixels
1476 // which have the same value as the background colour and 1 for the
1478 ::SetBkColor(srcDC
, maskColour
);
1479 ::BitBlt(destDC
, 0, 0, width
, height
, srcDC
, 0, 0, NOTSRCCOPY
);
1482 ::SelectObject(srcDC
, hbmpSrcOld
);
1484 ::SelectObject(destDC
, hbmpDstOld
);
1488 #else // __WXMICROWIN__
1490 #endif // __WXMICROWIN__/!__WXMICROWIN__
1493 // ----------------------------------------------------------------------------
1495 // ----------------------------------------------------------------------------
1497 bool wxBitmapHandler::Create(wxGDIImage
*image
,
1500 int width
, int height
, int depth
)
1502 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1504 return bitmap
? Create(bitmap
, data
, flags
, width
, height
, depth
) : FALSE
;
1507 bool wxBitmapHandler::Load(wxGDIImage
*image
,
1508 const wxString
& name
,
1510 int width
, int height
)
1512 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1514 return bitmap
? LoadFile(bitmap
, name
, flags
, width
, height
) : FALSE
;
1517 bool wxBitmapHandler::Save(wxGDIImage
*image
,
1518 const wxString
& name
,
1521 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1523 return bitmap
? SaveFile(bitmap
, name
, type
) : FALSE
;
1526 bool wxBitmapHandler::Create(wxBitmap
*WXUNUSED(bitmap
),
1527 void *WXUNUSED(data
),
1528 long WXUNUSED(type
),
1529 int WXUNUSED(width
),
1530 int WXUNUSED(height
),
1531 int WXUNUSED(depth
))
1536 bool wxBitmapHandler::LoadFile(wxBitmap
*WXUNUSED(bitmap
),
1537 const wxString
& WXUNUSED(name
),
1538 long WXUNUSED(type
),
1539 int WXUNUSED(desiredWidth
),
1540 int WXUNUSED(desiredHeight
))
1545 bool wxBitmapHandler::SaveFile(wxBitmap
*WXUNUSED(bitmap
),
1546 const wxString
& WXUNUSED(name
),
1548 const wxPalette
*WXUNUSED(palette
))
1553 // ----------------------------------------------------------------------------
1555 // ----------------------------------------------------------------------------
1557 #ifndef __WXMICROWIN__
1558 bool wxCreateDIB(long xSize
, long ySize
, long bitsPerPixel
,
1559 HPALETTE hPal
, LPBITMAPINFO
* lpDIBHeader
)
1561 unsigned long i
, headerSize
;
1562 LPBITMAPINFO lpDIBheader
= NULL
;
1563 LPPALETTEENTRY lpPe
= NULL
;
1566 // Allocate space for a DIB header
1567 headerSize
= (sizeof(BITMAPINFOHEADER
) + (256 * sizeof(PALETTEENTRY
)));
1568 lpDIBheader
= (BITMAPINFO
*) malloc(headerSize
);
1569 lpPe
= (PALETTEENTRY
*)((BYTE
*)lpDIBheader
+ sizeof(BITMAPINFOHEADER
));
1571 GetPaletteEntries(hPal
, 0, 256, lpPe
);
1573 memset(lpDIBheader
, 0x00, sizeof(BITMAPINFOHEADER
));
1575 // Fill in the static parts of the DIB header
1576 lpDIBheader
->bmiHeader
.biSize
= sizeof(BITMAPINFOHEADER
);
1577 lpDIBheader
->bmiHeader
.biWidth
= xSize
;
1578 lpDIBheader
->bmiHeader
.biHeight
= ySize
;
1579 lpDIBheader
->bmiHeader
.biPlanes
= 1;
1581 // this value must be 1, 4, 8 or 24 so PixelDepth can only be
1582 lpDIBheader
->bmiHeader
.biBitCount
= (WORD
)(bitsPerPixel
);
1583 lpDIBheader
->bmiHeader
.biCompression
= BI_RGB
;
1584 lpDIBheader
->bmiHeader
.biSizeImage
= xSize
* abs(ySize
) * bitsPerPixel
>> 3;
1585 lpDIBheader
->bmiHeader
.biClrUsed
= 256;
1588 // Initialize the DIB palette
1589 for (i
= 0; i
< 256; i
++) {
1590 lpDIBheader
->bmiColors
[i
].rgbReserved
= lpPe
[i
].peFlags
;
1591 lpDIBheader
->bmiColors
[i
].rgbRed
= lpPe
[i
].peRed
;
1592 lpDIBheader
->bmiColors
[i
].rgbGreen
= lpPe
[i
].peGreen
;
1593 lpDIBheader
->bmiColors
[i
].rgbBlue
= lpPe
[i
].peBlue
;
1596 *lpDIBHeader
= lpDIBheader
;
1601 void wxFreeDIB(LPBITMAPINFO lpDIBHeader
)
1607 // ----------------------------------------------------------------------------
1608 // global helper functions implemented here
1609 // ----------------------------------------------------------------------------
1611 // helper of wxBitmapToHICON/HCURSOR
1613 HICON
wxBitmapToIconOrCursor(const wxBitmap
& bmp
,
1620 // we can't create an icon/cursor form nothing
1624 wxMask
*mask
= bmp
.GetMask();
1627 // we must have a mask for an icon, so even if it's probably incorrect,
1628 // do create it (grey is the "standard" transparent colour)
1629 mask
= new wxMask(bmp
, *wxLIGHT_GREY
);
1633 iconInfo
.fIcon
= iconWanted
; // do we want an icon or a cursor?
1636 iconInfo
.xHotspot
= hotSpotX
;
1637 iconInfo
.yHotspot
= hotSpotY
;
1640 iconInfo
.hbmMask
= wxInvertMask((HBITMAP
)mask
->GetMaskBitmap());
1641 iconInfo
.hbmColor
= GetHbitmapOf(bmp
);
1643 // black out the transparent area to preserve background colour, because
1644 // Windows blits the original bitmap using SRCINVERT (XOR) after applying
1645 // the mask to the dest rect.
1647 MemoryHDC dcSrc
, dcDst
;
1648 SelectInHDC
selectMask(dcSrc
, (HBITMAP
)mask
->GetMaskBitmap()),
1649 selectBitmap(dcDst
, iconInfo
.hbmColor
);
1651 if ( !::BitBlt(dcDst
, 0, 0, bmp
.GetWidth(), bmp
.GetHeight(),
1652 dcSrc
, 0, 0, SRCAND
) )
1654 wxLogLastError(_T("BitBlt"));
1658 HICON hicon
= ::CreateIconIndirect(&iconInfo
);
1660 if ( !bmp
.GetMask() )
1662 // we created the mask, now delete it
1666 // delete the inverted mask bitmap we created as well
1667 ::DeleteObject(iconInfo
.hbmMask
);
1672 HICON
wxBitmapToHICON(const wxBitmap
& bmp
)
1674 return wxBitmapToIconOrCursor(bmp
, TRUE
, 0, 0);
1677 HCURSOR
wxBitmapToHCURSOR(const wxBitmap
& bmp
, int hotSpotX
, int hotSpotY
)
1679 return (HCURSOR
)wxBitmapToIconOrCursor(bmp
, FALSE
, hotSpotX
, hotSpotY
);
1682 HBITMAP
wxInvertMask(HBITMAP hbmpMask
, int w
, int h
)
1684 #ifndef __WXMICROWIN__
1685 wxCHECK_MSG( hbmpMask
, 0, _T("invalid bitmap in wxInvertMask") );
1687 // get width/height from the bitmap if not given
1691 ::GetObject(hbmpMask
, sizeof(BITMAP
), (LPVOID
)&bm
);
1696 HDC hdcSrc
= ::CreateCompatibleDC(NULL
);
1697 HDC hdcDst
= ::CreateCompatibleDC(NULL
);
1698 if ( !hdcSrc
|| !hdcDst
)
1700 wxLogLastError(wxT("CreateCompatibleDC"));
1703 HBITMAP hbmpInvMask
= ::CreateBitmap(w
, h
, 1, 1, 0);
1706 wxLogLastError(wxT("CreateBitmap"));
1709 ::SelectObject(hdcSrc
, hbmpMask
);
1710 ::SelectObject(hdcDst
, hbmpInvMask
);
1711 if ( !::BitBlt(hdcDst
, 0, 0, w
, h
,
1715 wxLogLastError(wxT("BitBlt"));