include/wx/osx/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/bitmap.h
   3 // Purpose:     wxBitmap class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BITMAP_H_
  13 #define _WX_BITMAP_H_
  14
  15 #include "wx/palette.h"
  16
  17 // Bitmap
  18 class WXDLLIMPEXP_FWD_CORE wxBitmap;
  19 class wxBitmapRefData ;
  20 class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
  21 class WXDLLIMPEXP_FWD_CORE wxControl;
  22 class WXDLLIMPEXP_FWD_CORE wxCursor;
  23 class WXDLLIMPEXP_FWD_CORE wxDC;
  24 class WXDLLIMPEXP_FWD_CORE wxIcon;
  25 class WXDLLIMPEXP_FWD_CORE wxImage;
  26 class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
  27
  28 // A mask is a bitmap used for drawing bitmaps
  29 // Internally it is stored as a 8 bit deep memory chunk, 0 = black means the source will be drawn
  30 // 255 = white means the source will not be drawn, no other values will be present
  31 // 8 bit is chosen only for performance reasons, note also that this is the inverse value range
  32 // from alpha, where 0 = invisible , 255 = fully drawn
  33
  34 class WXDLLIMPEXP_CORE wxMask: public wxObject
  35 {
  36     DECLARE_DYNAMIC_CLASS(wxMask)
  37
  38 public:
  39     wxMask();
  40
  41     // Copy constructor
  42     wxMask(const wxMask& mask);
  43
  44     // Construct a mask from a bitmap and a colour indicating
  45     // the transparent area
  46     wxMask(const wxBitmap& bitmap, const wxColour& colour);
  47
  48     // Construct a mask from a mono bitmap (black meaning show pixels, white meaning transparent)
  49     wxMask(const wxBitmap& bitmap);
  50
  51     // implementation helper only : construct a mask from a 32 bit memory buffer
  52     wxMask(const wxMemoryBuffer& buf, int width , int height , int bytesPerRow ) ;
  53
  54     virtual ~wxMask();
  55
  56     bool Create(const wxBitmap& bitmap, const wxColour& colour);
  57     bool Create(const wxBitmap& bitmap);
  58     bool Create(const wxMemoryBuffer& buf, int width , int height , int bytesPerRow ) ;
  59
  60     wxBitmap GetBitmap() const;
  61
  62     // Implementation below
  63
  64     void Init() ;
  65
  66     // a 8 bit depth mask
  67     void* GetRawAccess() const;
  68     int GetBytesPerRow() const { return m_bytesPerRow ; }
  69     // renders/updates native representation when necessary
  70     void RealizeNative() ;
  71
  72     WXHBITMAP GetHBITMAP() const ;
  73
  74
  75 private:
  76     wxMemoryBuffer m_memBuf ;
  77     int m_bytesPerRow ;
  78     int m_width ;
  79     int m_height ;
  80
  81     WXHBITMAP m_maskBitmap ;
  82
  83 };
  84
  85 class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase
  86 {
  87     DECLARE_DYNAMIC_CLASS(wxBitmap)
  88
  89     friend class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
  90
  91 public:
  92     wxBitmap() {} // Platform-specific
  93
  94     // Initialize with raw data.
  95     wxBitmap(const char bits[], int width, int height, int depth = 1);
  96
  97     // Initialize with XPM data
  98     wxBitmap(const char* const* bits);
  99
 100     // Load a file or resource
 101     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 102
 103     // Constructor for generalised creation from data
 104     wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
 105
 106     // creates an bitmap from the native image format
 107     wxBitmap(CGImageRef image);
 108     wxBitmap(WX_NSImage image);
 109
 110     // Create a bitmap compatible with the given DC
 111     wxBitmap(int width, int height, const wxDC& dc);
 112
 113     // If depth is omitted, will create a bitmap compatible with the display
 114     wxBitmap(int width, int height, int depth = -1) { (void)Create(width, height, depth); }
 115     wxBitmap(const wxSize& sz, int depth = -1) { (void)Create(sz, depth); }
 116
 117     // Convert from wxImage:
 118     wxBitmap(const wxImage& image, int depth = -1);
 119
 120     // Convert from wxIcon
 121     wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
 122
 123     virtual ~wxBitmap() {}
 124
 125     wxImage ConvertToImage() const;
 126
 127     // get the given part of bitmap
 128     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 129
 130     virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
 131     virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
 132         { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
 133
 134     virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
 135     bool Create( CGImageRef image );
 136     bool Create( WX_NSImage image );
 137
 138     // Create a bitmap compatible with the given DC, inheriting its magnification factor
 139     bool Create(int width, int height, const wxDC& dc);
 140
 141     // Create a bitmap with a scale factor, width and height are multiplied with that factor
 142     bool CreateScaled(int logwidth, int logheight, int depth, double logicalScale);
 143
 144     // virtual bool Create( WXHICON icon) ;
 145     virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 146     virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 147
 148     wxBitmapRefData *GetBitmapData() const
 149         { return (wxBitmapRefData *)m_refData; }
 150
 151     // copies the contents and mask of the given (colour) icon to the bitmap
 152     virtual bool CopyFromIcon(const wxIcon& icon);
 153
 154     int GetWidth() const;
 155     int GetHeight() const;
 156     int GetDepth() const;
 157     void SetWidth(int w);
 158     void SetHeight(int h);
 159     void SetDepth(int d);
 160     void SetOk(bool isOk);
 161
 162 #if wxUSE_PALETTE
 163     wxPalette* GetPalette() const;
 164     void SetPalette(const wxPalette& palette);
 165 #endif // wxUSE_PALETTE
 166
 167     wxMask *GetMask() const;
 168     void SetMask(wxMask *mask) ;
 169
 170     static void InitStandardHandlers();
 171
 172     // raw bitmap access support functions, for internal use only
 173     void *GetRawData(wxPixelDataBase& data, int bpp);
 174     void UngetRawData(wxPixelDataBase& data);
 175
 176     // these functions are internal and shouldn't be used, they risk to
 177     // disappear in the future
 178     bool HasAlpha() const;
 179     void UseAlpha();
 180
 181     // returns the 'native' implementation, a GWorldPtr for the content and one for the mask
 182     WXHBITMAP GetHBITMAP( WXHBITMAP * mask = NULL ) const;
 183
 184     // returns a CGImageRef which must released after usage with CGImageRelease
 185     CGImageRef CreateCGImage() const ;
 186
 187 #if wxOSX_USE_COCOA
 188     // returns an autoreleased version of the image
 189     WX_NSImage GetNSImage() const;
 190 #endif
 191 #if wxOSX_USE_IPHONE
 192     // returns an autoreleased version of the image
 193     WX_UIImage GetUIImage() const;
 194 #endif
 195     // returns a IconRef which must be retained before and released after usage
 196     IconRef GetIconRef() const;
 197     // returns a IconRef which must be released after usage
 198     IconRef CreateIconRef() const;
 199     // get read only access to the underlying buffer
 200     void *GetRawAccess() const ;
 201     // brackets to the underlying OS structure for read/write access
 202     // makes sure that no cached images will be constructed until terminated
 203     void *BeginRawAccess() ;
 204     void EndRawAccess() ;
 205
 206     double GetScaleFactor() const;
 207 protected:
 208     virtual wxGDIRefData *CreateGDIRefData() const;
 209     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 210 };
 211
 212 #endif // _WX_BITMAP_H_