interface/wx/image.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        image.h
   3 // Purpose:     interface of wxImageHandler and wxImage
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     Possible values for the image resolution option.
  11
  12     @see wxImage::GetOptionInt().
  13  */
  14 enum wxImageResolution
  15 {
  16     /// Resolution not specified.
  17     wxIMAGE_RESOLUTION_NONE = 0,
  18
  19     /// Resolution specified in inches.
  20     wxIMAGE_RESOLUTION_INCHES = 1,
  21
  22     /// Resolution specified in centimetres.
  23     wxIMAGE_RESOLUTION_CM = 2
  24 };
  25
  26 /**
  27     Possible values for PNG image type option.
  28
  29     @see wxImage::GetOptionInt().
  30  */
  31 enum wxImagePNGType
  32 {
  33     wxPNG_TYPE_COLOUR = 0,      ///< Colour PNG image.
  34     wxPNG_TYPE_GREY = 2,        ///< Greyscale PNG image converted from RGB.
  35     wxPNG_TYPE_GREY_RED = 3     ///< Greyscale PNG image using red as grey.
  36 };
  37
  38 /**
  39     @class wxImageHandler
  40
  41     This is the base class for implementing image file loading/saving, and
  42     image creation from data.
  43     It is used within wxImage and is not normally seen by the application.
  44
  45     If you wish to extend the capabilities of wxImage, derive a class from
  46     wxImageHandler and add the handler using wxImage::AddHandler in your
  47     application initialisation.
  48
  49     Note that all wxImageHandlers provided by wxWidgets are part of
  50     the @ref page_libs_wxcore library.
  51     For details about the default handlers, please see the section
  52     @ref image_handlers in the wxImage class documentation.
  53
  54
  55     @section imagehandler_note Note (Legal Issue)
  56
  57     This software is based in part on the work of the Independent JPEG Group.
  58     (Applies when wxWidgets is linked with JPEG support.
  59     wxJPEGHandler uses libjpeg created by IJG.)
  60
  61
  62     @stdobjects
  63     ::wxNullImage
  64
  65     @library{wxcore}
  66     @category{misc}
  67
  68     @see wxImage, wxInitAllImageHandlers()
  69 */
  70 class wxImageHandler : public wxObject
  71 {
  72 public:
  73     /**
  74         Default constructor.
  75
  76         In your own default constructor, initialise the members
  77         m_name, m_extension and m_type.
  78     */
  79     wxImageHandler();
  80
  81     /**
  82         Destroys the wxImageHandler object.
  83     */
  84     virtual ~wxImageHandler();
  85
  86     /**
  87         Gets the file extension associated with this handler.
  88     */
  89     const wxString& GetExtension() const;
  90
  91     /**
  92         If the image file contains more than one image and the image handler is capable
  93         of retrieving these individually, this function will return the number of
  94         available images.
  95
  96         @param stream
  97             Opened input stream for reading image data.
  98             Currently, the stream must support seeking.
  99
 100         @return Number of available images. For most image handlers, this is 1
 101                 (exceptions are TIFF and ICO formats).
 102     */
 103     virtual int GetImageCount(wxInputStream& stream);
 104
 105     /**
 106         Gets the MIME type associated with this handler.
 107     */
 108     const wxString& GetMimeType() const;
 109
 110     /**
 111         Gets the name of this handler.
 112     */
 113     const wxString& GetName() const;
 114
 115     /**
 116         Gets the image type associated with this handler.
 117     */
 118     wxBitmapType GetType() const;
 119
 120     /**
 121         Loads a image from a stream, putting the resulting data into @a image.
 122
 123         If the image file contains more than one image and the image handler is
 124         capable of retrieving these individually, @a index indicates which image
 125         to read from the stream.
 126
 127         @param image
 128             The image object which is to be affected by this operation.
 129         @param stream
 130             Opened input stream for reading image data.
 131         @param verbose
 132             If set to @true, errors reported by the image handler will produce
 133             wxLogMessages.
 134         @param index
 135             The index of the image in the file (starting from zero).
 136
 137         @return @true if the operation succeeded, @false otherwise.
 138
 139         @see wxImage::LoadFile, wxImage::SaveFile, SaveFile()
 140     */
 141     virtual bool LoadFile(wxImage* image, wxInputStream& stream,
 142                           bool verbose = true, int index = -1);
 143
 144     /**
 145         Saves a image in the output stream.
 146
 147         @param image
 148             The image object which is to be affected by this operation.
 149         @param stream
 150             Opened output stream for writing the data.
 151         @param verbose
 152             If set to @true, errors reported by the image handler will produce
 153             wxLogMessages.
 154
 155         @return @true if the operation succeeded, @false otherwise.
 156
 157         @see wxImage::LoadFile, wxImage::SaveFile, LoadFile()
 158     */
 159     virtual bool SaveFile(wxImage* image, wxOutputStream& stream,
 160                           bool verbose = true);
 161
 162     /**
 163         Sets the handler extension.
 164
 165         @param extension
 166             Handler extension.
 167     */
 168     void SetExtension(const wxString& extension);
 169
 170     /**
 171         Sets the handler MIME type.
 172
 173         @param mimetype
 174             Handler MIME type.
 175     */
 176     void SetMimeType(const wxString& mimetype);
 177
 178     /**
 179         Sets the handler name.
 180
 181         @param name
 182             Handler name.
 183     */
 184     void SetName(const wxString& name);
 185 };
 186
 187
 188 /**
 189     Constant used to indicate the alpha value conventionally defined as
 190     the complete transparency.
 191 */
 192 const unsigned char wxIMAGE_ALPHA_TRANSPARENT = 0;
 193
 194 /**
 195     Constant used to indicate the alpha value conventionally defined as
 196     the complete opacity.
 197 */
 198 const unsigned char wxIMAGE_ALPHA_OPAQUE = 0xff;
 199
 200 /**
 201     @class wxImage
 202
 203     This class encapsulates a platform-independent image.
 204
 205     An image can be created from data, or using wxBitmap::ConvertToImage.
 206     An image can be loaded from a file in a variety of formats, and is extensible
 207     to new formats via image format handlers. Functions are available to set and
 208     get image bits, so it can be used for basic image manipulation.
 209
 210     A wxImage cannot (currently) be drawn directly to a wxDC.
 211     Instead, a platform-specific wxBitmap object must be created from it using
 212     the wxBitmap::wxBitmap(wxImage,int depth) constructor.
 213     This bitmap can then be drawn in a device context, using wxDC::DrawBitmap.
 214
 215     One colour value of the image may be used as a mask colour which will lead to
 216     the automatic creation of a wxMask object associated to the bitmap object.
 217
 218
 219     @section image_alpha Alpha channel support
 220
 221     Starting from wxWidgets 2.5.0 wxImage supports alpha channel data, that is
 222     in addition to a byte for the red, green and blue colour components for each
 223     pixel it also stores a byte representing the pixel opacity.
 224
 225     An alpha value of 0 corresponds to a transparent pixel (null opacity) while
 226     a value of 255 means that the pixel is 100% opaque.
 227     The constants ::wxIMAGE_ALPHA_TRANSPARENT and ::wxIMAGE_ALPHA_OPAQUE can be
 228     used to indicate those values in a more readable form.
 229
 230     Unlike RGB data, not all images have an alpha channel and before using
 231     wxImage::GetAlpha you should check if this image contains an alpha channel
 232     with wxImage::HasAlpha. Note that currently only the PNG format has full
 233     alpha channel support so only the images loaded from PNG files can have
 234     alpha and, if you initialize the image alpha channel yourself using
 235     wxImage::SetAlpha, you should save it in PNG format to avoid losing it.
 236
 237
 238     @section image_handlers Available image handlers
 239
 240     The following image handlers are available.
 241     wxBMPHandler is always installed by default.
 242     To use other image formats, install the appropriate handler with
 243     wxImage::AddHandler or call ::wxInitAllImageHandlers().
 244
 245     - wxBMPHandler: For loading and saving, always installed.
 246     - wxPNGHandler: For loading (including alpha support) and saving.
 247     - wxJPEGHandler: For loading and saving.
 248     - wxGIFHandler: Only for loading, due to legal issues.
 249     - wxPCXHandler: For loading and saving (see below).
 250     - wxPNMHandler: For loading and saving (see below).
 251     - wxTIFFHandler: For loading and saving.
 252     - wxTGAHandler: For loading only.
 253     - wxIFFHandler: For loading only.
 254     - wxXPMHandler: For loading and saving.
 255     - wxICOHandler: For loading and saving.
 256     - wxCURHandler: For loading and saving.
 257     - wxANIHandler: For loading only.
 258
 259     When saving in PCX format, wxPCXHandler will count the number of different
 260     colours in the image; if there are 256 or less colours, it will save as 8 bit,
 261     else it will save as 24 bit.
 262
 263     Loading PNMs only works for ASCII or raw RGB images.
 264     When saving in PNM format, wxPNMHandler will always save as raw RGB.
 265
 266
 267     @library{wxcore}
 268     @category{gdi}
 269
 270     @stdobjects
 271     ::wxNullImage
 272
 273     @see wxBitmap, wxInitAllImageHandlers(), wxPixelData
 274 */
 275 class wxImage : public wxObject
 276 {
 277 public:
 278     class RGBValue
 279     {
 280     public:
 281         /**
 282             Constructor for RGBValue, an object that contains values for red, green
 283             and blue which represent the value of a color.
 284
 285             It is used by wxImage::HSVtoRGB and wxImage::RGBtoHSV, which converts
 286             between HSV color space and RGB color space.
 287         */
 288         RGBValue(unsigned char r=0, unsigned char g=0, unsigned char b=0);
 289     };
 290
 291     class HSVValue
 292     {
 293     public:
 294         /**
 295             Constructor for HSVValue, an object that contains values for hue, saturation
 296             and value which represent the value of a color.
 297
 298             It is used by wxImage::HSVtoRGB() and wxImage::RGBtoHSV(), which converts
 299             between HSV color space and RGB color space.
 300         */
 301         HSVValue(double h=0.0, double s=0.0, double v=0.0);
 302     };
 303
 304     /**
 305         Creates an empty wxImage object without an alpha channel.
 306     */
 307     wxImage();
 308
 309     /**
 310         Creates an image with the given size and clears it if requested.
 311
 312         Does not create an alpha channel.
 313
 314         @param width
 315             Specifies the width of the image.
 316         @param height
 317             Specifies the height of the image.
 318         @param clear
 319             If @true, initialize the image to black.
 320     */
 321     wxImage(int width, int height, bool clear = true);
 322
 323     /**
 324         Creates an image from data in memory. If @a static_data is @false
 325         then the wxImage will take ownership of the data and free it
 326         afterwards. For this, it has to be allocated with @e malloc.
 327
 328         @param width
 329             Specifies the width of the image.
 330         @param height
 331             Specifies the height of the image.
 332         @param data
 333             A pointer to RGB data
 334         @param static_data
 335             Indicates if the data should be free'd after use
 336
 337     */
 338     wxImage(int width, int height, unsigned char* data,  bool static_data = false);
 339
 340     /**
 341         Creates an image from data in memory. If @a static_data is @false
 342         then the wxImage will take ownership of the data and free it
 343         afterwards. For this, it has to be allocated with @e malloc.
 344
 345         @param width
 346             Specifies the width of the image.
 347         @param height
 348             Specifies the height of the image.
 349         @param data
 350             A pointer to RGB data
 351         @param alpha
 352             A pointer to alpha-channel data
 353         @param static_data
 354             Indicates if the data should be free'd after use
 355
 356     */
 357     wxImage(int width, int height, unsigned char* data, unsigned char* alpha,
 358             bool static_data = false );
 359
 360     /**
 361         Creates an image from XPM data.
 362
 363         @param xpmData
 364             A pointer to XPM image data.
 365     */
 366     wxImage(const char* const* xpmData);
 367
 368     /**
 369         Creates an image from a file.
 370
 371         @param name
 372             Name of the file from which to load the image.
 373         @param type
 374             May be one of the following:
 375             @li wxBITMAP_TYPE_BMP: Load a Windows bitmap file.
 376             @li wxBITMAP_TYPE_GIF: Load a GIF bitmap file.
 377             @li wxBITMAP_TYPE_JPEG: Load a JPEG bitmap file.
 378             @li wxBITMAP_TYPE_PNG: Load a PNG bitmap file.
 379             @li wxBITMAP_TYPE_PCX: Load a PCX bitmap file.
 380             @li wxBITMAP_TYPE_PNM: Load a PNM bitmap file.
 381             @li wxBITMAP_TYPE_TIF: Load a TIFF bitmap file.
 382             @li wxBITMAP_TYPE_TGA: Load a TGA bitmap file.
 383             @li wxBITMAP_TYPE_XPM: Load a XPM bitmap file.
 384             @li wxBITMAP_TYPE_ICO: Load a Windows icon file (ICO).
 385             @li wxBITMAP_TYPE_CUR: Load a Windows cursor file (CUR).
 386             @li wxBITMAP_TYPE_ANI: Load a Windows animated cursor file (ANI).
 387             @li wxBITMAP_TYPE_ANY: Will try to autodetect the format.
 388         @param index
 389             Index of the image to load in the case that the image file contains
 390             multiple images. This is only used by GIF, ICO and TIFF handlers.
 391             The default value (-1) means "choose the default image" and is
 392             interpreted as the first image (index=0) by the GIF and TIFF handler
 393             and as the largest and most colourful one by the ICO handler.
 394
 395         @remarks Depending on how wxWidgets has been configured and by which
 396                  handlers have been loaded, not all formats may be available.
 397                  Any handler other than BMP must be previously initialized with
 398                 wxImage::AddHandler or wxInitAllImageHandlers.
 399
 400         @note
 401             You can use GetOptionInt() to get the hotspot when loading cursor files:
 402             @code
 403             int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
 404             int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
 405             @endcode
 406
 407         @see LoadFile()
 408     */
 409     wxImage(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_ANY, int index = -1);
 410
 411     /**
 412         Creates an image from a file using MIME-types to specify the type.
 413
 414         @param name
 415             Name of the file from which to load the image.
 416         @param mimetype
 417             MIME type string (for example 'image/jpeg')
 418         @param index
 419             See description in wxImage(const wxString&, wxBitmapType, int) overload.
 420     */
 421     wxImage(const wxString& name, const wxString& mimetype, int index = -1);
 422
 423     /**
 424         Creates an image from a stream.
 425
 426         @param stream
 427             Opened input stream from which to load the image. Currently,
 428             the stream must support seeking.
 429         @param type
 430             See description in wxImage(const wxString&, wxBitmapType, int) overload.
 431         @param index
 432             See description in wxImage(const wxString&, wxBitmapType, int) overload.
 433     */
 434     wxImage(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY, int index = -1);
 435
 436     /**
 437         Creates an image from a stream using MIME-types to specify the type.
 438
 439         @param stream
 440             Opened input stream from which to load the image. Currently,
 441             the stream must support seeking.
 442         @param mimetype
 443             MIME type string (for example 'image/jpeg')
 444         @param index
 445             See description in wxImage(const wxString&, wxBitmapType, int) overload.
 446     */
 447     wxImage(wxInputStream& stream, const wxString& mimetype, int index = -1);
 448
 449
 450     /**
 451         Destructor.
 452
 453         See @ref overview_refcount_destruct "reference-counted object destruction"
 454         for more info.
 455     */
 456     virtual ~wxImage();
 457
 458     /**
 459         Register an image handler.
 460     */
 461     static void AddHandler(wxImageHandler* handler);
 462
 463     /**
 464         Blurs the image in both horizontal and vertical directions by the
 465         specified pixel @a blurRadius. This should not be used when using
 466         a single mask colour for transparency.
 467
 468         @see BlurHorizontal(), BlurVertical()
 469     */
 470     wxImage Blur(int blurRadius) const;
 471
 472     /**
 473         Blurs the image in the horizontal direction only. This should not be used
 474         when using a single mask colour for transparency.
 475
 476         @see Blur(), BlurVertical()
 477     */
 478     wxImage BlurHorizontal(int blurRadius) const;
 479
 480     /**
 481         Blurs the image in the vertical direction only. This should not be used
 482         when using a single mask colour for transparency.
 483
 484         @see Blur(), BlurHorizontal()
 485     */
 486     wxImage BlurVertical(int blurRadius) const;
 487
 488     /**
 489         Returns @true if the current image handlers can read this file
 490     */
 491     static bool CanRead(const wxString& filename);
 492
 493     /**
 494         Deletes all image handlers.
 495         This function is called by wxWidgets on exit.
 496     */
 497     static void CleanUpHandlers();
 498
 499     /**
 500         Computes the histogram of the image. @a histogram is a reference to
 501         wxImageHistogram object. wxImageHistogram is a specialization of
 502         wxHashMap "template" and is defined as follows:
 503
 504         @code
 505         class WXDLLEXPORT wxImageHistogramEntry
 506         {
 507         public:
 508             wxImageHistogramEntry() : index(0), value(0) {}
 509             unsigned long index;
 510             unsigned long value;
 511         };
 512
 513         WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
 514                                     wxIntegerHash, wxIntegerEqual,
 515                                     wxImageHistogram);
 516         @endcode
 517
 518         @return Returns number of colours in the histogram.
 519     */
 520     unsigned long ComputeHistogram(wxImageHistogram& histogram) const;
 521
 522     /**
 523         If the image has alpha channel, this method converts it to mask.
 524
 525         All pixels with alpha value less than @a threshold are replaced with mask
 526         colour and the alpha channel is removed. Mask colour is chosen automatically
 527         using FindFirstUnusedColour().
 528
 529         If the image image doesn't have alpha channel, ConvertAlphaToMask() does nothing.
 530
 531         @return @false if FindFirstUnusedColour returns @false, @true otherwise.
 532     */
 533     bool ConvertAlphaToMask(unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD);
 534
 535     /**
 536         Returns a greyscale version of the image.
 537
 538         The returned image uses the luminance component of the original to
 539         calculate the greyscale. Defaults to using the standard ITU-T BT.601
 540         when converting to YUV, where every pixel equals
 541         (R * @a lr) + (G * @a lg) + (B * @a lb).
 542     */
 543     wxImage ConvertToGreyscale(double lr = 0.299, double lg = 0.587, double lb = 1.114) const;
 544
 545     /**
 546         Returns monochromatic version of the image.
 547
 548         The returned image has white colour where the original has @e (r,g,b)
 549         colour and black colour everywhere else.
 550     */
 551     wxImage ConvertToMono(unsigned char r, unsigned char g, unsigned char b) const;
 552
 553     /**
 554         Returns an identical copy of the image.
 555     */
 556     wxImage Copy() const;
 557
 558     /**
 559         Creates a fresh image.
 560
 561         If @a clear is @true, the new image will be initialized to black.
 562         Otherwise, the image data will be uninitialized.
 563
 564         @param width
 565             The width of the image in pixels.
 566         @param height
 567             The height of the image in pixels.
 568         @param clear
 569             If @true, initialize the image data with zeros.
 570
 571         @return @true if the call succeeded, @false otherwise.
 572     */
 573     bool Create(int width, int height, bool clear = true);
 574
 575     /**
 576         Destroys the image data.
 577     */
 578     void Destroy();
 579
 580     /**
 581         Finds the first colour that is never used in the image.
 582         The search begins at given initial colour and continues by increasing
 583         R, G and B components (in this order) by 1 until an unused colour is
 584         found or the colour space exhausted.
 585
 586         The parameters @a r, @a g, @a b are pointers to variables to save the colour.
 587
 588         The parameters @a startR, @a startG, @a startB define the initial values
 589         of the colour.
 590         The returned colour will have RGB values equal to or greater than these.
 591
 592         @return Returns @false if there is no unused colour left, @true on success.
 593
 594         @note
 595             This method involves computing the histogram, which is a
 596             computationally intensive operation.
 597     */
 598     bool FindFirstUnusedColour(unsigned char* r, unsigned char* g,
 599                                unsigned char* b, unsigned char startR = 1,
 600                                unsigned char startG = 0,
 601                                unsigned char startB = 0) const;
 602
 603     /**
 604         Finds the handler with the given name.
 605
 606         @param name
 607             The handler name.
 608
 609         @return A pointer to the handler if found, @NULL otherwise.
 610
 611         @see wxImageHandler
 612     */
 613     static wxImageHandler* FindHandler(const wxString& name);
 614
 615     /**
 616         Finds the handler associated with the given extension and type.
 617
 618         @param extension
 619             The file extension, such as "bmp".
 620         @param imageType
 621             The image type; one of the ::wxBitmapType values.
 622
 623         @return A pointer to the handler if found, @NULL otherwise.
 624
 625         @see wxImageHandler
 626     */
 627     static wxImageHandler* FindHandler(const wxString& extension,
 628                                        wxBitmapType imageType);
 629
 630     /**
 631         Finds the handler associated with the given image type.
 632
 633         @param imageType
 634             The image type; one of the ::wxBitmapType values.
 635
 636         @return A pointer to the handler if found, @NULL otherwise.
 637
 638         @see wxImageHandler
 639     */
 640     static wxImageHandler* FindHandler(wxBitmapType imageType);
 641
 642     /**
 643         Finds the handler associated with the given MIME type.
 644
 645         @param mimetype
 646             MIME type.
 647
 648         @return A pointer to the handler if found, @NULL otherwise.
 649
 650         @see wxImageHandler
 651     */
 652     static wxImageHandler* FindHandlerMime(const wxString& mimetype);
 653
 654     /**
 655         Return alpha value at given pixel location.
 656     */
 657     unsigned char GetAlpha(int x, int y) const;
 658
 659     /**
 660         Returns pointer to the array storing the alpha values for this image.
 661
 662         This pointer is @NULL for the images without the alpha channel. If the image
 663         does have it, this pointer may be used to directly manipulate the alpha values
 664         which are stored as the RGB ones.
 665     */
 666     unsigned char* GetAlpha() const;
 667
 668     /**
 669         Returns the blue intensity at the given coordinate.
 670     */
 671     unsigned char GetBlue(int x, int y) const;
 672
 673     /**
 674         Returns the image data as an array.
 675
 676         This is most often used when doing direct image manipulation.
 677         The return value points to an array of characters in RGBRGBRGB... format
 678         in the top-to-bottom, left-to-right order, that is the first RGB triplet
 679         corresponds to the pixel first pixel of the first row, the second one ---
 680         to the second pixel of the first row and so on until the end of the first
 681         row, with second row following after it and so on.
 682
 683         You should not delete the returned pointer nor pass it to SetData().
 684     */
 685     unsigned char* GetData() const;
 686
 687     /**
 688         Returns the green intensity at the given coordinate.
 689     */
 690     unsigned char GetGreen(int x, int y) const;
 691
 692     /**
 693         Returns the static list of image format handlers.
 694
 695         @see wxImageHandler
 696     */
 697     static wxList GetHandlers();
 698
 699     /**
 700         Gets the height of the image in pixels.
 701
 702         @see GetWidth(), GetSize()
 703     */
 704     int GetHeight() const;
 705
 706     //@{
 707     /**
 708         If the image file contains more than one image and the image handler is
 709         capable of retrieving these individually, this function will return the
 710         number of available images.
 711
 712         For the overload taking the parameter @a filename, that's the name
 713         of the file to query.
 714         For the overload taking the parameter @a stream, that's the ppened input
 715         stream with image data. Currently, the stream must support seeking.
 716
 717         The parameter @a type may be one of the following values:
 718         @li wxBITMAP_TYPE_BMP: Load a Windows bitmap file.
 719         @li wxBITMAP_TYPE_GIF: Load a GIF bitmap file.
 720         @li wxBITMAP_TYPE_JPEG: Load a JPEG bitmap file.
 721         @li wxBITMAP_TYPE_PNG: Load a PNG bitmap file.
 722         @li wxBITMAP_TYPE_PCX: Load a PCX bitmap file.
 723         @li wxBITMAP_TYPE_PNM: Load a PNM bitmap file.
 724         @li wxBITMAP_TYPE_TIF: Load a TIFF bitmap file.
 725         @li wxBITMAP_TYPE_TGA: Load a TGA bitmap file.
 726         @li wxBITMAP_TYPE_XPM: Load a XPM bitmap file.
 727         @li wxBITMAP_TYPE_ICO: Load a Windows icon file (ICO).
 728         @li wxBITMAP_TYPE_CUR: Load a Windows cursor file (CUR).
 729         @li wxBITMAP_TYPE_ANI: Load a Windows animated cursor file (ANI).
 730         @li wxBITMAP_TYPE_ANY: Will try to autodetect the format.
 731
 732         @return Number of available images. For most image handlers, this is 1
 733                 (exceptions are TIFF and ICO formats).
 734     */
 735     static int GetImageCount(const wxString& filename,
 736                              wxBitmapType type = wxBITMAP_TYPE_ANY);
 737     static int GetImageCount(wxInputStream& stream,
 738                              wxBitmapType type = wxBITMAP_TYPE_ANY);
 739     //@}
 740
 741     /**
 742         Iterates all registered wxImageHandler objects, and returns a string containing
 743         file extension masks suitable for passing to file open/save dialog boxes.
 744
 745         @return The format of the returned string is @c "(*.ext1;*.ext2)|*.ext1;*.ext2".
 746                 It is usually a good idea to prepend a description before passing
 747                 the result to the dialog.
 748                 Example:
 749                 @code
 750                 wxFileDialog FileDlg( this, "Choose Image", ::wxGetCwd(), "",
 751                                       _("Image Files ") + wxImage::GetImageExtWildcard(),
 752                                       wxFD_OPEN );
 753                 @endcode
 754
 755         @see wxImageHandler
 756     */
 757     static wxString GetImageExtWildcard();
 758
 759     /**
 760         Gets the blue value of the mask colour.
 761     */
 762     unsigned char GetMaskBlue() const;
 763
 764     /**
 765         Gets the green value of the mask colour.
 766     */
 767     unsigned char GetMaskGreen() const;
 768
 769     /**
 770         Gets the red value of the mask colour.
 771     */
 772     unsigned char GetMaskRed() const;
 773
 774     /**
 775         Gets a user-defined string-valued option.
 776
 777         Currently the only defined string option is
 778         @li wxIMAGE_OPTION_FILENAME: The name of the file from which the image
 779             was loaded.
 780
 781         @see SetOption(), GetOptionInt(), HasOption()
 782
 783         @param name
 784             The name of the option, case-insensitive.
 785         @return
 786             The value of the option or an empty string if not found. Use
 787             HasOption() if an empty string can be a valid option value.
 788     */
 789     wxString GetOption(const wxString& name) const;
 790
 791     /**
 792         Gets a user-defined integer-valued option.
 793
 794         The function is case-insensitive to @a name.
 795         If the given option is not present, the function returns 0.
 796         Use HasOption() is 0 is a possibly valid value for the option.
 797
 798         Generic options:
 799         @li wxIMAGE_OPTION_MAX_WIDTH and wxIMAGE_OPTION_MAX_HEIGHT: If either
 800             of these options is specified, the loaded image will be scaled down
 801             (preserving its aspect ratio) so that its width is less than the
 802             max width given if it is not 0 @em and its height is less than the
 803             max height given if it is not 0. This is typically used for loading
 804             thumbnails and the advantage of using these options compared to
 805             calling Rescale() after loading is that some handlers (only JPEG
 806             one right now) support rescaling the image during loading which is
 807             vastly more efficient than loading the entire huge image and
 808             rescaling it later (if these options are not supported by the
 809             handler, this is still what happens however). These options must be
 810             set before calling LoadFile() to have any effect.
 811
 812         @li wxIMAGE_OPTION_QUALITY: JPEG quality used when saving. This is an
 813             integer in 0..100 range with 0 meaning very poor and 100 excellent
 814             (but very badly compressed). This option is currently ignored for
 815             the other formats.
 816
 817         @li wxIMAGE_OPTION_RESOLUTIONUNIT: The value of this option determines
 818             whether the resolution of the image is specified in centimetres or
 819             inches, see wxImageResolution enum elements.
 820
 821         @li wxIMAGE_OPTION_RESOLUTION, wxIMAGE_OPTION_RESOLUTIONX and
 822             wxIMAGE_OPTION_RESOLUTIONY: These options define the resolution of
 823             the image in the units corresponding to wxIMAGE_OPTION_RESOLUTIONUNIT
 824             options value. The first option can be set before saving the image
 825             to set both horizontal and vertical resolution to the same value.
 826             The X and Y options are set by the image handlers if they support
 827             the image resolution (currently BMP, JPEG and TIFF handlers do) and
 828             the image provides the resolution information and can be queried
 829             after loading the image.
 830
 831         Options specific to wxPNGHandler:
 832         @li wxIMAGE_OPTION_PNG_FORMAT: Format for saving a PNG file, see
 833             wxImagePNGType for the supported values.
 834         @li wxIMAGE_OPTION_PNG_BITDEPTH: Bit depth for every channel (R/G/B/A).
 835
 836         @see SetOption(), GetOption()
 837
 838         @param name
 839             The name of the option, case-insensitive.
 840         @return
 841             The value of the option or 0 if not found. Use HasOption() if 0
 842             can be a valid option value.
 843     */
 844     int GetOptionInt(const wxString& name) const;
 845
 846     /**
 847         Get the current mask colour or find a suitable unused colour that could be
 848         used as a mask colour. Returns @true if the image currently has a mask.
 849     */
 850     bool GetOrFindMaskColour(unsigned char* r, unsigned char* g,
 851                              unsigned char* b) const;
 852
 853     /**
 854         Returns the palette associated with the image.
 855         Currently the palette is only used when converting to wxBitmap under Windows.
 856
 857         Some of the wxImage handlers have been modified to set the palette if
 858         one exists in the image file (usually 256 or less colour images in
 859         GIF or PNG format).
 860     */
 861     const wxPalette& GetPalette() const;
 862
 863     /**
 864         Returns the red intensity at the given coordinate.
 865     */
 866     unsigned char GetRed(int x, int y) const;
 867
 868     /**
 869         Returns a sub image of the current one as long as the rect belongs entirely
 870         to the image.
 871     */
 872     wxImage GetSubImage(const wxRect& rect) const;
 873
 874     /**
 875         Returns the size of the image in pixels.
 876
 877         @since 2.9.0
 878
 879         @see GetHeight(), GetWidth()
 880     */
 881     wxSize GetSize() const;
 882
 883     /**
 884         Gets the type of image found by LoadFile() or specified with SaveFile().
 885
 886         @since 2.9.0
 887     */
 888     wxBitmapType GetType() const;
 889
 890     /**
 891         Gets the width of the image in pixels.
 892
 893         @see GetHeight(), GetSize()
 894     */
 895     int GetWidth() const;
 896
 897     /**
 898         Converts a color in HSV color space to RGB color space.
 899     */
 900     static wxImage::RGBValue HSVtoRGB(const wxImage::HSVValue& hsv);
 901
 902     /**
 903         Returns @true if this image has alpha channel, @false otherwise.
 904
 905         @see GetAlpha(), SetAlpha()
 906     */
 907     bool HasAlpha() const;
 908
 909     /**
 910         Returns @true if there is a mask active, @false otherwise.
 911     */
 912     bool HasMask() const;
 913
 914     /**
 915         Returns @true if the given option is present.
 916         The function is case-insensitive to @a name.
 917
 918         @see SetOption(), GetOption(), GetOptionInt()
 919     */
 920     bool HasOption(const wxString& name) const;
 921
 922     /**
 923         Initializes the image alpha channel data.
 924
 925         It is an error to call it if the image already has alpha data.
 926         If it doesn't, alpha data will be by default initialized to all pixels
 927         being fully opaque. But if the image has a mask colour, all mask pixels
 928         will be completely transparent.
 929     */
 930     void InitAlpha();
 931
 932     /**
 933         Internal use only. Adds standard image format handlers.
 934         It only install wxBMPHandler for the time being, which is used by wxBitmap.
 935
 936         This function is called by wxWidgets on startup, and shouldn't be called by
 937         the user.
 938
 939         @see wxImageHandler, wxInitAllImageHandlers(), wxQuantize
 940     */
 941     static void InitStandardHandlers();
 942
 943     /**
 944         Adds a handler at the start of the static list of format handlers.
 945
 946         @param handler
 947             A new image format handler object. There is usually only one instance
 948             of a given handler class in an application session.
 949
 950         @see wxImageHandler
 951     */
 952     static void InsertHandler(wxImageHandler* handler);
 953
 954     /**
 955         Returns @true if image data is present.
 956     */
 957     bool IsOk() const;
 958
 959     /**
 960         Returns @true if the given pixel is transparent, i.e. either has the mask
 961         colour if this image has a mask or if this image has alpha channel and alpha
 962         value of this pixel is strictly less than @a threshold.
 963     */
 964     bool IsTransparent(int x, int y,
 965                        unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD) const;
 966
 967     /**
 968         Loads an image from an input stream.
 969
 970         @param stream
 971             Opened input stream from which to load the image.
 972             Currently, the stream must support seeking.
 973         @param type
 974             May be one of the following:
 975             @li wxBITMAP_TYPE_BMP: Load a Windows bitmap file.
 976             @li wxBITMAP_TYPE_GIF: Load a GIF bitmap file.
 977             @li wxBITMAP_TYPE_JPEG: Load a JPEG bitmap file.
 978             @li wxBITMAP_TYPE_PNG: Load a PNG bitmap file.
 979             @li wxBITMAP_TYPE_PCX: Load a PCX bitmap file.
 980             @li wxBITMAP_TYPE_PNM: Load a PNM bitmap file.
 981             @li wxBITMAP_TYPE_TIF: Load a TIFF bitmap file.
 982             @li wxBITMAP_TYPE_TGA: Load a TGA bitmap file.
 983             @li wxBITMAP_TYPE_XPM: Load a XPM bitmap file.
 984             @li wxBITMAP_TYPE_ICO: Load a Windows icon file (ICO).
 985             @li wxBITMAP_TYPE_CUR: Load a Windows cursor file (CUR).
 986             @li wxBITMAP_TYPE_ANI: Load a Windows animated cursor file (ANI).
 987             @li wxBITMAP_TYPE_ANY: Will try to autodetect the format.
 988         @param index
 989             Index of the image to load in the case that the image file contains
 990             multiple images. This is only used by GIF, ICO and TIFF handlers.
 991             The default value (-1) means "choose the default image" and is
 992             interpreted as the first image (index=0) by the GIF and TIFF handler
 993             and as the largest and most colourful one by the ICO handler.
 994
 995         @return @true if the operation succeeded, @false otherwise.
 996                 If the optional index parameter is out of range, @false is
 997                 returned and a call to wxLogError() takes place.
 998
 999         @remarks Depending on how wxWidgets has been configured, not all formats
1000                  may be available.
1001
1002         @note
1003             You can use GetOptionInt() to get the hotspot when loading cursor files:
1004             @code
1005             int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
1006             int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
1007             @endcode
1008
1009         @see SaveFile()
1010     */
1011     virtual bool LoadFile(wxInputStream& stream,
1012                           wxBitmapType type = wxBITMAP_TYPE_ANY,
1013                           int index = -1);
1014
1015     /**
1016         Loads an image from a file.
1017         If no handler type is provided, the library will try to autodetect the format.
1018
1019         @param name
1020             Name of the file from which to load the image.
1021         @param type
1022             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1023         @param index
1024             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1025     */
1026     virtual bool LoadFile(const wxString& name,
1027                           wxBitmapType type = wxBITMAP_TYPE_ANY,
1028                           int index = -1);
1029
1030     /**
1031         Loads an image from a file.
1032         If no handler type is provided, the library will try to autodetect the format.
1033
1034         @param name
1035             Name of the file from which to load the image.
1036         @param mimetype
1037             MIME type string (for example 'image/jpeg')
1038         @param index
1039             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1040     */
1041     virtual bool LoadFile(const wxString& name, const wxString& mimetype,
1042                           int index = -1);
1043
1044
1045     /**
1046         Loads an image from an input stream.
1047
1048         @param stream
1049             Opened input stream from which to load the image.
1050             Currently, the stream must support seeking.
1051         @param mimetype
1052             MIME type string (for example 'image/jpeg')
1053         @param index
1054             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1055     */
1056     virtual bool LoadFile(wxInputStream& stream, const wxString& mimetype,
1057                           int index = -1);
1058
1059     /**
1060         Returns a mirrored copy of the image.
1061         The parameter @a horizontally indicates the orientation.
1062     */
1063     wxImage Mirror(bool horizontally = true) const;
1064
1065     /**
1066         Copy the data of the given @a image to the specified position in this image.
1067     */
1068     void Paste(const wxImage& image, int x, int y);
1069
1070     /**
1071         Converts a color in RGB color space to HSV color space.
1072     */
1073     static wxImage::HSVValue RGBtoHSV(const wxImage::RGBValue& rgb);
1074
1075     /**
1076         Finds the handler with the given name, and removes it.
1077         The handler is not deleted.
1078
1079         @param name
1080             The handler name.
1081
1082         @return @true if the handler was found and removed, @false otherwise.
1083
1084         @see wxImageHandler
1085     */
1086     static bool RemoveHandler(const wxString& name);
1087
1088     /**
1089         Replaces the colour specified by @e r1,g1,b1 by the colour @e r2,g2,b2.
1090     */
1091     void Replace(unsigned char r1, unsigned char g1,
1092                  unsigned char b1, unsigned char r2,
1093                  unsigned char g2, unsigned char b2);
1094
1095     /**
1096         Changes the size of the image in-place by scaling it: after a call to this
1097         function,the image will have the given width and height.
1098
1099         For a description of the @a quality parameter, see the Scale() function.
1100         Returns the (modified) image itself.
1101
1102         @see Scale()
1103     */
1104     wxImage& Rescale(int width, int height,
1105                     int quality = wxIMAGE_QUALITY_NORMAL);
1106
1107     /**
1108         Changes the size of the image in-place without scaling it by adding either a
1109         border with the given colour or cropping as necessary.
1110
1111         The image is pasted into a new image with the given @a size and background
1112         colour at the position @a pos relative to the upper left of the new image.
1113
1114         If @a red = green = blue = -1 then use either the  current mask colour
1115         if set or find, use, and set a suitable mask colour for any newly exposed
1116         areas.
1117
1118         @return The (modified) image itself.
1119
1120         @see Size()
1121     */
1122     wxImage& Resize(const wxSize& size, const wxPoint& pos, int red = -1,
1123                     int green = -1, int blue = -1);
1124
1125     /**
1126         Rotates the image about the given point, by @a angle radians.
1127
1128         Passing @true to @a interpolating results in better image quality, but is slower.
1129
1130         If the image has a mask, then the mask colour is used for the uncovered
1131         pixels in the rotated image background. Else, black (rgb 0, 0, 0) will be used.
1132
1133         Returns the rotated image, leaving this image intact.
1134     */
1135     wxImage Rotate(double angle, const wxPoint& rotationCentre,
1136                    bool interpolating = true,
1137                    wxPoint* offsetAfterRotation = NULL) const;
1138
1139     /**
1140         Returns a copy of the image rotated 90 degrees in the direction
1141         indicated by @a clockwise.
1142     */
1143     wxImage Rotate90(bool clockwise = true) const;
1144
1145     /**
1146         Rotates the hue of each pixel in the image by @e angle, which is a double in
1147         the range of -1.0 to +1.0, where -1.0 corresponds to -360 degrees and +1.0
1148         corresponds to +360 degrees.
1149     */
1150     void RotateHue(double angle);
1151
1152     /**
1153         Saves an image in the given stream.
1154
1155         @param stream
1156             Opened output stream to save the image to.
1157         @param mimetype
1158             MIME type.
1159
1160         @return @true if the operation succeeded, @false otherwise.
1161
1162         @remarks Depending on how wxWidgets has been configured, not all formats
1163                  may be available.
1164
1165         @note
1166             You can use SetOption() to set the hotspot when saving an image
1167             into a cursor file (default hotspot is in the centre of the image):
1168             @code
1169             image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotspotX);
1170             image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotspotY);
1171             @endcode
1172
1173         @see LoadFile()
1174     */
1175     virtual bool SaveFile(wxOutputStream& stream,
1176                           const wxString& mimetype) const;
1177
1178     /**
1179         Saves an image in the named file.
1180
1181         @param name
1182             Name of the file to save the image to.
1183         @param type
1184             Currently these types can be used:
1185             @li wxBITMAP_TYPE_BMP: Save a BMP image file.
1186             @li wxBITMAP_TYPE_JPEG: Save a JPEG image file.
1187             @li wxBITMAP_TYPE_PNG: Save a PNG image file.
1188             @li wxBITMAP_TYPE_PCX: Save a PCX image file
1189                 (tries to save as 8-bit if possible, falls back to 24-bit otherwise).
1190             @li wxBITMAP_TYPE_PNM: Save a PNM image file (as raw RGB always).
1191             @li wxBITMAP_TYPE_TIFF: Save a TIFF image file.
1192             @li wxBITMAP_TYPE_XPM: Save a XPM image file.
1193             @li wxBITMAP_TYPE_ICO: Save a Windows icon file (ICO).
1194                 The size may be up to 255 wide by 127 high. A single image is saved
1195                 in 8 colors at the size supplied.
1196             @li wxBITMAP_TYPE_CUR: Save a Windows cursor file (CUR).
1197     */
1198     virtual bool SaveFile(const wxString& name, wxBitmapType type) const;
1199
1200     /**
1201         Saves an image in the named file.
1202
1203         @param name
1204             Name of the file to save the image to.
1205         @param mimetype
1206             MIME type.
1207     */
1208     virtual bool SaveFile(const wxString& name, const wxString& mimetype) const;
1209
1210     /**
1211         Saves an image in the named file.
1212
1213         File type is determined from the extension of the file name.
1214         Note that this function may fail if the extension is not recognized!
1215         You can use one of the forms above to save images to files with
1216         non-standard extensions.
1217
1218         @param name
1219             Name of the file to save the image to.
1220     */
1221     virtual bool SaveFile(const wxString& name) const;
1222
1223     /**
1224         Saves an image in the given stream.
1225
1226         @param stream
1227             Opened output stream to save the image to.
1228         @param type
1229             MIME type.
1230     */
1231     virtual bool SaveFile(wxOutputStream& stream, wxBitmapType type) const;
1232
1233     /**
1234         Returns a scaled version of the image.
1235
1236         This is also useful for scaling bitmaps in general as the only other way
1237         to scale bitmaps is to blit a wxMemoryDC into another wxMemoryDC.
1238
1239         The parameter @a quality determines what method to use for resampling the image.
1240         Can be one of the following:
1241         - wxIMAGE_QUALITY_NORMAL: Uses the normal default scaling method of pixel
1242                                   replication
1243         - wxIMAGE_QUALITY_HIGH: Uses bicubic and box averaging resampling methods
1244                                 for upsampling and downsampling respectively
1245
1246         It should be noted that although using @c wxIMAGE_QUALITY_HIGH produces much nicer
1247         looking results it is a slower method. Downsampling will use the box averaging
1248         method which seems to operate very fast. If you are upsampling larger images using
1249         this method you will most likely notice that it is a bit slower and in extreme
1250         cases it will be quite substantially slower as the bicubic algorithm has to process a
1251         lot of data.
1252
1253         It should also be noted that the high quality scaling may not work as expected
1254         when using a single mask colour for transparency, as the scaling will blur the
1255         image and will therefore remove the mask partially. Using the alpha channel
1256         will work.
1257
1258         Example:
1259         @code
1260         // get the bitmap from somewhere
1261         wxBitmap bmp = ...;
1262
1263         // rescale it to have size of 32*32
1264         if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
1265         {
1266             wxImage image = bmp.ConvertToImage();
1267             bmp = wxBitmap(image.Scale(32, 32));
1268
1269             // another possibility:
1270             image.Rescale(32, 32);
1271             bmp = image;
1272         }
1273         @endcode
1274
1275         @see Rescale()
1276     */
1277     wxImage Scale(int width, int height,
1278                   int quality = wxIMAGE_QUALITY_NORMAL) const;
1279
1280     /**
1281        This function is similar to SetData() and has similar restrictions.
1282
1283         The pointer passed to it may however be @NULL in which case the function
1284         will allocate the alpha array internally -- this is useful to add alpha
1285         channel data to an image which doesn't have any.
1286
1287         If the pointer is not @NULL, it must have one byte for each image pixel
1288         and be allocated with malloc().
1289         wxImage takes ownership of the pointer and will free it unless @a static_data
1290         parameter is set to @true -- in this case the caller should do it.
1291     */
1292     void SetAlpha(unsigned char* alpha = NULL,
1293                   bool static_data = false);
1294
1295     /**
1296         Sets the alpha value for the given pixel.
1297         This function should only be called if the image has alpha channel data,
1298         use HasAlpha() to check for this.
1299     */
1300     void SetAlpha(int x, int y, unsigned char alpha);
1301
1302     //@{
1303     /**
1304         Sets the image data without performing checks.
1305
1306         The data given must have the size (width*height*3) or results will be
1307         unexpected. Don't use this method if you aren't sure you know what you
1308         are doing.
1309
1310         The data must have been allocated with @c malloc(), @b NOT with
1311         @c operator new.
1312
1313         After this call the pointer to the data is owned by the wxImage object,
1314         that will be responsible for deleting it.
1315         Do not pass to this function a pointer obtained through GetData().
1316     */
1317     void SetData(unsigned char* data, bool static_data = false);
1318     void SetData(unsigned char* data, int new_width, int new_height,
1319                  bool static_data = false);
1320     //@}
1321
1322     /**
1323         Specifies whether there is a mask or not.
1324
1325         The area of the mask is determined by the current mask colour.
1326     */
1327     void SetMask(bool hasMask = true);
1328
1329     /**
1330         Sets the mask colour for this image (and tells the image to use the mask).
1331     */
1332     void SetMaskColour(unsigned char red, unsigned char green,
1333                        unsigned char blue);
1334
1335     /**
1336         Sets image's mask so that the pixels that have RGB value of mr,mg,mb in
1337         mask will be masked in the image.
1338
1339         This is done by first finding an unused colour in the image, setting
1340         this colour as the mask colour and then using this colour to draw all
1341         pixels in the image who corresponding pixel in mask has given RGB value.
1342
1343         The parameter @a mask is the mask image to extract mask shape from.
1344         It must have the same dimensions as the image.
1345
1346         The parameters @a mr, @a mg, @a mb are the RGB values of the pixels in
1347         mask that will be used to create the mask.
1348
1349         @return Returns @false if mask does not have same dimensions as the image
1350                 or if there is no unused colour left. Returns @true if the mask
1351                 was successfully applied.
1352
1353         @note
1354             Note that this method involves computing the histogram, which is a
1355             computationally intensive operation.
1356     */
1357     bool SetMaskFromImage(const wxImage& mask, unsigned char mr,
1358                           unsigned char mg,
1359                           unsigned char mb);
1360
1361     //@{
1362     /**
1363         Sets a user-defined option. The function is case-insensitive to @a name.
1364
1365         For example, when saving as a JPEG file, the option @b quality is
1366         used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
1367
1368         @see GetOption(), GetOptionInt(), HasOption()
1369     */
1370     void SetOption(const wxString& name, const wxString& value);
1371     void SetOption(const wxString& name, int value);
1372     //@}
1373
1374     /**
1375         Associates a palette with the image.
1376
1377         The palette may be used when converting wxImage to wxBitmap (MSW only at present)
1378         or in file save operations (none as yet).
1379     */
1380     void SetPalette(const wxPalette& palette);
1381
1382     /**
1383         Sets the colour of the pixels within the given rectangle.
1384
1385         This routine performs bounds-checks for the coordinate so it can be considered
1386         a safe way to manipulate the data.
1387     */
1388     void SetRGB(const wxRect& rect,
1389                 unsigned char red,
1390                 unsigned char green,
1391                 unsigned char blue);
1392
1393     /**
1394         Set the type of image returned by GetType().
1395
1396         This method is mostly used internally by the library but can also be
1397         called from the user code if the image was created from data in the
1398         given bitmap format without using LoadFile() (which would set the type
1399         correctly automatically).
1400
1401         Notice that the image must be created before this function is called.
1402
1403         @since 2.9.0
1404
1405         @param type
1406             One of bitmap type constants, @c wxBITMAP_TYPE_INVALID is a valid
1407             value for it and can be used to reset the bitmap type to default
1408             but @c wxBITMAP_TYPE_MAX is not allowed here.
1409     */
1410     void SetType(wxBitmapType type);
1411
1412     /**
1413         Returns a resized version of this image without scaling it by adding either a
1414         border with the given colour or cropping as necessary.
1415
1416         The image is pasted into a new image with the given @a size and background
1417         colour at the position @a pos relative to the upper left of the new image.
1418
1419         If @a red = green = blue = -1 then the areas of the larger image not covered
1420         by this image are made transparent by filling them with the image mask colour
1421         (which will be allocated automatically if it isn't currently set).
1422
1423         Otherwise, the areas will be filled with the colour with the specified RGB components.
1424
1425         @see Resize()
1426     */
1427     wxImage Size(const wxSize& size, const wxPoint& pos, int red = -1,
1428                  int green = -1, int blue = -1) const;
1429
1430     /**
1431         Assignment operator, using @ref overview_refcount "reference counting".
1432
1433         @param image
1434             Image to assign.
1435
1436         @return Returns 'this' object.
1437     */
1438     wxImage& operator=(const wxImage& image);
1439 };
1440
1441 // ============================================================================
1442 // Global functions/macros
1443 // ============================================================================
1444
1445 /** @ingroup group_funcmacro_appinitterm */
1446 //@{
1447
1448 /**
1449     Initializes all available image handlers. For a list of available handlers,
1450     see wxImage.
1451
1452     @see wxImage, wxImageHandler
1453
1454     @header{wx/image.h}
1455 */
1456 void wxInitAllImageHandlers();
1457
1458 //@}
1459