// Modified by:
// Created: 03.03.03 (replaces the old file with the same name)
// RCS-ID: $Id$
-// Copyright: (c) 1997-2003 wxWindows team
+// Copyright: (c) 1997-2003 wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_MSW_DIB_H_
#define _WX_MSW_DIB_H_
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxPalette;
+class WXDLLIMPEXP_FWD_CORE wxPalette;
#include "wx/msw/private.h"
+#if wxUSE_WXDIB
+
+#ifdef __WXMSW__
+ #include "wx/bitmap.h"
+#endif // __WXMSW__
+
// ----------------------------------------------------------------------------
// wxDIB: represents a DIB section
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxDIB
+class WXDLLIMPEXP_CORE wxDIB
{
public:
// ctors and such
wxDIB(int width, int height, int depth)
{ Init(); (void)Create(width, height, depth); }
- // same as ctor but with return value
+#ifdef __WXMSW__
+ // create a DIB from the DDB
+ wxDIB(const wxBitmap& bmp)
+ { Init(); (void)Create(bmp); }
+#endif // __WXMSW__
+
+ // create a DIB from the Windows DDB
+ wxDIB(HBITMAP hbmp)
+ { Init(); (void)Create(hbmp); }
+
+ // load a DIB from file (any depth is supoprted here unlike above)
+ //
+ // as above, use IsOk() to see if the bitmap was loaded successfully
+ wxDIB(const wxString& filename)
+ { Init(); (void)Load(filename); }
+
+ // same as the corresponding ctors but with return value
bool Create(int width, int height, int depth);
+#ifdef __WXMSW__
+ bool Create(const wxBitmap& bmp) { return Create(GetHbitmapOf(bmp)); }
+#endif
+ bool Create(HBITMAP hbmp);
+ bool Load(const wxString& filename);
// dtor is not virtual, this class is not meant to be used polymorphically
- ~wxDIB()
- {
- if ( m_handle && !::DeleteObject(m_handle) )
- {
- wxLogLastError(wxT("DeleteObject(hDIB)"));
- }
- }
+ ~wxDIB();
// operations
// ----------
+#ifndef __WXWINCE__
+ // create a bitmap compatible with the given HDC (or screen by default) and
+ // return its handle, the caller is responsible for freeing it (using
+ // DeleteObject())
+ HBITMAP CreateDDB(HDC hdc = 0) const;
+#endif // !__WXWINCE__
+
// get the handle from the DIB and reset it, i.e. this object won't destroy
// the DIB after this (but the caller should do it)
HBITMAP Detach() { HBITMAP hbmp = m_handle; m_handle = 0; return hbmp; }
+#if wxUSE_PALETTE
+ // create a palette for this DIB (always a trivial/default one for 24bpp)
+ wxPalette *CreatePalette() const;
+#endif // wxUSE_PALETTE
+
+ // save the DIB as a .BMP file to the file with the given name
+ bool Save(const wxString& filename);
+
// accessors
// ---------
// get raw pointer to bitmap bits, you should know what you do if you
// decide to use it
- void *GetData() const { DoGetObject(); return m_data; }
+ unsigned char *GetData() const
+ { DoGetObject(); return (unsigned char *)m_data; }
+
+
+ // HBITMAP conversion
+ // ------------------
+
+ // these functions are only used by wxWidgets internally right now, please
+ // don't use them directly if possible as they're subject to change
+
+#ifndef __WXWINCE__
+ // creates a DDB compatible with the given (or screen) DC from either
+ // a plain DIB or a DIB section (in which case the last parameter must be
+ // non NULL)
+ static HBITMAP ConvertToBitmap(const BITMAPINFO *pbi,
+ HDC hdc = 0,
+ void *bits = NULL);
+
+ // create a plain DIB (not a DIB section) from a DDB, the caller is
+ // responsable for freeing it using ::GlobalFree()
+ static HGLOBAL ConvertFromBitmap(HBITMAP hbmp);
+
+ // creates a DIB from the given DDB or calculates the space needed by it:
+ // if pbi is NULL, only the space is calculated, otherwise pbi is supposed
+ // to point at BITMAPINFO of the correct size which is filled by this
+ // function (this overload is needed for wxBitmapDataObject code in
+ // src/msw/ole/dataobj.cpp)
+ static size_t ConvertFromBitmap(BITMAPINFO *pbi, HBITMAP hbmp);
+#endif // __WXWINCE__
// wxImage conversion
// ------------------
#if wxUSE_IMAGE
- // create a DIB from the given image, the DIB will be either 24 or 32 (if
- // the image has alpha channel) bpp
- wxDIB(const wxImage& image) { Init(); (void)Create(image); }
+ // Possible formats for DIBs created by the functions below.
+ enum PixelFormat
+ {
+ PixelFormat_PreMultiplied = 0,
+ PixelFormat_NotPreMultiplied = 1
+ };
+
+ // Create a DIB from the given image, the DIB will be either 24 or 32 (if
+ // the image has alpha channel) bpp.
+ //
+ // By default the DIB stores pixel data in pre-multiplied format so that it
+ // can be used with ::AlphaBlend() but it is also possible to disable
+ // pre-multiplication for the DIB to be usable with ImageList_Draw() which
+ // does pre-multiplication internally.
+ wxDIB(const wxImage& image, PixelFormat pf = PixelFormat_PreMultiplied)
+ {
+ Init();
+ (void)Create(image, pf);
+ }
// same as the above ctor but with the return code
- bool Create(const wxImage& image);
+ bool Create(const wxImage& image, PixelFormat pf = PixelFormat_PreMultiplied);
// create wxImage having the same data as this DIB
wxImage ConvertToImage() const;
private:
// common part of all ctors
- void Init()
- {
- m_handle = 0;
+ void Init();
- m_data = NULL;
+ // free resources
+ void Free();
+
+ // initialize the contents from the provided DDB (Create() must have been
+ // already called)
+ bool CopyFromDDB(HBITMAP hbmp);
- m_width =
- m_height =
- m_depth = 0;
- }
// the DIB section handle, 0 if invalid
HBITMAP m_handle;
m_height,
m_depth;
+ // in some cases we could be using a handle which we didn't create and in
+ // this case we shouldn't free it neither -- this flag tell us if this is
+ // the case
+ bool m_ownsHandle;
+
// DIBs can't be copied
wxDIB(const wxDIB&);
wxDIB& operator=(const wxDIB&);
};
-
// ----------------------------------------------------------------------------
-// Functions for working with DIBs
+// inline functions implementation
// ----------------------------------------------------------------------------
-// WARNING: these functions are private to wxWindows and shouldn't be used
-// by the user code, they risk to disappear in the next versions!
-
-// VZ: we have 3 different sets of functions: from bitmap.cpp (wxCreateDIB and
-// wxFreeDIB), from dib.cpp and from dataobj.cpp - surely there is some
-// redundancy between them? (FIXME)
-
-// defined in bitmap.cpp
-extern bool wxCreateDIB(long xSize, long ySize, long bitsPerPixel,
- HPALETTE hPal, LPBITMAPINFO* lpDIBHeader);
-extern void wxFreeDIB(LPBITMAPINFO lpDIBHeader);
+inline
+void wxDIB::Init()
+{
+ m_handle = 0;
+ m_ownsHandle = true;
-// defined in ole/dataobj.cpp
-extern WXDLLEXPORT size_t wxConvertBitmapToDIB(LPBITMAPINFO pbi, const wxBitmap& bitmap);
-extern WXDLLEXPORT wxBitmap wxConvertDIBToBitmap(const LPBITMAPINFO pbi);
+ m_data = NULL;
-// the rest is defined in dib.cpp
+ m_width =
+ m_height =
+ m_depth = 0;
+}
-// Save (device dependent) wxBitmap as a DIB
-bool wxSaveBitmap(wxChar *filename, wxBitmap *bitmap, wxPalette *colourmap = NULL);
+inline
+void wxDIB::Free()
+{
+ if ( m_handle && m_ownsHandle )
+ {
+ if ( !::DeleteObject(m_handle) )
+ {
+ wxLogLastError(wxT("DeleteObject(hDIB)"));
+ }
-// Load device independent bitmap into device dependent bitmap
-wxBitmap *wxLoadBitmap(wxChar *filename, wxPalette **colourmap = NULL);
+ Init();
+ }
+}
-// Load into existing bitmap;
-bool wxLoadIntoBitmap(wxChar *filename, wxBitmap *bitmap, wxPalette **pal = NULL);
+inline wxDIB::~wxDIB()
+{
+ Free();
+}
-HANDLE wxBitmapToDIB (HBITMAP hBitmap, HPALETTE hPal);
-BOOL wxReadDIB(LPTSTR lpFileName, HBITMAP *bitmap, HPALETTE *palette);
-HANDLE wxReadDIB2(LPTSTR lpFileName);
-LPSTR wxFindDIBBits (LPSTR lpbi);
-HPALETTE wxMakeDIBPalette(LPBITMAPINFOHEADER lpInfo);
+#endif
+ // wxUSE_WXDIB
#endif // _WX_MSW_DIB_H_
projects / wxWidgets.git / blobdiff