1 ////////////////////////////////////////////////////////////////////////////
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
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"
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__
106 // when GetRawData() is called for a DDB we need to convert it to a DIB
107 // first to be able to provide direct access to it and we cache that DIB
108 // here and convert it back to DDB when UngetRawData() is called
112 // true if we have alpha transparency info and can be drawn using
116 // true if our HBITMAP is a DIB section, false if it is a DDB
120 // optional mask for transparent drawing
121 wxMask
*m_bitmapMask
;
123 DECLARE_NO_COPY_CLASS(wxBitmapRefData
)
126 // ----------------------------------------------------------------------------
128 // ----------------------------------------------------------------------------
130 IMPLEMENT_DYNAMIC_CLASS(wxBitmap
, wxGDIObject
)
131 IMPLEMENT_DYNAMIC_CLASS(wxMask
, wxObject
)
133 IMPLEMENT_DYNAMIC_CLASS(wxBitmapHandler
, wxObject
)
135 // ============================================================================
137 // ============================================================================
139 // ----------------------------------------------------------------------------
141 // ----------------------------------------------------------------------------
143 // decide whether we should create a DIB or a DDB for the given parameters
145 // NB: we always use DIBs under Windows CE as this is much simpler (even if
146 // also less efficient...) and we obviously can't use them if there is no
147 // DIB support compiled in at all
149 static inline bool wxShouldCreateDIB(int, int, int, WXHDC
) { return true; }
151 #define ALWAYS_USE_DIB
153 // no sense in defining wxShouldCreateDIB() as we can't compile code
154 // executed if it is true, so we have to use #if's anyhow
155 #define NEVER_USE_DIB
156 #else // wxUSE_WXDIB && !__WXWINCE__
157 static inline bool wxShouldCreateDIB(int w
, int h
, int d
, WXHDC hdc
)
159 // here is the logic:
161 // (a) if hdc is specified, the caller explicitly wants DDB
162 // (b) otherwise, create a DIB if depth >= 24 (we don't support 16bpp
163 // or less DIBs anyhow)
164 // (c) finally, create DIBs under Win9x even if the depth hasn't been
165 // explicitly specified but the current display depth is 24 or
166 // more and the image is "big", i.e. > 16Mb which is the
167 // theoretical limit for DDBs under Win9x
169 // consequences (all of which seem to make sense):
171 // (i) by default, DDBs are created (depth == -1 usually)
172 // (ii) DIBs can be created by explicitly specifying the depth
173 // (iii) using a DC always forces creating a DDB
177 wxDIB::GetLineSize(w
, wxDisplayDepth())*h
> 16*1024*1024));
180 #define SOMETIMES_USE_DIB
181 #endif // different DIB usage scenarious
183 // ----------------------------------------------------------------------------
185 // ----------------------------------------------------------------------------
187 wxBitmapRefData::wxBitmapRefData()
190 m_selectedInto
= NULL
;
194 m_hBitmap
= (WXHBITMAP
) NULL
;
203 void wxBitmapRefData::Free()
205 wxASSERT_MSG( !m_selectedInto
,
206 wxT("deleting bitmap still selected into wxMemoryDC") );
209 wxASSERT_MSG( !m_dib
, _T("forgot to call wxBitmap::UngetRawData()!") );
214 if ( !::DeleteObject((HBITMAP
)m_hBitmap
) )
216 wxLogLastError(wxT("DeleteObject(hbitmap)"));
224 // ----------------------------------------------------------------------------
226 // ----------------------------------------------------------------------------
228 // this function should be called from all wxBitmap ctors
229 void wxBitmap::Init()
231 // m_refData = NULL; done in the base class ctor
234 wxGDIImageRefData
*wxBitmap::CreateData() const
236 return new wxBitmapRefData
;
241 bool wxBitmap::CopyFromIconOrCursor(const wxGDIImage
& icon
)
243 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
244 // it may be either HICON or HCURSOR
245 HICON hicon
= (HICON
)icon
.GetHandle();
248 if ( !::GetIconInfo(hicon
, &iconInfo
) )
250 wxLogLastError(wxT("GetIconInfo"));
255 wxBitmapRefData
*refData
= new wxBitmapRefData
;
258 int w
= icon
.GetWidth(),
259 h
= icon
.GetHeight();
261 refData
->m_width
= w
;
262 refData
->m_height
= h
;
263 refData
->m_depth
= wxDisplayDepth();
265 refData
->m_hBitmap
= (WXHBITMAP
)iconInfo
.hbmColor
;
267 // the mask returned by GetIconInfo() is inversed compared to the usual
269 refData
->SetMask(wxInvertMask(iconInfo
.hbmMask
, w
, h
));
272 // delete the old one now as we don't need it any more
273 ::DeleteObject(iconInfo
.hbmMask
);
283 bool wxBitmap::CopyFromCursor(const wxCursor
& cursor
)
290 return CopyFromIconOrCursor(cursor
);
293 bool wxBitmap::CopyFromIcon(const wxIcon
& icon
)
300 return CopyFromIconOrCursor(icon
);
303 #ifndef NEVER_USE_DIB
305 bool wxBitmap::CopyFromDIB(const wxDIB
& dib
)
307 wxCHECK_MSG( dib
.IsOk(), FALSE
, _T("invalid DIB in CopyFromDIB") );
309 #ifdef SOMETIMES_USE_DIB
310 HBITMAP hbitmap
= dib
.CreateDDB();
313 #else // ALWAYS_USE_DIB
314 HBITMAP hbitmap
= ((wxDIB
&)dib
).Detach(); // const_cast
315 #endif // SOMETIMES_USE_DIB/ALWAYS_USE_DIB
319 wxBitmapRefData
*refData
= new wxBitmapRefData
;
322 refData
->m_width
= dib
.GetWidth();
323 refData
->m_height
= dib
.GetHeight();
324 refData
->m_depth
= dib
.GetDepth();
326 refData
->m_hBitmap
= (WXHBITMAP
)hbitmap
;
329 wxPalette
*palette
= dib
.CreatePalette();
332 refData
->m_bitmapPalette
= *palette
;
336 #endif // wxUSE_PALETTE
341 #endif // NEVER_USE_DIB
343 wxBitmap::~wxBitmap()
347 wxBitmap::wxBitmap(const char bits
[], int width
, int height
, int depth
)
351 #ifndef __WXMICROWIN__
352 wxBitmapRefData
*refData
= new wxBitmapRefData
;
355 refData
->m_width
= width
;
356 refData
->m_height
= height
;
357 refData
->m_depth
= depth
;
362 // we assume that it is in XBM format which is not quite the same as
363 // the format CreateBitmap() wants because the order of bytes in the
365 const size_t bytesPerLine
= (width
+ 7) / 8;
366 const size_t padding
= bytesPerLine
% 2;
367 const size_t len
= height
* ( padding
+ bytesPerLine
);
368 data
= (char *)malloc(len
);
369 const char *src
= bits
;
372 for ( int rows
= 0; rows
< height
; rows
++ )
374 for ( size_t cols
= 0; cols
< bytesPerLine
; cols
++ )
376 unsigned char val
= *src
++;
377 unsigned char reversed
= 0;
379 for ( int bits
= 0; bits
< 8; bits
++)
382 reversed
|= (val
& 0x01);
394 // bits should already be in Windows standard format
395 data
= (char *)bits
; // const_cast is harmless
398 HBITMAP hbmp
= ::CreateBitmap(width
, height
, 1, depth
, data
);
401 wxLogLastError(wxT("CreateBitmap"));
409 SetHBITMAP((WXHBITMAP
)hbmp
);
413 // Create from XPM data
414 #if wxUSE_IMAGE && wxUSE_XPM
415 bool wxBitmap::CreateFromXpm(const char **data
)
417 bool wxBitmap::CreateFromXpm(const char **WXUNUSED(data
))
420 #if wxUSE_IMAGE && wxUSE_XPM
423 wxCHECK_MSG( data
!= NULL
, FALSE
, wxT("invalid bitmap data") )
425 wxXPMDecoder decoder
;
426 wxImage img
= decoder
.ReadData(data
);
427 wxCHECK_MSG( img
.Ok(), FALSE
, wxT("invalid bitmap data") )
429 *this = wxBitmap(img
);
436 wxBitmap::wxBitmap(int w
, int h
, int d
)
440 (void)Create(w
, h
, d
);
443 wxBitmap::wxBitmap(int w
, int h
, const wxDC
& dc
)
447 (void)Create(w
, h
, dc
);
450 wxBitmap::wxBitmap(void *data
, long type
, int width
, int height
, int depth
)
454 (void)Create(data
, type
, width
, height
, depth
);
457 wxBitmap::wxBitmap(const wxString
& filename
, wxBitmapType type
)
461 LoadFile(filename
, (int)type
);
464 bool wxBitmap::Create(int width
, int height
, int depth
)
466 return DoCreate(width
, height
, depth
, 0);
469 bool wxBitmap::Create(int width
, int height
, const wxDC
& dc
)
471 wxCHECK_MSG( dc
.Ok(), FALSE
, _T("invalid HDC in wxBitmap::Create()") );
473 return DoCreate(width
, height
, -1, dc
.GetHDC());
476 bool wxBitmap::DoCreate(int w
, int h
, int d
, WXHDC hdc
)
480 m_refData
= new wxBitmapRefData
;
482 GetBitmapData()->m_width
= w
;
483 GetBitmapData()->m_height
= h
;
485 HBITMAP hbmp
wxDUMMY_INITIALIZE(0);
487 #ifndef NEVER_USE_DIB
488 if ( wxShouldCreateDIB(w
, h
, d
, hdc
) )
492 // create DIBs without alpha channel by default
500 // don't delete the DIB section in dib object dtor
503 GetBitmapData()->m_isDIB
= TRUE
;
504 GetBitmapData()->m_depth
= d
;
507 #endif // NEVER_USE_DIB
509 #ifndef ALWAYS_USE_DIB
510 #ifndef __WXMICROWIN__
513 hbmp
= ::CreateBitmap(w
, h
, 1, d
, NULL
);
516 wxLogLastError(wxT("CreateBitmap"));
519 GetBitmapData()->m_depth
= d
;
521 else // d == 0, create bitmap compatible with the screen
522 #endif // !__WXMICROWIN__
525 hbmp
= ::CreateCompatibleBitmap(dc
, w
, h
);
528 wxLogLastError(wxT("CreateCompatibleBitmap"));
531 GetBitmapData()->m_depth
= wxDisplayDepth();
533 #endif // !ALWAYS_USE_DIB
536 SetHBITMAP((WXHBITMAP
)hbmp
);
543 // ----------------------------------------------------------------------------
544 // wxImage to/from conversions for Microwin
545 // ----------------------------------------------------------------------------
547 // Microwin versions are so different from normal ones that it really doesn't
548 // make sense to use #ifdefs inside the function bodies
549 #ifdef __WXMICROWIN__
551 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
, const wxDC
& dc
)
553 // Set this to 1 to experiment with mask code,
554 // which currently doesn't work
557 m_refData
= new wxBitmapRefData();
559 // Initial attempt at a simple-minded implementation.
560 // The bitmap will always be created at the screen depth,
561 // so the 'depth' argument is ignored.
563 HDC hScreenDC
= ::GetDC(NULL
);
564 int screenDepth
= ::GetDeviceCaps(hScreenDC
, BITSPIXEL
);
566 HBITMAP hBitmap
= ::CreateCompatibleBitmap(hScreenDC
, image
.GetWidth(), image
.GetHeight());
567 HBITMAP hMaskBitmap
= NULL
;
568 HBITMAP hOldMaskBitmap
= NULL
;
570 unsigned char maskR
= 0;
571 unsigned char maskG
= 0;
572 unsigned char maskB
= 0;
574 // printf("Created bitmap %d\n", (int) hBitmap);
577 ::ReleaseDC(NULL
, hScreenDC
);
580 HDC hMemDC
= ::CreateCompatibleDC(hScreenDC
);
582 HBITMAP hOldBitmap
= ::SelectObject(hMemDC
, hBitmap
);
583 ::ReleaseDC(NULL
, hScreenDC
);
585 // created an mono-bitmap for the possible mask
586 bool hasMask
= image
.HasMask();
591 // FIXME: we should be able to pass bpp = 1, but
592 // GdBlit can't handle a different depth
594 hMaskBitmap
= ::CreateBitmap( (WORD
)image
.GetWidth(), (WORD
)image
.GetHeight(), 1, 1, NULL
);
596 hMaskBitmap
= ::CreateCompatibleBitmap( hMemDC
, (WORD
)image
.GetWidth(), (WORD
)image
.GetHeight());
598 maskR
= image
.GetMaskRed();
599 maskG
= image
.GetMaskGreen();
600 maskB
= image
.GetMaskBlue();
608 hScreenDC
= ::GetDC(NULL
);
609 hMaskDC
= ::CreateCompatibleDC(hScreenDC
);
610 ::ReleaseDC(NULL
, hScreenDC
);
612 hOldMaskBitmap
= ::SelectObject( hMaskDC
, hMaskBitmap
);
620 for (i
= 0; i
< image
.GetWidth(); i
++)
622 for (j
= 0; j
< image
.GetHeight(); j
++)
624 unsigned char red
= image
.GetRed(i
, j
);
625 unsigned char green
= image
.GetGreen(i
, j
);
626 unsigned char blue
= image
.GetBlue(i
, j
);
628 ::SetPixel(hMemDC
, i
, j
, PALETTERGB(red
, green
, blue
));
632 // scan the bitmap for the transparent colour and set the corresponding
633 // pixels in the mask to BLACK and the rest to WHITE
634 if (maskR
== red
&& maskG
== green
&& maskB
== blue
)
635 ::SetPixel(hMaskDC
, i
, j
, PALETTERGB(0, 0, 0));
637 ::SetPixel(hMaskDC
, i
, j
, PALETTERGB(255, 255, 255));
642 ::SelectObject(hMemDC
, hOldBitmap
);
646 ::SelectObject(hMaskDC
, hOldMaskBitmap
);
649 ((wxBitmapRefData
*)m_refData
)->SetMask(hMaskBitmap
);
652 SetWidth(image
.GetWidth());
653 SetHeight(image
.GetHeight());
654 SetDepth(screenDepth
);
655 SetHBITMAP( (WXHBITMAP
) hBitmap
);
658 // Copy the palette from the source image
659 SetPalette(image
.GetPalette());
660 #endif // wxUSE_PALETTE
665 wxImage
wxBitmap::ConvertToImage() const
667 // Initial attempt at a simple-minded implementation.
668 // The bitmap will always be created at the screen depth,
669 // so the 'depth' argument is ignored.
670 // TODO: transparency (create a mask image)
674 wxFAIL_MSG( wxT("bitmap is invalid") );
680 wxCHECK_MSG( Ok(), wxNullImage
, wxT("invalid bitmap") );
682 // create an wxImage object
683 int width
= GetWidth();
684 int height
= GetHeight();
685 image
.Create( width
, height
);
686 unsigned char *data
= image
.GetData();
689 wxFAIL_MSG( wxT("could not allocate data for image") );
693 HDC hScreenDC
= ::GetDC(NULL
);
695 HDC hMemDC
= ::CreateCompatibleDC(hScreenDC
);
696 ::ReleaseDC(NULL
, hScreenDC
);
698 HBITMAP hBitmap
= (HBITMAP
) GetHBITMAP();
700 HBITMAP hOldBitmap
= ::SelectObject(hMemDC
, hBitmap
);
703 for (i
= 0; i
< GetWidth(); i
++)
705 for (j
= 0; j
< GetHeight(); j
++)
707 COLORREF color
= ::GetPixel(hMemDC
, i
, j
);
708 unsigned char red
= GetRValue(color
);
709 unsigned char green
= GetGValue(color
);
710 unsigned char blue
= GetBValue(color
);
712 image
.SetRGB(i
, j
, red
, green
, blue
);
716 ::SelectObject(hMemDC
, hOldBitmap
);
720 // Copy the palette from the source image
722 image
.SetPalette(* GetPalette());
723 #endif // wxUSE_PALETTE
728 #endif // __WXMICROWIN__
730 // ----------------------------------------------------------------------------
731 // wxImage to/from conversions
732 // ----------------------------------------------------------------------------
736 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
)
738 return CreateFromImage(image
, depth
, 0);
741 bool wxBitmap::CreateFromImage(const wxImage
& image
, const wxDC
& dc
)
743 wxCHECK_MSG( dc
.Ok(), FALSE
,
744 _T("invalid HDC in wxBitmap::CreateFromImage()") );
746 return CreateFromImage(image
, -1, dc
.GetHDC());
749 bool wxBitmap::CreateFromImage(const wxImage
& image
, int depth
, WXHDC hdc
)
751 wxCHECK_MSG( image
.Ok(), FALSE
, wxT("invalid image") );
755 // first convert the image to DIB
756 const int h
= image
.GetHeight();
757 const int w
= image
.GetWidth();
764 // store the bitmap parameters
765 wxBitmapRefData
*refData
= new wxBitmapRefData
;
766 refData
->m_width
= w
;
767 refData
->m_height
= h
;
768 refData
->m_hasAlpha
= image
.HasAlpha();
773 // next either store DIB as is or create a DDB from it
774 HBITMAP hbitmap
wxDUMMY_INITIALIZE(0);
776 // are we going to use DIB?
778 // NB: DDBs don't support alpha so if we have alpha channel we must use DIB
779 if ( image
.HasAlpha() || wxShouldCreateDIB(w
, h
, depth
, hdc
) )
781 // don't delete the DIB section in dib object dtor
782 hbitmap
= dib
.Detach();
784 refData
->m_isDIB
= TRUE
;
785 refData
->m_depth
= dib
.GetDepth();
787 #ifndef ALWAYS_USE_DIB
788 else // we need to convert DIB to DDB
790 hbitmap
= dib
.CreateDDB((HDC
)hdc
);
792 refData
->m_depth
= depth
== -1 ? dib
.GetDepth() : depth
;
794 #endif // !ALWAYS_USE_DIB
796 // validate this object
797 SetHBITMAP((WXHBITMAP
)hbitmap
);
799 // finally also set the mask if we have one
800 if ( image
.HasMask() )
802 SetMask(new wxMask(*this, wxColour(image
.GetMaskRed(),
803 image
.GetMaskGreen(),
804 image
.GetMaskBlue())));
810 wxImage
wxBitmap::ConvertToImage() const
819 wxImage image
= dib
.ConvertToImage();
827 // TODO: WinCE mask-copying support and use wxDIB
830 if( GetMask() && GetMask()->GetMaskBitmap() )
832 static const int MASK_RED
= 1;
833 static const int MASK_GREEN
= 2;
834 static const int MASK_BLUE
= 3;
835 static const int MASK_BLUE_REPLACEMENT
= 2;
837 HBITMAP hbitmap
= (HBITMAP
) GetMask()->GetMaskBitmap();
838 int width
= GetWidth();
839 int height
= GetHeight();
841 int bytesPerLine
= width
*3;
842 int sizeDWORD
= sizeof( DWORD
);
843 int lineBoundary
= bytesPerLine
% sizeDWORD
;
845 if( lineBoundary
> 0 )
847 padding
= sizeDWORD
- lineBoundary
;
848 bytesPerLine
+= padding
;
851 // create a DIB header
852 int headersize
= sizeof(BITMAPINFOHEADER
);
853 BITMAPINFO
*lpDIBh
= (BITMAPINFO
*) malloc( headersize
);
856 wxFAIL_MSG( wxT("could not allocate data for DIB header") );
861 // Fill in the DIB header
862 lpDIBh
->bmiHeader
.biSize
= headersize
;
863 lpDIBh
->bmiHeader
.biWidth
= width
;
864 lpDIBh
->bmiHeader
.biHeight
= -height
;
865 lpDIBh
->bmiHeader
.biSizeImage
= bytesPerLine
* height
;
866 lpDIBh
->bmiHeader
.biPlanes
= 1;
867 lpDIBh
->bmiHeader
.biBitCount
= 24;
868 lpDIBh
->bmiHeader
.biCompression
= BI_RGB
;
869 lpDIBh
->bmiHeader
.biClrUsed
= 0;
870 // These seem not really needed for our purpose here.
871 lpDIBh
->bmiHeader
.biClrImportant
= 0;
872 lpDIBh
->bmiHeader
.biXPelsPerMeter
= 0;
873 lpDIBh
->bmiHeader
.biYPelsPerMeter
= 0;
875 // memory DC created, color set, data copied, and memory DC deleted
877 // memory for DIB data
878 unsigned char *lpBits
879 = (unsigned char *) malloc( lpDIBh
->bmiHeader
.biSizeImage
);
882 wxFAIL_MSG( wxT("could not allocate data for DIB") );
888 HDC hdc
= ::GetDC(NULL
);
890 HDC memdc
= ::CreateCompatibleDC( hdc
);
891 ::SetTextColor( memdc
, RGB( 0, 0, 0 ) );
892 ::SetBkColor( memdc
, RGB( 255, 255, 255 ) );
893 ::GetDIBits( memdc
, hbitmap
, 0, height
, lpBits
, lpDIBh
, DIB_RGB_COLORS
);
895 unsigned char *ptdata
= image
.GetData();//data;
896 unsigned char *ptbits
= lpBits
;
898 for( i
=0; i
<height
; i
++ )
900 for( j
=0; j
<width
; j
++ )
902 // is this pixel transparent?
905 if ( (ptdata
[0] == MASK_RED
) &&
906 (ptdata
[1] == MASK_GREEN
) &&
907 (ptdata
[2] == MASK_BLUE
) )
909 // we have to fudge the colour a bit to prevent this
910 // pixel from appearing transparent
911 ptdata
[2] = MASK_BLUE_REPLACEMENT
;
917 *(ptdata
++) = MASK_RED
;
918 *(ptdata
++) = MASK_GREEN
;
919 *(ptdata
++) = MASK_BLUE
;
926 image
.SetMaskColour( MASK_RED
, MASK_GREEN
, MASK_BLUE
);
927 image
.SetMask( true );
929 // free allocated resources
930 ::ReleaseDC(NULL
, hdc
);
934 #endif // __WXWINCE__
939 #endif // wxUSE_WXDIB
941 #endif // wxUSE_IMAGE
943 // ----------------------------------------------------------------------------
944 // loading and saving bitmaps
945 // ----------------------------------------------------------------------------
947 bool wxBitmap::LoadFile(const wxString
& filename
, long type
)
951 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
955 m_refData
= new wxBitmapRefData
;
957 return handler
->LoadFile(this, filename
, type
, -1, -1);
960 else // no bitmap handler found
963 if ( image
.LoadFile( filename
, type
) && image
.Ok() )
965 *this = wxBitmap(image
);
970 #endif // wxUSE_IMAGE
975 bool wxBitmap::Create(void *data
, long type
, int width
, int height
, int depth
)
979 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
983 wxLogDebug(wxT("Failed to create bitmap: no bitmap handler for type %ld defined."), type
);
988 m_refData
= new wxBitmapRefData
;
990 return handler
->Create(this, data
, type
, width
, height
, depth
);
993 bool wxBitmap::SaveFile(const wxString
& filename
,
995 const wxPalette
*palette
)
997 wxBitmapHandler
*handler
= wxDynamicCast(FindHandler(type
), wxBitmapHandler
);
1001 return handler
->SaveFile(this, filename
, type
, palette
);
1004 else // no bitmap handler found
1006 // FIXME what about palette? shouldn't we use it?
1007 wxImage image
= ConvertToImage();
1010 return image
.SaveFile(filename
, type
);
1013 #endif // wxUSE_IMAGE
1018 // ----------------------------------------------------------------------------
1019 // sub bitmap extraction
1020 // ----------------------------------------------------------------------------
1022 wxBitmap
wxBitmap::GetSubBitmap( const wxRect
& rect
) const
1024 wxCHECK_MSG( Ok() &&
1025 (rect
.x
>= 0) && (rect
.y
>= 0) &&
1026 (rect
.x
+rect
.width
<= GetWidth()) &&
1027 (rect
.y
+rect
.height
<= GetHeight()),
1028 wxNullBitmap
, wxT("Invalid bitmap or bitmap region") );
1030 wxBitmap
ret( rect
.width
, rect
.height
);
1031 wxASSERT_MSG( ret
.Ok(), wxT("GetSubBitmap error") );
1033 #ifndef __WXMICROWIN__
1034 // TODO: copy alpha channel data if any
1041 SelectInHDC
selectSrc(dcSrc
, GetHbitmap()),
1042 selectDst(dcDst
, GetHbitmapOf(ret
));
1044 if ( !selectSrc
|| !selectDst
)
1046 wxLogLastError(_T("SelectObjct(hBitmap)"));
1049 if ( !::BitBlt(dcDst
, 0, 0, rect
.width
, rect
.height
,
1050 dcSrc
, rect
.x
, rect
.y
, SRCCOPY
) )
1052 wxLogLastError(_T("BitBlt"));
1056 // copy mask if there is one
1059 HBITMAP hbmpMask
= ::CreateBitmap(rect
.width
, rect
.height
, 1, 1, 0);
1061 SelectInHDC
selectSrc(dcSrc
, (HBITMAP
) GetMask()->GetMaskBitmap()),
1062 selectDst(dcDst
, hbmpMask
);
1064 if ( !::BitBlt(dcDst
, 0, 0, rect
.width
, rect
.height
,
1065 dcSrc
, rect
.x
, rect
.y
, SRCCOPY
) )
1067 wxLogLastError(_T("BitBlt"));
1070 wxMask
*mask
= new wxMask((WXHBITMAP
) hbmpMask
);
1073 #endif // !__WXMICROWIN__
1078 // ----------------------------------------------------------------------------
1079 // wxBitmap accessors
1080 // ----------------------------------------------------------------------------
1083 wxPalette
* wxBitmap::GetPalette() const
1085 return GetBitmapData() ? &GetBitmapData()->m_bitmapPalette
1086 : (wxPalette
*) NULL
;
1090 wxMask
*wxBitmap::GetMask() const
1092 return GetBitmapData() ? GetBitmapData()->GetMask() : (wxMask
*) NULL
;
1097 wxDC
*wxBitmap::GetSelectedInto() const
1099 return GetBitmapData() ? GetBitmapData()->m_selectedInto
: (wxDC
*) NULL
;
1104 #if WXWIN_COMPATIBILITY_2_4
1106 int wxBitmap::GetQuality() const
1111 #endif // WXWIN_COMPATIBILITY_2_4
1113 void wxBitmap::UseAlpha()
1115 if ( GetBitmapData() )
1116 GetBitmapData()->m_hasAlpha
= true;
1119 bool wxBitmap::HasAlpha() const
1121 return GetBitmapData() && GetBitmapData()->m_hasAlpha
;
1124 // ----------------------------------------------------------------------------
1126 // ----------------------------------------------------------------------------
1130 void wxBitmap::SetSelectedInto(wxDC
*dc
)
1132 if ( GetBitmapData() )
1133 GetBitmapData()->m_selectedInto
= dc
;
1140 void wxBitmap::SetPalette(const wxPalette
& palette
)
1144 GetBitmapData()->m_bitmapPalette
= palette
;
1147 #endif // wxUSE_PALETTE
1149 void wxBitmap::SetMask(wxMask
*mask
)
1153 GetBitmapData()->SetMask(mask
);
1156 #if WXWIN_COMPATIBILITY_2_4
1158 void wxBitmap::SetQuality(int WXUNUSED(quality
))
1162 #endif // WXWIN_COMPATIBILITY_2_4
1164 // ----------------------------------------------------------------------------
1165 // raw bitmap access support
1166 // ----------------------------------------------------------------------------
1168 #ifdef wxHAVE_RAW_BITMAP
1169 void *wxBitmap::GetRawData(wxPixelDataBase
& data
, int bpp
)
1174 // no bitmap, no data (raw or otherwise)
1178 // if we're already a DIB we can access our data directly, but if not we
1179 // need to convert this DDB to a DIB section and use it for raw access and
1180 // then convert it back
1182 if ( !GetBitmapData()->m_isDIB
)
1184 wxCHECK_MSG( !GetBitmapData()->m_dib
, FALSE
,
1185 _T("GetRawData() may be called only once") );
1187 wxDIB
*dib
= new wxDIB(*this);
1195 // we'll free it in UngetRawData()
1196 GetBitmapData()->m_dib
= dib
;
1198 hDIB
= dib
->GetHandle();
1202 hDIB
= GetHbitmap();
1206 if ( ::GetObject(hDIB
, sizeof(ds
), &ds
) != sizeof(DIBSECTION
) )
1208 wxFAIL_MSG( _T("failed to get DIBSECTION from a DIB?") );
1213 // check that the bitmap is in correct format
1214 if ( ds
.dsBm
.bmBitsPixel
!= bpp
)
1216 wxFAIL_MSG( _T("incorrect bitmap type in wxBitmap::GetRawData()") );
1221 // ok, store the relevant info in wxPixelDataBase
1222 const LONG h
= ds
.dsBm
.bmHeight
;
1224 data
.m_width
= ds
.dsBm
.bmWidth
;
1227 // remember that DIBs are stored in top to bottom order!
1228 const LONG bytesPerRow
= ds
.dsBm
.bmWidthBytes
;
1229 data
.m_stride
= -bytesPerRow
;
1231 char *bits
= (char *)ds
.dsBm
.bmBits
;
1234 bits
+= (h
- 1)*bytesPerRow
;
1243 void wxBitmap::UngetRawData(wxPixelDataBase
& dataBase
)
1249 // the cast is ugly but we can't do without it and without making this
1250 // function template (and hence inline) unfortunately
1251 typedef wxPixelData
<wxBitmap
, wxAlphaPixelFormat
> PixelData
;
1252 PixelData
& data
= (PixelData
&)dataBase
;
1256 // invalid data, don't crash -- but don't assert neither as we're
1257 // called automatically from wxPixelDataBase dtor and so there is no
1258 // way to prevent this from happening
1262 if ( GetBitmapData()->m_hasAlpha
)
1264 // AlphaBlend() wants to have premultiplied source alpha but
1265 // wxRawBitmap API uses normal, not premultiplied, colours, so adjust
1267 PixelData::Iterator
p(data
);
1269 const int w
= data
.GetWidth();
1270 const int h
= data
.GetHeight();
1272 for ( int y
= 0; y
< h
; y
++ )
1274 PixelData::Iterator rowStart
= p
;
1276 for ( int x
= 0; x
< w
; x
++ )
1278 const unsigned alpha
= p
.Alpha();
1280 p
.Red() = (p
.Red() * alpha
+ 127) / 255;
1281 p
.Blue() = (p
.Blue() * alpha
+ 127) / 255;
1282 p
.Green() = (p
.Green() * alpha
+ 127) / 255;
1292 // if we're a DDB we need to convert DIB back to DDB now to make the
1293 // changes made via raw bitmap access effective
1294 if ( !GetBitmapData()->m_isDIB
)
1296 wxDIB
*dib
= GetBitmapData()->m_dib
;
1297 GetBitmapData()->m_dib
= NULL
;
1303 #endif // wxUSE_WXDIB
1305 #endif // #ifdef wxHAVE_RAW_BITMAP
1307 // ----------------------------------------------------------------------------
1309 // ----------------------------------------------------------------------------
1316 // Construct a mask from a bitmap and a colour indicating
1317 // the transparent area
1318 wxMask::wxMask(const wxBitmap
& bitmap
, const wxColour
& colour
)
1321 Create(bitmap
, colour
);
1324 // Construct a mask from a bitmap and a palette index indicating
1325 // the transparent area
1326 wxMask::wxMask(const wxBitmap
& bitmap
, int paletteIndex
)
1329 Create(bitmap
, paletteIndex
);
1332 // Construct a mask from a mono bitmap (copies the bitmap).
1333 wxMask::wxMask(const wxBitmap
& bitmap
)
1342 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1345 // Create a mask from a mono bitmap (copies the bitmap).
1346 bool wxMask::Create(const wxBitmap
& bitmap
)
1348 #ifndef __WXMICROWIN__
1349 wxCHECK_MSG( bitmap
.Ok() && bitmap
.GetDepth() == 1, FALSE
,
1350 _T("can't create mask from invalid or not monochrome bitmap") );
1354 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1358 m_maskBitmap
= (WXHBITMAP
) CreateBitmap(
1363 HDC srcDC
= CreateCompatibleDC(0);
1364 SelectObject(srcDC
, (HBITMAP
) bitmap
.GetHBITMAP());
1365 HDC destDC
= CreateCompatibleDC(0);
1366 SelectObject(destDC
, (HBITMAP
) m_maskBitmap
);
1367 BitBlt(destDC
, 0, 0, bitmap
.GetWidth(), bitmap
.GetHeight(), srcDC
, 0, 0, SRCCOPY
);
1368 SelectObject(srcDC
, 0);
1370 SelectObject(destDC
, 0);
1378 // Create a mask from a bitmap and a palette index indicating
1379 // the transparent area
1380 bool wxMask::Create(const wxBitmap
& bitmap
, int paletteIndex
)
1384 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1389 if (bitmap
.Ok() && bitmap
.GetPalette()->Ok())
1391 unsigned char red
, green
, blue
;
1392 if (bitmap
.GetPalette()->GetRGB(paletteIndex
, &red
, &green
, &blue
))
1394 wxColour
transparentColour(red
, green
, blue
);
1395 return Create(bitmap
, transparentColour
);
1398 #endif // wxUSE_PALETTE
1403 // Create a mask from a bitmap and a colour indicating
1404 // the transparent area
1405 bool wxMask::Create(const wxBitmap
& bitmap
, const wxColour
& colour
)
1407 #ifndef __WXMICROWIN__
1408 wxCHECK_MSG( bitmap
.Ok(), FALSE
, _T("invalid bitmap in wxMask::Create") );
1412 ::DeleteObject((HBITMAP
) m_maskBitmap
);
1416 int width
= bitmap
.GetWidth(),
1417 height
= bitmap
.GetHeight();
1419 // scan the bitmap for the transparent colour and set the corresponding
1420 // pixels in the mask to BLACK and the rest to WHITE
1421 COLORREF maskColour
= wxColourToPalRGB(colour
);
1422 m_maskBitmap
= (WXHBITMAP
)::CreateBitmap(width
, height
, 1, 1, 0);
1424 HDC srcDC
= ::CreateCompatibleDC(NULL
);
1425 HDC destDC
= ::CreateCompatibleDC(NULL
);
1426 if ( !srcDC
|| !destDC
)
1428 wxLogLastError(wxT("CreateCompatibleDC"));
1433 // SelectObject() will fail
1434 wxASSERT_MSG( !bitmap
.GetSelectedInto(),
1435 _T("bitmap can't be selected in another DC") );
1437 HGDIOBJ hbmpSrcOld
= ::SelectObject(srcDC
, GetHbitmapOf(bitmap
));
1440 wxLogLastError(wxT("SelectObject"));
1445 HGDIOBJ hbmpDstOld
= ::SelectObject(destDC
, (HBITMAP
)m_maskBitmap
);
1448 wxLogLastError(wxT("SelectObject"));
1455 // this will create a monochrome bitmap with 0 points for the pixels
1456 // which have the same value as the background colour and 1 for the
1458 ::SetBkColor(srcDC
, maskColour
);
1459 ::BitBlt(destDC
, 0, 0, width
, height
, srcDC
, 0, 0, NOTSRCCOPY
);
1462 ::SelectObject(srcDC
, hbmpSrcOld
);
1464 ::SelectObject(destDC
, hbmpDstOld
);
1468 #else // __WXMICROWIN__
1470 #endif // __WXMICROWIN__/!__WXMICROWIN__
1473 // ----------------------------------------------------------------------------
1475 // ----------------------------------------------------------------------------
1477 bool wxBitmapHandler::Create(wxGDIImage
*image
,
1480 int width
, int height
, int depth
)
1482 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1484 return bitmap
? Create(bitmap
, data
, flags
, width
, height
, depth
) : FALSE
;
1487 bool wxBitmapHandler::Load(wxGDIImage
*image
,
1488 const wxString
& name
,
1490 int width
, int height
)
1492 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1494 return bitmap
? LoadFile(bitmap
, name
, flags
, width
, height
) : FALSE
;
1497 bool wxBitmapHandler::Save(wxGDIImage
*image
,
1498 const wxString
& name
,
1501 wxBitmap
*bitmap
= wxDynamicCast(image
, wxBitmap
);
1503 return bitmap
? SaveFile(bitmap
, name
, type
) : FALSE
;
1506 bool wxBitmapHandler::Create(wxBitmap
*WXUNUSED(bitmap
),
1507 void *WXUNUSED(data
),
1508 long WXUNUSED(type
),
1509 int WXUNUSED(width
),
1510 int WXUNUSED(height
),
1511 int WXUNUSED(depth
))
1516 bool wxBitmapHandler::LoadFile(wxBitmap
*WXUNUSED(bitmap
),
1517 const wxString
& WXUNUSED(name
),
1518 long WXUNUSED(type
),
1519 int WXUNUSED(desiredWidth
),
1520 int WXUNUSED(desiredHeight
))
1525 bool wxBitmapHandler::SaveFile(wxBitmap
*WXUNUSED(bitmap
),
1526 const wxString
& WXUNUSED(name
),
1528 const wxPalette
*WXUNUSED(palette
))
1533 // ----------------------------------------------------------------------------
1535 // ----------------------------------------------------------------------------
1537 #ifndef __WXMICROWIN__
1538 bool wxCreateDIB(long xSize
, long ySize
, long bitsPerPixel
,
1539 HPALETTE hPal
, LPBITMAPINFO
* lpDIBHeader
)
1541 unsigned long i
, headerSize
;
1543 // Allocate space for a DIB header
1544 headerSize
= (sizeof(BITMAPINFOHEADER
) + (256 * sizeof(PALETTEENTRY
)));
1545 LPBITMAPINFO lpDIBheader
= (BITMAPINFO
*) malloc(headerSize
);
1546 LPPALETTEENTRY lpPe
= (PALETTEENTRY
*)((BYTE
*)lpDIBheader
+ sizeof(BITMAPINFOHEADER
));
1548 GetPaletteEntries(hPal
, 0, 256, lpPe
);
1550 memset(lpDIBheader
, 0x00, sizeof(BITMAPINFOHEADER
));
1552 // Fill in the static parts of the DIB header
1553 lpDIBheader
->bmiHeader
.biSize
= sizeof(BITMAPINFOHEADER
);
1554 lpDIBheader
->bmiHeader
.biWidth
= xSize
;
1555 lpDIBheader
->bmiHeader
.biHeight
= ySize
;
1556 lpDIBheader
->bmiHeader
.biPlanes
= 1;
1558 // this value must be 1, 4, 8 or 24 so PixelDepth can only be
1559 lpDIBheader
->bmiHeader
.biBitCount
= (WORD
)(bitsPerPixel
);
1560 lpDIBheader
->bmiHeader
.biCompression
= BI_RGB
;
1561 lpDIBheader
->bmiHeader
.biSizeImage
= xSize
* abs(ySize
) * bitsPerPixel
>> 3;
1562 lpDIBheader
->bmiHeader
.biClrUsed
= 256;
1565 // Initialize the DIB palette
1566 for (i
= 0; i
< 256; i
++) {
1567 lpDIBheader
->bmiColors
[i
].rgbReserved
= lpPe
[i
].peFlags
;
1568 lpDIBheader
->bmiColors
[i
].rgbRed
= lpPe
[i
].peRed
;
1569 lpDIBheader
->bmiColors
[i
].rgbGreen
= lpPe
[i
].peGreen
;
1570 lpDIBheader
->bmiColors
[i
].rgbBlue
= lpPe
[i
].peBlue
;
1573 *lpDIBHeader
= lpDIBheader
;
1578 void wxFreeDIB(LPBITMAPINFO lpDIBHeader
)
1584 // ----------------------------------------------------------------------------
1585 // global helper functions implemented here
1586 // ----------------------------------------------------------------------------
1588 // helper of wxBitmapToHICON/HCURSOR
1590 HICON
wxBitmapToIconOrCursor(const wxBitmap
& bmp
,
1597 // we can't create an icon/cursor form nothing
1601 wxMask
*mask
= bmp
.GetMask();
1604 // we must have a mask for an icon, so even if it's probably incorrect,
1605 // do create it (grey is the "standard" transparent colour)
1606 mask
= new wxMask(bmp
, *wxLIGHT_GREY
);
1610 wxZeroMemory(iconInfo
);
1611 iconInfo
.fIcon
= iconWanted
; // do we want an icon or a cursor?
1614 iconInfo
.xHotspot
= hotSpotX
;
1615 iconInfo
.yHotspot
= hotSpotY
;
1618 iconInfo
.hbmMask
= wxInvertMask((HBITMAP
)mask
->GetMaskBitmap());
1619 iconInfo
.hbmColor
= GetHbitmapOf(bmp
);
1621 // black out the transparent area to preserve background colour, because
1622 // Windows blits the original bitmap using SRCINVERT (XOR) after applying
1623 // the mask to the dest rect.
1625 MemoryHDC dcSrc
, dcDst
;
1626 SelectInHDC
selectMask(dcSrc
, (HBITMAP
)mask
->GetMaskBitmap()),
1627 selectBitmap(dcDst
, iconInfo
.hbmColor
);
1629 if ( !::BitBlt(dcDst
, 0, 0, bmp
.GetWidth(), bmp
.GetHeight(),
1630 dcSrc
, 0, 0, SRCAND
) )
1632 wxLogLastError(_T("BitBlt"));
1636 HICON hicon
= ::CreateIconIndirect(&iconInfo
);
1638 if ( !bmp
.GetMask() )
1640 // we created the mask, now delete it
1644 // delete the inverted mask bitmap we created as well
1645 ::DeleteObject(iconInfo
.hbmMask
);
1650 HICON
wxBitmapToHICON(const wxBitmap
& bmp
)
1652 return wxBitmapToIconOrCursor(bmp
, TRUE
, 0, 0);
1655 HCURSOR
wxBitmapToHCURSOR(const wxBitmap
& bmp
, int hotSpotX
, int hotSpotY
)
1657 return (HCURSOR
)wxBitmapToIconOrCursor(bmp
, FALSE
, hotSpotX
, hotSpotY
);
1660 HBITMAP
wxInvertMask(HBITMAP hbmpMask
, int w
, int h
)
1662 #ifndef __WXMICROWIN__
1663 wxCHECK_MSG( hbmpMask
, 0, _T("invalid bitmap in wxInvertMask") );
1665 // get width/height from the bitmap if not given
1669 ::GetObject(hbmpMask
, sizeof(BITMAP
), (LPVOID
)&bm
);
1674 HDC hdcSrc
= ::CreateCompatibleDC(NULL
);
1675 HDC hdcDst
= ::CreateCompatibleDC(NULL
);
1676 if ( !hdcSrc
|| !hdcDst
)
1678 wxLogLastError(wxT("CreateCompatibleDC"));
1681 HBITMAP hbmpInvMask
= ::CreateBitmap(w
, h
, 1, 1, 0);
1684 wxLogLastError(wxT("CreateBitmap"));
1687 HGDIOBJ srcTmp
= ::SelectObject(hdcSrc
, hbmpMask
);
1688 HGDIOBJ dstTmp
= ::SelectObject(hdcDst
, hbmpInvMask
);
1689 if ( !::BitBlt(hdcDst
, 0, 0, w
, h
,
1693 wxLogLastError(wxT("BitBlt"));
1697 SelectObject(hdcSrc
,srcTmp
);
1698 SelectObject(hdcDst
,dstTmp
);