include/wx/osx/bitmap.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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     // Implementation below
  61
  62     void Init() ;
  63
  64     // a 8 bit depth mask
  65     void* GetRawAccess() const;
  66     int GetBytesPerRow() const { return m_bytesPerRow ; }
  67     // renders/updates native representation when necessary
  68     void RealizeNative() ;
  69
  70     WXHBITMAP GetHBITMAP() const ;
  71
  72
  73 private:
  74     wxMemoryBuffer m_memBuf ;
  75     int m_bytesPerRow ;
  76     int m_width ;
  77     int m_height ;
  78
  79     WXHBITMAP m_maskBitmap ;
  80
  81 };
  82
  83 class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase
  84 {
  85     DECLARE_DYNAMIC_CLASS(wxBitmap)
  86
  87     friend class WXDLLIMPEXP_FWD_CORE wxBitmapHandler;
  88
  89 public:
  90     wxBitmap() {} // Platform-specific
  91
  92     // Initialize with raw data.
  93     wxBitmap(const char bits[], int width, int height, int depth = 1);
  94
  95     // Initialize with XPM data
  96     wxBitmap(const char* const* bits);
  97
  98     // Load a file or resource
  99     wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 100
 101     // Constructor for generalised creation from data
 102     wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
 103
 104     // If depth is omitted, will create a bitmap compatible with the display
 105     wxBitmap(int width, int height, int depth = -1) { (void)Create(width, height, depth); }
 106     wxBitmap(const wxSize& sz, int depth = -1) { (void)Create(sz, depth); }
 107
 108     // Convert from wxImage:
 109     wxBitmap(const wxImage& image, int depth = -1);
 110
 111     // Convert from wxIcon
 112     wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
 113
 114     virtual ~wxBitmap() {}
 115
 116     wxImage ConvertToImage() const;
 117
 118     // get the given part of bitmap
 119     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 120
 121     virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
 122     virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
 123         { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
 124
 125     virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
 126     // virtual bool Create( WXHICON icon) ;
 127     virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 128     virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
 129
 130     wxBitmapRefData *GetBitmapData() const
 131         { return (wxBitmapRefData *)m_refData; }
 132
 133     // copies the contents and mask of the given (colour) icon to the bitmap
 134     virtual bool CopyFromIcon(const wxIcon& icon);
 135
 136     int GetWidth() const;
 137     int GetHeight() const;
 138     int GetDepth() const;
 139     void SetWidth(int w);
 140     void SetHeight(int h);
 141     void SetDepth(int d);
 142     void SetOk(bool isOk);
 143
 144 #if wxUSE_PALETTE
 145     wxPalette* GetPalette() const;
 146     void SetPalette(const wxPalette& palette);
 147 #endif // wxUSE_PALETTE
 148
 149     wxMask *GetMask() const;
 150     void SetMask(wxMask *mask) ;
 151
 152     static void InitStandardHandlers();
 153
 154     // raw bitmap access support functions, for internal use only
 155     void *GetRawData(wxPixelDataBase& data, int bpp);
 156     void UngetRawData(wxPixelDataBase& data);
 157
 158     // these functions are internal and shouldn't be used, they risk to
 159     // disappear in the future
 160     bool HasAlpha() const;
 161     void UseAlpha();
 162
 163     // returns the 'native' implementation, a GWorldPtr for the content and one for the mask
 164     WXHBITMAP GetHBITMAP( WXHBITMAP * mask = NULL ) const;
 165
 166     // returns a CGImageRef which must released after usage with CGImageRelease
 167     CGImageRef CreateCGImage() const ;
 168
 169 #if wxOSX_USE_COCOA_OR_IPHONE
 170     // returns an autoreleased version of the image
 171     WX_NSImage GetNSImage() const;
 172 #endif
 173     // returns a IconRef which must be retained before and released after usage
 174     IconRef GetIconRef() const;
 175     // returns a IconRef which must be released after usage
 176     IconRef CreateIconRef() const;
 177     // get read only access to the underlying buffer
 178     void *GetRawAccess() const ;
 179     // brackets to the underlying OS structure for read/write access
 180     // makes sure that no cached images will be constructed until terminated
 181     void *BeginRawAccess() ;
 182     void EndRawAccess() ;
 183
 184 protected:
 185     virtual wxGDIRefData *CreateGDIRefData() const;
 186     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 187 };
 188
 189 #endif // _WX_BITMAP_H_