From fcd9ed6c3713f63bd070295039b985a5a6f6d76f Mon Sep 17 00:00:00 2001 From: John Chain Date: Sat, 9 Jul 2011 18:40:11 +0000 Subject: [PATCH] Added Robin Dunn's explanation on the relationship of wxBitmap and wxImage into interface doxygen section git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@68196 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/bitmap.h | 11 +++++++++++ interface/wx/image.h | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/interface/wx/bitmap.h b/interface/wx/bitmap.h index 94b8843668..cf62947f78 100644 --- a/interface/wx/bitmap.h +++ b/interface/wx/bitmap.h @@ -183,6 +183,17 @@ public: Note that all available wxBitmapHandlers for a given wxWidgets port are automatically loaded at startup so you won't need to use wxBitmap::AddHandler. + More on the difference between wxImage and wxBitmap: wxImage is just a + buffer of RGB bytes with an optional buffer for the alpha bytes. It is all + generic, platform independent and image file format independent code. It + includes generic code for scaling, resizing, clipping, and other manipulations + of the image data. OTOH, wxBitmap is intended to be a wrapper of whatever is + the native image format that is quickest/easiest to draw to a DC or to be the + target of the drawing operations performed on a wxMemoryDC. By splitting the + responsibilities between wxImage/wxBitmap like this then it's easier to use + generic code shared by all platforms and image types for generic operations and + platform specific code where performance or compatibility is needed. + @library{wxcore} @category{gdi} diff --git a/interface/wx/image.h b/interface/wx/image.h index 34808c5c15..cdeba80f58 100644 --- a/interface/wx/image.h +++ b/interface/wx/image.h @@ -314,6 +314,17 @@ const unsigned char wxIMAGE_ALPHA_OPAQUE = 0xff; the wxBitmap::wxBitmap(wxImage,int depth) constructor. This bitmap can then be drawn in a device context, using wxDC::DrawBitmap. + More on the difference between wxImage and wxBitmap: wxImage is just a + buffer of RGB bytes with an optional buffer for the alpha bytes. It is all + generic, platform independent and image file format independent code. It + includes generic code for scaling, resizing, clipping, and other manipulations + of the image data. OTOH, wxBitmap is intended to be a wrapper of whatever is + the native image format that is quickest/easiest to draw to a DC or to be the + target of the drawing operations performed on a wxMemoryDC. By splitting the + responsibilities between wxImage/wxBitmap like this then it's easier to use + generic code shared by all platforms and image types for generic operations and + platform specific code where performance or compatibility is needed. + One colour value of the image may be used as a mask colour which will lead to the automatic creation of a wxMask object associated to the bitmap object. -- 2.45.2