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 zeroes.
 570
 571         @return @true if the call succeeded, @false otherwise.
 572     */
 573     bool Create(int width, int height, bool clear = true);
 574
 575     /**
 576         Initialize the image data with zeroes (the default) or with the
 577         byte value given as @a value.
 578
 579         @since 2.9.0
 580     */
 581     void Clear(unsigned char value = 0);
 582
 583     /**
 584         Destroys the image data.
 585     */
 586     void Destroy();
 587
 588     /**
 589         Finds the first colour that is never used in the image.
 590         The search begins at given initial colour and continues by increasing
 591         R, G and B components (in this order) by 1 until an unused colour is
 592         found or the colour space exhausted.
 593
 594         The parameters @a r, @a g, @a b are pointers to variables to save the colour.
 595
 596         The parameters @a startR, @a startG, @a startB define the initial values
 597         of the colour.
 598         The returned colour will have RGB values equal to or greater than these.
 599
 600         @return Returns @false if there is no unused colour left, @true on success.
 601
 602         @note
 603             This method involves computing the histogram, which is a
 604             computationally intensive operation.
 605     */
 606     bool FindFirstUnusedColour(unsigned char* r, unsigned char* g,
 607                                unsigned char* b, unsigned char startR = 1,
 608                                unsigned char startG = 0,
 609                                unsigned char startB = 0) const;
 610
 611     /**
 612         Finds the handler with the given name.
 613
 614         @param name
 615             The handler name.
 616
 617         @return A pointer to the handler if found, @NULL otherwise.
 618
 619         @see wxImageHandler
 620     */
 621     static wxImageHandler* FindHandler(const wxString& name);
 622
 623     /**
 624         Finds the handler associated with the given extension and type.
 625
 626         @param extension
 627             The file extension, such as "bmp".
 628         @param imageType
 629             The image type; one of the ::wxBitmapType values.
 630
 631         @return A pointer to the handler if found, @NULL otherwise.
 632
 633         @see wxImageHandler
 634     */
 635     static wxImageHandler* FindHandler(const wxString& extension,
 636                                        wxBitmapType imageType);
 637
 638     /**
 639         Finds the handler associated with the given image type.
 640
 641         @param imageType
 642             The image type; one of the ::wxBitmapType values.
 643
 644         @return A pointer to the handler if found, @NULL otherwise.
 645
 646         @see wxImageHandler
 647     */
 648     static wxImageHandler* FindHandler(wxBitmapType imageType);
 649
 650     /**
 651         Finds the handler associated with the given MIME type.
 652
 653         @param mimetype
 654             MIME type.
 655
 656         @return A pointer to the handler if found, @NULL otherwise.
 657
 658         @see wxImageHandler
 659     */
 660     static wxImageHandler* FindHandlerMime(const wxString& mimetype);
 661
 662     /**
 663         Return alpha value at given pixel location.
 664     */
 665     unsigned char GetAlpha(int x, int y) const;
 666
 667     /**
 668         Returns pointer to the array storing the alpha values for this image.
 669
 670         This pointer is @NULL for the images without the alpha channel. If the image
 671         does have it, this pointer may be used to directly manipulate the alpha values
 672         which are stored as the RGB ones.
 673     */
 674     unsigned char* GetAlpha() const;
 675
 676     /**
 677         Returns the blue intensity at the given coordinate.
 678     */
 679     unsigned char GetBlue(int x, int y) const;
 680
 681     /**
 682         Returns the image data as an array.
 683
 684         This is most often used when doing direct image manipulation.
 685         The return value points to an array of characters in RGBRGBRGB... format
 686         in the top-to-bottom, left-to-right order, that is the first RGB triplet
 687         corresponds to the pixel first pixel of the first row, the second one ---
 688         to the second pixel of the first row and so on until the end of the first
 689         row, with second row following after it and so on.
 690
 691         You should not delete the returned pointer nor pass it to SetData().
 692     */
 693     unsigned char* GetData() const;
 694
 695     /**
 696         Returns the green intensity at the given coordinate.
 697     */
 698     unsigned char GetGreen(int x, int y) const;
 699
 700     /**
 701         Returns the static list of image format handlers.
 702
 703         @see wxImageHandler
 704     */
 705     static wxList& GetHandlers();
 706
 707     /**
 708         Gets the height of the image in pixels.
 709
 710         @see GetWidth(), GetSize()
 711     */
 712     int GetHeight() const;
 713
 714     //@{
 715     /**
 716         If the image file contains more than one image and the image handler is
 717         capable of retrieving these individually, this function will return the
 718         number of available images.
 719
 720         For the overload taking the parameter @a filename, that's the name
 721         of the file to query.
 722         For the overload taking the parameter @a stream, that's the ppened input
 723         stream with image data. Currently, the stream must support seeking.
 724
 725         The parameter @a type may be one of the following values:
 726         @li wxBITMAP_TYPE_BMP: Load a Windows bitmap file.
 727         @li wxBITMAP_TYPE_GIF: Load a GIF bitmap file.
 728         @li wxBITMAP_TYPE_JPEG: Load a JPEG bitmap file.
 729         @li wxBITMAP_TYPE_PNG: Load a PNG bitmap file.
 730         @li wxBITMAP_TYPE_PCX: Load a PCX bitmap file.
 731         @li wxBITMAP_TYPE_PNM: Load a PNM bitmap file.
 732         @li wxBITMAP_TYPE_TIF: Load a TIFF bitmap file.
 733         @li wxBITMAP_TYPE_TGA: Load a TGA bitmap file.
 734         @li wxBITMAP_TYPE_XPM: Load a XPM bitmap file.
 735         @li wxBITMAP_TYPE_ICO: Load a Windows icon file (ICO).
 736         @li wxBITMAP_TYPE_CUR: Load a Windows cursor file (CUR).
 737         @li wxBITMAP_TYPE_ANI: Load a Windows animated cursor file (ANI).
 738         @li wxBITMAP_TYPE_ANY: Will try to autodetect the format.
 739
 740         @return Number of available images. For most image handlers, this is 1
 741                 (exceptions are TIFF and ICO formats).
 742     */
 743     static int GetImageCount(const wxString& filename,
 744                              wxBitmapType type = wxBITMAP_TYPE_ANY);
 745     static int GetImageCount(wxInputStream& stream,
 746                              wxBitmapType type = wxBITMAP_TYPE_ANY);
 747     //@}
 748
 749     /**
 750         Iterates all registered wxImageHandler objects, and returns a string containing
 751         file extension masks suitable for passing to file open/save dialog boxes.
 752
 753         @return The format of the returned string is @c "(*.ext1;*.ext2)|*.ext1;*.ext2".
 754                 It is usually a good idea to prepend a description before passing
 755                 the result to the dialog.
 756                 Example:
 757                 @code
 758                 wxFileDialog FileDlg( this, "Choose Image", ::wxGetCwd(), "",
 759                                       _("Image Files ") + wxImage::GetImageExtWildcard(),
 760                                       wxFD_OPEN );
 761                 @endcode
 762
 763         @see wxImageHandler
 764     */
 765     static wxString GetImageExtWildcard();
 766
 767     /**
 768         Gets the blue value of the mask colour.
 769     */
 770     unsigned char GetMaskBlue() const;
 771
 772     /**
 773         Gets the green value of the mask colour.
 774     */
 775     unsigned char GetMaskGreen() const;
 776
 777     /**
 778         Gets the red value of the mask colour.
 779     */
 780     unsigned char GetMaskRed() const;
 781
 782     /**
 783         Gets a user-defined string-valued option.
 784
 785         Currently the only defined string option is
 786         @li wxIMAGE_OPTION_FILENAME: The name of the file from which the image
 787             was loaded.
 788
 789         @see SetOption(), GetOptionInt(), HasOption()
 790
 791         @param name
 792             The name of the option, case-insensitive.
 793         @return
 794             The value of the option or an empty string if not found. Use
 795             HasOption() if an empty string can be a valid option value.
 796     */
 797     wxString GetOption(const wxString& name) const;
 798
 799     /**
 800         Gets a user-defined integer-valued option.
 801
 802         The function is case-insensitive to @a name.
 803         If the given option is not present, the function returns 0.
 804         Use HasOption() is 0 is a possibly valid value for the option.
 805
 806         Generic options:
 807         @li wxIMAGE_OPTION_MAX_WIDTH and wxIMAGE_OPTION_MAX_HEIGHT: If either
 808             of these options is specified, the loaded image will be scaled down
 809             (preserving its aspect ratio) so that its width is less than the
 810             max width given if it is not 0 @em and its height is less than the
 811             max height given if it is not 0. This is typically used for loading
 812             thumbnails and the advantage of using these options compared to
 813             calling Rescale() after loading is that some handlers (only JPEG
 814             one right now) support rescaling the image during loading which is
 815             vastly more efficient than loading the entire huge image and
 816             rescaling it later (if these options are not supported by the
 817             handler, this is still what happens however). These options must be
 818             set before calling LoadFile() to have any effect.
 819
 820         @li wxIMAGE_OPTION_QUALITY: JPEG quality used when saving. This is an
 821             integer in 0..100 range with 0 meaning very poor and 100 excellent
 822             (but very badly compressed). This option is currently ignored for
 823             the other formats.
 824
 825         @li wxIMAGE_OPTION_RESOLUTIONUNIT: The value of this option determines
 826             whether the resolution of the image is specified in centimetres or
 827             inches, see wxImageResolution enum elements.
 828
 829         @li wxIMAGE_OPTION_RESOLUTION, wxIMAGE_OPTION_RESOLUTIONX and
 830             wxIMAGE_OPTION_RESOLUTIONY: These options define the resolution of
 831             the image in the units corresponding to wxIMAGE_OPTION_RESOLUTIONUNIT
 832             options value. The first option can be set before saving the image
 833             to set both horizontal and vertical resolution to the same value.
 834             The X and Y options are set by the image handlers if they support
 835             the image resolution (currently BMP, JPEG and TIFF handlers do) and
 836             the image provides the resolution information and can be queried
 837             after loading the image.
 838
 839         Options specific to wxPNGHandler:
 840         @li wxIMAGE_OPTION_PNG_FORMAT: Format for saving a PNG file, see
 841             wxImagePNGType for the supported values.
 842         @li wxIMAGE_OPTION_PNG_BITDEPTH: Bit depth for every channel (R/G/B/A).
 843
 844         @see SetOption(), GetOption()
 845
 846         @param name
 847             The name of the option, case-insensitive.
 848         @return
 849             The value of the option or 0 if not found. Use HasOption() if 0
 850             can be a valid option value.
 851     */
 852     int GetOptionInt(const wxString& name) const;
 853
 854     /**
 855         Get the current mask colour or find a suitable unused colour that could be
 856         used as a mask colour. Returns @true if the image currently has a mask.
 857     */
 858     bool GetOrFindMaskColour(unsigned char* r, unsigned char* g,
 859                              unsigned char* b) const;
 860
 861     /**
 862         Returns the palette associated with the image.
 863         Currently the palette is only used when converting to wxBitmap under Windows.
 864
 865         Some of the wxImage handlers have been modified to set the palette if
 866         one exists in the image file (usually 256 or less colour images in
 867         GIF or PNG format).
 868     */
 869     const wxPalette& GetPalette() const;
 870
 871     /**
 872         Returns the red intensity at the given coordinate.
 873     */
 874     unsigned char GetRed(int x, int y) const;
 875
 876     /**
 877         Returns a sub image of the current one as long as the rect belongs entirely
 878         to the image.
 879     */
 880     wxImage GetSubImage(const wxRect& rect) const;
 881
 882     /**
 883         Returns the size of the image in pixels.
 884
 885         @since 2.9.0
 886
 887         @see GetHeight(), GetWidth()
 888     */
 889     wxSize GetSize() const;
 890
 891     /**
 892         Gets the type of image found by LoadFile() or specified with SaveFile().
 893
 894         @since 2.9.0
 895     */
 896     wxBitmapType GetType() const;
 897
 898     /**
 899         Gets the width of the image in pixels.
 900
 901         @see GetHeight(), GetSize()
 902     */
 903     int GetWidth() const;
 904
 905     /**
 906         Converts a color in HSV color space to RGB color space.
 907     */
 908     static wxImage::RGBValue HSVtoRGB(const wxImage::HSVValue& hsv);
 909
 910     /**
 911         Returns @true if this image has alpha channel, @false otherwise.
 912
 913         @see GetAlpha(), SetAlpha()
 914     */
 915     bool HasAlpha() const;
 916
 917     /**
 918         Returns @true if there is a mask active, @false otherwise.
 919     */
 920     bool HasMask() const;
 921
 922     /**
 923         Returns @true if the given option is present.
 924         The function is case-insensitive to @a name.
 925
 926         @see SetOption(), GetOption(), GetOptionInt()
 927     */
 928     bool HasOption(const wxString& name) const;
 929
 930     /**
 931         Initializes the image alpha channel data.
 932
 933         It is an error to call it if the image already has alpha data.
 934         If it doesn't, alpha data will be by default initialized to all pixels
 935         being fully opaque. But if the image has a mask colour, all mask pixels
 936         will be completely transparent.
 937     */
 938     void InitAlpha();
 939
 940     /**
 941         Internal use only. Adds standard image format handlers.
 942         It only install wxBMPHandler for the time being, which is used by wxBitmap.
 943
 944         This function is called by wxWidgets on startup, and shouldn't be called by
 945         the user.
 946
 947         @see wxImageHandler, wxInitAllImageHandlers(), wxQuantize
 948     */
 949     static void InitStandardHandlers();
 950
 951     /**
 952         Adds a handler at the start of the static list of format handlers.
 953
 954         @param handler
 955             A new image format handler object. There is usually only one instance
 956             of a given handler class in an application session.
 957
 958         @see wxImageHandler
 959     */
 960     static void InsertHandler(wxImageHandler* handler);
 961
 962     /**
 963         Returns @true if image data is present.
 964     */
 965     bool IsOk() const;
 966
 967     /**
 968         Returns @true if the given pixel is transparent, i.e. either has the mask
 969         colour if this image has a mask or if this image has alpha channel and alpha
 970         value of this pixel is strictly less than @a threshold.
 971     */
 972     bool IsTransparent(int x, int y,
 973                        unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD) const;
 974
 975     /**
 976         Loads an image from an input stream.
 977
 978         @param stream
 979             Opened input stream from which to load the image.
 980             Currently, the stream must support seeking.
 981         @param type
 982             May be one of the following:
 983             @li wxBITMAP_TYPE_BMP: Load a Windows bitmap file.
 984             @li wxBITMAP_TYPE_GIF: Load a GIF bitmap file.
 985             @li wxBITMAP_TYPE_JPEG: Load a JPEG bitmap file.
 986             @li wxBITMAP_TYPE_PNG: Load a PNG bitmap file.
 987             @li wxBITMAP_TYPE_PCX: Load a PCX bitmap file.
 988             @li wxBITMAP_TYPE_PNM: Load a PNM bitmap file.
 989             @li wxBITMAP_TYPE_TIF: Load a TIFF bitmap file.
 990             @li wxBITMAP_TYPE_TGA: Load a TGA bitmap file.
 991             @li wxBITMAP_TYPE_XPM: Load a XPM bitmap file.
 992             @li wxBITMAP_TYPE_ICO: Load a Windows icon file (ICO).
 993             @li wxBITMAP_TYPE_CUR: Load a Windows cursor file (CUR).
 994             @li wxBITMAP_TYPE_ANI: Load a Windows animated cursor file (ANI).
 995             @li wxBITMAP_TYPE_ANY: Will try to autodetect the format.
 996         @param index
 997             Index of the image to load in the case that the image file contains
 998             multiple images. This is only used by GIF, ICO and TIFF handlers.
 999             The default value (-1) means "choose the default image" and is
1000             interpreted as the first image (index=0) by the GIF and TIFF handler
1001             and as the largest and most colourful one by the ICO handler.
1002
1003         @return @true if the operation succeeded, @false otherwise.
1004                 If the optional index parameter is out of range, @false is
1005                 returned and a call to wxLogError() takes place.
1006
1007         @remarks Depending on how wxWidgets has been configured, not all formats
1008                  may be available.
1009
1010         @note
1011             You can use GetOptionInt() to get the hotspot when loading cursor files:
1012             @code
1013             int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
1014             int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
1015             @endcode
1016
1017         @see SaveFile()
1018     */
1019     virtual bool LoadFile(wxInputStream& stream,
1020                           wxBitmapType type = wxBITMAP_TYPE_ANY,
1021                           int index = -1);
1022
1023     /**
1024         Loads an image from a file.
1025         If no handler type is provided, the library will try to autodetect the format.
1026
1027         @param name
1028             Name of the file from which to load the image.
1029         @param type
1030             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1031         @param index
1032             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1033     */
1034     virtual bool LoadFile(const wxString& name,
1035                           wxBitmapType type = wxBITMAP_TYPE_ANY,
1036                           int index = -1);
1037
1038     /**
1039         Loads an image from a file.
1040         If no handler type is provided, the library will try to autodetect the format.
1041
1042         @param name
1043             Name of the file from which to load the image.
1044         @param mimetype
1045             MIME type string (for example 'image/jpeg')
1046         @param index
1047             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1048     */
1049     virtual bool LoadFile(const wxString& name, const wxString& mimetype,
1050                           int index = -1);
1051
1052
1053     /**
1054         Loads an image from an input stream.
1055
1056         @param stream
1057             Opened input stream from which to load the image.
1058             Currently, the stream must support seeking.
1059         @param mimetype
1060             MIME type string (for example 'image/jpeg')
1061         @param index
1062             See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
1063     */
1064     virtual bool LoadFile(wxInputStream& stream, const wxString& mimetype,
1065                           int index = -1);
1066
1067     /**
1068         Returns a mirrored copy of the image.
1069         The parameter @a horizontally indicates the orientation.
1070     */
1071     wxImage Mirror(bool horizontally = true) const;
1072
1073     /**
1074         Copy the data of the given @a image to the specified position in this image.
1075     */
1076     void Paste(const wxImage& image, int x, int y);
1077
1078     /**
1079         Converts a color in RGB color space to HSV color space.
1080     */
1081     static wxImage::HSVValue RGBtoHSV(const wxImage::RGBValue& rgb);
1082
1083     /**
1084         Finds the handler with the given name, and removes it.
1085         The handler is not deleted.
1086
1087         @param name
1088             The handler name.
1089
1090         @return @true if the handler was found and removed, @false otherwise.
1091
1092         @see wxImageHandler
1093     */
1094     static bool RemoveHandler(const wxString& name);
1095
1096     /**
1097         Replaces the colour specified by @e r1,g1,b1 by the colour @e r2,g2,b2.
1098     */
1099     void Replace(unsigned char r1, unsigned char g1,
1100                  unsigned char b1, unsigned char r2,
1101                  unsigned char g2, unsigned char b2);
1102
1103     /**
1104         Changes the size of the image in-place by scaling it: after a call to this
1105         function,the image will have the given width and height.
1106
1107         For a description of the @a quality parameter, see the Scale() function.
1108         Returns the (modified) image itself.
1109
1110         @see Scale()
1111     */
1112     wxImage& Rescale(int width, int height,
1113                     int quality = wxIMAGE_QUALITY_NORMAL);
1114
1115     /**
1116         Changes the size of the image in-place without scaling it by adding either a
1117         border with the given colour or cropping as necessary.
1118
1119         The image is pasted into a new image with the given @a size and background
1120         colour at the position @a pos relative to the upper left of the new image.
1121
1122         If @a red = green = blue = -1 then use either the  current mask colour
1123         if set or find, use, and set a suitable mask colour for any newly exposed
1124         areas.
1125
1126         @return The (modified) image itself.
1127
1128         @see Size()
1129     */
1130     wxImage& Resize(const wxSize& size, const wxPoint& pos, int red = -1,
1131                     int green = -1, int blue = -1);
1132
1133     /**
1134         Rotates the image about the given point, by @a angle radians.
1135
1136         Passing @true to @a interpolating results in better image quality, but is slower.
1137
1138         If the image has a mask, then the mask colour is used for the uncovered
1139         pixels in the rotated image background. Else, black (rgb 0, 0, 0) will be used.
1140
1141         Returns the rotated image, leaving this image intact.
1142     */
1143     wxImage Rotate(double angle, const wxPoint& rotationCentre,
1144                    bool interpolating = true,
1145                    wxPoint* offsetAfterRotation = NULL) const;
1146
1147     /**
1148         Returns a copy of the image rotated 90 degrees in the direction
1149         indicated by @a clockwise.
1150     */
1151     wxImage Rotate90(bool clockwise = true) const;
1152
1153     /**
1154         Rotates the hue of each pixel in the image by @e angle, which is a double in
1155         the range of -1.0 to +1.0, where -1.0 corresponds to -360 degrees and +1.0
1156         corresponds to +360 degrees.
1157     */
1158     void RotateHue(double angle);
1159
1160     /**
1161         Saves an image in the given stream.
1162
1163         @param stream
1164             Opened output stream to save the image to.
1165         @param mimetype
1166             MIME type.
1167
1168         @return @true if the operation succeeded, @false otherwise.
1169
1170         @remarks Depending on how wxWidgets has been configured, not all formats
1171                  may be available.
1172
1173         @note
1174             You can use SetOption() to set the hotspot when saving an image
1175             into a cursor file (default hotspot is in the centre of the image):
1176             @code
1177             image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotspotX);
1178             image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotspotY);
1179             @endcode
1180
1181         @see LoadFile()
1182     */
1183     virtual bool SaveFile(wxOutputStream& stream,
1184                           const wxString& mimetype) const;
1185
1186     /**
1187         Saves an image in the named file.
1188
1189         @param name
1190             Name of the file to save the image to.
1191         @param type
1192             Currently these types can be used:
1193             @li wxBITMAP_TYPE_BMP: Save a BMP image file.
1194             @li wxBITMAP_TYPE_JPEG: Save a JPEG image file.
1195             @li wxBITMAP_TYPE_PNG: Save a PNG image file.
1196             @li wxBITMAP_TYPE_PCX: Save a PCX image file
1197                 (tries to save as 8-bit if possible, falls back to 24-bit otherwise).
1198             @li wxBITMAP_TYPE_PNM: Save a PNM image file (as raw RGB always).
1199             @li wxBITMAP_TYPE_TIFF: Save a TIFF image file.
1200             @li wxBITMAP_TYPE_XPM: Save a XPM image file.
1201             @li wxBITMAP_TYPE_ICO: Save a Windows icon file (ICO).
1202                 The size may be up to 255 wide by 127 high. A single image is saved
1203                 in 8 colors at the size supplied.
1204             @li wxBITMAP_TYPE_CUR: Save a Windows cursor file (CUR).
1205     */
1206     virtual bool SaveFile(const wxString& name, wxBitmapType type) const;
1207
1208     /**
1209         Saves an image in the named file.
1210
1211         @param name
1212             Name of the file to save the image to.
1213         @param mimetype
1214             MIME type.
1215     */
1216     virtual bool SaveFile(const wxString& name, const wxString& mimetype) const;
1217
1218     /**
1219         Saves an image in the named file.
1220
1221         File type is determined from the extension of the file name.
1222         Note that this function may fail if the extension is not recognized!
1223         You can use one of the forms above to save images to files with
1224         non-standard extensions.
1225
1226         @param name
1227             Name of the file to save the image to.
1228     */
1229     virtual bool SaveFile(const wxString& name) const;
1230
1231     /**
1232         Saves an image in the given stream.
1233
1234         @param stream
1235             Opened output stream to save the image to.
1236         @param type
1237             MIME type.
1238     */
1239     virtual bool SaveFile(wxOutputStream& stream, wxBitmapType type) const;
1240
1241     /**
1242         Returns a scaled version of the image.
1243
1244         This is also useful for scaling bitmaps in general as the only other way
1245         to scale bitmaps is to blit a wxMemoryDC into another wxMemoryDC.
1246
1247         The parameter @a quality determines what method to use for resampling the image.
1248         Can be one of the following:
1249         - wxIMAGE_QUALITY_NORMAL: Uses the normal default scaling method of pixel
1250                                   replication
1251         - wxIMAGE_QUALITY_HIGH: Uses bicubic and box averaging resampling methods
1252                                 for upsampling and downsampling respectively
1253
1254         It should be noted that although using @c wxIMAGE_QUALITY_HIGH produces much nicer
1255         looking results it is a slower method. Downsampling will use the box averaging
1256         method which seems to operate very fast. If you are upsampling larger images using
1257         this method you will most likely notice that it is a bit slower and in extreme
1258         cases it will be quite substantially slower as the bicubic algorithm has to process a
1259         lot of data.
1260
1261         It should also be noted that the high quality scaling may not work as expected
1262         when using a single mask colour for transparency, as the scaling will blur the
1263         image and will therefore remove the mask partially. Using the alpha channel
1264         will work.
1265
1266         Example:
1267         @code
1268         // get the bitmap from somewhere
1269         wxBitmap bmp = ...;
1270
1271         // rescale it to have size of 32*32
1272         if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
1273         {
1274             wxImage image = bmp.ConvertToImage();
1275             bmp = wxBitmap(image.Scale(32, 32));
1276
1277             // another possibility:
1278             image.Rescale(32, 32);
1279             bmp = image;
1280         }
1281         @endcode
1282
1283         @see Rescale()
1284     */
1285     wxImage Scale(int width, int height,
1286                   int quality = wxIMAGE_QUALITY_NORMAL) const;
1287
1288     /**
1289        This function is similar to SetData() and has similar restrictions.
1290
1291         The pointer passed to it may however be @NULL in which case the function
1292         will allocate the alpha array internally -- this is useful to add alpha
1293         channel data to an image which doesn't have any.
1294
1295         If the pointer is not @NULL, it must have one byte for each image pixel
1296         and be allocated with malloc().
1297         wxImage takes ownership of the pointer and will free it unless @a static_data
1298         parameter is set to @true -- in this case the caller should do it.
1299     */
1300     void SetAlpha(unsigned char* alpha = NULL,
1301                   bool static_data = false);
1302
1303     /**
1304         Sets the alpha value for the given pixel.
1305         This function should only be called if the image has alpha channel data,
1306         use HasAlpha() to check for this.
1307     */
1308     void SetAlpha(int x, int y, unsigned char alpha);
1309
1310     //@{
1311     /**
1312         Sets the image data without performing checks.
1313
1314         The data given must have the size (width*height*3) or results will be
1315         unexpected. Don't use this method if you aren't sure you know what you
1316         are doing.
1317
1318         The data must have been allocated with @c malloc(), @b NOT with
1319         @c operator new.
1320
1321         After this call the pointer to the data is owned by the wxImage object,
1322         that will be responsible for deleting it.
1323         Do not pass to this function a pointer obtained through GetData().
1324     */
1325     void SetData(unsigned char* data, bool static_data = false);
1326     void SetData(unsigned char* data, int new_width, int new_height,
1327                  bool static_data = false);
1328     //@}
1329
1330     /**
1331         Specifies whether there is a mask or not.
1332
1333         The area of the mask is determined by the current mask colour.
1334     */
1335     void SetMask(bool hasMask = true);
1336
1337     /**
1338         Sets the mask colour for this image (and tells the image to use the mask).
1339     */
1340     void SetMaskColour(unsigned char red, unsigned char green,
1341                        unsigned char blue);
1342
1343     /**
1344         Sets image's mask so that the pixels that have RGB value of mr,mg,mb in
1345         mask will be masked in the image.
1346
1347         This is done by first finding an unused colour in the image, setting
1348         this colour as the mask colour and then using this colour to draw all
1349         pixels in the image who corresponding pixel in mask has given RGB value.
1350
1351         The parameter @a mask is the mask image to extract mask shape from.
1352         It must have the same dimensions as the image.
1353
1354         The parameters @a mr, @a mg, @a mb are the RGB values of the pixels in
1355         mask that will be used to create the mask.
1356
1357         @return Returns @false if mask does not have same dimensions as the image
1358                 or if there is no unused colour left. Returns @true if the mask
1359                 was successfully applied.
1360
1361         @note
1362             Note that this method involves computing the histogram, which is a
1363             computationally intensive operation.
1364     */
1365     bool SetMaskFromImage(const wxImage& mask, unsigned char mr,
1366                           unsigned char mg,
1367                           unsigned char mb);
1368
1369     //@{
1370     /**
1371         Sets a user-defined option. The function is case-insensitive to @a name.
1372
1373         For example, when saving as a JPEG file, the option @b quality is
1374         used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
1375
1376         @see GetOption(), GetOptionInt(), HasOption()
1377     */
1378     void SetOption(const wxString& name, const wxString& value);
1379     void SetOption(const wxString& name, int value);
1380     //@}
1381
1382     /**
1383         Associates a palette with the image.
1384
1385         The palette may be used when converting wxImage to wxBitmap (MSW only at present)
1386         or in file save operations (none as yet).
1387     */
1388     void SetPalette(const wxPalette& palette);
1389
1390     /**
1391         Sets the colour of the pixels within the given rectangle.
1392
1393         This routine performs bounds-checks for the coordinate so it can be considered
1394         a safe way to manipulate the data.
1395     */
1396     void SetRGB(const wxRect& rect,
1397                 unsigned char red,
1398                 unsigned char green,
1399                 unsigned char blue);
1400
1401     /**
1402         Set the type of image returned by GetType().
1403
1404         This method is mostly used internally by the library but can also be
1405         called from the user code if the image was created from data in the
1406         given bitmap format without using LoadFile() (which would set the type
1407         correctly automatically).
1408
1409         Notice that the image must be created before this function is called.
1410
1411         @since 2.9.0
1412
1413         @param type
1414             One of bitmap type constants, @c wxBITMAP_TYPE_INVALID is a valid
1415             value for it and can be used to reset the bitmap type to default
1416             but @c wxBITMAP_TYPE_MAX is not allowed here.
1417     */
1418     void SetType(wxBitmapType type);
1419
1420     /**
1421         Returns a resized version of this image without scaling it by adding either a
1422         border with the given colour or cropping as necessary.
1423
1424         The image is pasted into a new image with the given @a size and background
1425         colour at the position @a pos relative to the upper left of the new image.
1426
1427         If @a red = green = blue = -1 then the areas of the larger image not covered
1428         by this image are made transparent by filling them with the image mask colour
1429         (which will be allocated automatically if it isn't currently set).
1430
1431         Otherwise, the areas will be filled with the colour with the specified RGB components.
1432
1433         @see Resize()
1434     */
1435     wxImage Size(const wxSize& size, const wxPoint& pos, int red = -1,
1436                  int green = -1, int blue = -1) const;
1437
1438     /**
1439         Assignment operator, using @ref overview_refcount "reference counting".
1440
1441         @param image
1442             Image to assign.
1443
1444         @return Returns 'this' object.
1445     */
1446     wxImage& operator=(const wxImage& image);
1447 };
1448
1449 /**
1450     An instance of an empty image without an alpha channel.
1451 */
1452 wxImage wxNullImage;
1453
1454
1455 // ============================================================================
1456 // Global functions/macros
1457 // ============================================================================
1458
1459 /** @addtogroup group_funcmacro_appinitterm */
1460 //@{
1461
1462 /**
1463     Initializes all available image handlers. For a list of available handlers,
1464     see wxImage.
1465
1466     @see wxImage, wxImageHandler
1467
1468     @header{wx/image.h}
1469 */
1470 void wxInitAllImageHandlers();
1471
1472 //@}
1473