#ifndef _WX_BITMAP_H_
#define _WX_BITMAP_H_
-#ifdef __GNUG__
- #pragma interface "bitmap.h"
-#endif
-
#include "wx/msw/gdiimage.h"
#include "wx/gdicmn.h"
#include "wx/palette.h"
-class WXDLLEXPORT wxDC;
-class WXDLLEXPORT wxControl;
class WXDLLEXPORT wxBitmap;
class WXDLLEXPORT wxBitmapHandler;
class WXDLLEXPORT wxBitmapRefData;
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxMask;
-class WXDLLEXPORT wxCursor;
class WXDLLEXPORT wxControl;
+class WXDLLEXPORT wxCursor;
+class WXDLLEXPORT wxDC;
+#if wxUSE_WXDIB
+class WXDLLEXPORT wxDIB;
+#endif
+class WXDLLEXPORT wxIcon;
class WXDLLEXPORT wxImage;
+class WXDLLEXPORT wxMask;
class WXDLLEXPORT wxPalette;
+class WXDLLEXPORT wxPixelDataBase;
// ----------------------------------------------------------------------------
// wxBitmap: a mono or colour bitmap
{
public:
// default ctor creates an invalid bitmap, you must Create() it later
- wxBitmap() { Init(); }
-
- // Copy constructors
- wxBitmap(const wxBitmap& bitmap) { Init(); Ref(bitmap); }
+ wxBitmap() { }
// Initialize with raw data
wxBitmap(const char bits[], int width, int height, int depth = 1);
// New constructor for generalised creation from data
wxBitmap(void *data, long type, int width, int height, int depth = 1);
- // If depth is omitted, will create a bitmap compatible with the display
+ // Create a new, uninitialized bitmap of the given size and depth (if it
+ // is omitted, will create a bitmap compatible with the display)
+ //
+ // NB: this ctor will create a DIB for 24 and 32bpp bitmaps, use ctor
+ // taking a DC argument if you want to force using DDB in this case
wxBitmap(int width, int height, int depth = -1);
+ // Create a bitmap compatible with the given DC
+ wxBitmap(int width, int height, const wxDC& dc);
+
#if wxUSE_IMAGE
- // Convert from wxImage:
+ // Convert from wxImage
wxBitmap(const wxImage& image, int depth = -1)
{ (void)CreateFromImage(image, depth); }
+
+ // Create a DDB compatible with the given DC from wxImage
+ wxBitmap(const wxImage& image, const wxDC& dc)
+ { (void)CreateFromImage(image, dc); }
#endif // wxUSE_IMAGE
// we must have this, otherwise icons are silently copied into bitmaps using
// the copy ctor but the resulting bitmap is invalid!
- wxBitmap(const wxIcon& icon) { Init(); CopyFromIcon(icon); }
-
- wxBitmap& operator=(const wxBitmap& bitmap)
- {
- if ( m_refData != bitmap.m_refData )
- Ref(bitmap);
- return *this;
- }
+ wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
wxBitmap& operator=(const wxIcon& icon)
{
// copies the contents and mask of the given cursor to the bitmap
bool CopyFromCursor(const wxCursor& cursor);
+#if wxUSE_WXDIB
+ // copies from a device independent bitmap
+ bool CopyFromDIB(const wxDIB& dib);
+#endif
+
virtual bool Create(int width, int height, int depth = -1);
+ virtual bool Create(int width, int height, const wxDC& dc);
virtual bool Create(void *data, long type, int width, int height, int depth = 1);
virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
wxBitmapRefData *GetBitmapData() const
{ return (wxBitmapRefData *)m_refData; }
+ // raw bitmap access support functions
+ void *GetRawData(wxPixelDataBase& data, int bpp);
+ void UngetRawData(wxPixelDataBase& data);
+
#if wxUSE_PALETTE
wxPalette* GetPalette() const;
void SetPalette(const wxPalette& palette);
#endif // wxUSE_PALETTE
wxMask *GetMask() const;
+ wxBitmap GetMaskBitmap() const;
void SetMask(wxMask *mask);
bool operator==(const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
bool operator!=(const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
- // this function is internal and shouldn't be used, it risks to disappear
+ // these functions are internal and shouldn't be used, they risk to
+ // disappear in the future
bool HasAlpha() const;
+ void UseAlpha();
#if WXWIN_COMPATIBILITY_2_4
// these functions do nothing and are only there for backwards
wxDEPRECATED( void SetQuality(int quality) );
#endif // WXWIN_COMPATIBILITY_2_4
-#if WXWIN_COMPATIBILITY_2
- void SetOk(bool isOk);
-#endif // WXWIN_COMPATIBILITY_2
-
-#if wxUSE_PALETTE
-#if WXWIN_COMPATIBILITY
- wxPalette *GetColourMap() const { return GetPalette(); }
- void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
-#endif // WXWIN_COMPATIBILITY
-#endif // wxUSE_PALETTE
+ // implementation only from now on
+ // -------------------------------
- // Implementation
public:
void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
wxDC *GetSelectedInto() const;
#endif // __WXDEBUG__
- // Creates a bitmap that matches the device context's depth, from an
- // arbitray bitmap. At present, the original bitmap must have an associated
- // palette. (TODO: use a default palette if no palette exists.) This
- // function is necessary for you to Blit an arbitrary bitmap (which may
- // have the wrong depth). wxDC::SelectObject will compare the depth of the
- // bitmap with the DC's depth, and create a new bitmap if the depths
- // differ. Eventually we should perhaps make this a public API function so
- // that an app can efficiently produce bitmaps of the correct depth. The
- // Windows solution is to use SetDibBits to blit an arbotrary DIB directly
- // to a DC, but this is too Windows-specific, hence this solution of
- // quietly converting the wxBitmap. Contributed by Frederic Villeneuve
- // <frederic.villeneuve@natinst.com>
- wxBitmap GetBitmapForDC(wxDC& dc) const;
-
protected:
- // common part of all ctors
- void Init();
-
virtual wxGDIImageRefData *CreateData() const;
+ virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
// creates the bitmap from XPM data, supposed to be called from ctor
bool CreateFromXpm(const char **bits);
+ // creates an uninitialized bitmap, called from Create()s above
+ bool DoCreate(int w, int h, int depth, WXHDC hdc);
+
#if wxUSE_IMAGE
// creates the bitmap from wxImage, supposed to be called from ctor
bool CreateFromImage(const wxImage& image, int depth);
-#endif // wxUSE_IMAGE
-#if wxUSE_DIB_FOR_BITMAP
- void *CreateDIB(int width, int height, int depth);
+ // creates a DDB from wxImage, supposed to be called from ctor
+ bool CreateFromImage(const wxImage& image, const wxDC& dc);
- void CopyDIBLine(void* src, void* dest, int count) const;
-#endif // wxUSE_DIB_FOR_BITMAP
+ // common part of the 2 methods above (hdc may be 0)
+ bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc);
+#endif // wxUSE_IMAGE
private:
-#ifdef __WIN32__
// common part of CopyFromIcon/CopyFromCursor for Win32
bool CopyFromIconOrCursor(const wxGDIImage& icon);
-#endif // __WIN32__
+
DECLARE_DYNAMIC_CLASS(wxBitmap)
};