-spec blur(This, BlurRadius) -> wxImage() when This :: wxImage(), BlurRadius :: integer().

Blurs the image in both horizontal and vertical directions by the specified pixel blurRadius.

This should not be used when using a single mask colour for transparency.

See: blurHorizontal/2, blurVertical/2

-spec blurHorizontal(This, BlurRadius) -> wxImage() when This :: wxImage(), BlurRadius :: integer().

Blurs the image in the horizontal direction only.

This should not be used when using a single mask colour for transparency.

See: blur/2, blurVertical/2

-spec blurVertical(This, BlurRadius) -> wxImage() when This :: wxImage(), BlurRadius :: integer().

Blurs the image in the vertical direction only.

This should not be used when using a single mask colour for transparency.

See: blur/2, blurHorizontal/2

-spec convertAlphaToMask(This, [Option]) -> boolean()
                      when This :: wxImage(), Option :: {threshold, integer()}.

If the image has alpha channel, this method converts it to mask.

If the image has an alpha channel, all pixels with alpha value less than threshold are replaced with the mask colour and the alpha channel is removed. Otherwise nothing is done.

The mask colour is chosen automatically using findFirstUnusedColour/2, see the overload below if this is not appropriate.

Return: Returns true on success, false on error.

-spec convertAlphaToMask(This, Mr, Mg, Mb, [Option]) -> boolean()
                      when
                          This :: wxImage(),
                          Mr :: integer(),
                          Mg :: integer(),
                          Mb :: integer(),
                          Option :: {threshold, integer()}.

If the image has alpha channel, this method converts it to mask using the specified colour as the mask colour.

If the image has an alpha channel, all pixels with alpha value less than threshold are replaced with the mask colour and the alpha channel is removed. Otherwise nothing is done.

Since: 2.9.0

Return: Returns true on success, false on error.

-spec convertToGreyscale(This) -> wxImage() when This :: wxImage().

Returns a greyscale version of the image.

Since: 2.9.0

-spec convertToGreyscale(This, Weight_r, Weight_g, Weight_b) -> wxImage()
                      when
                          This :: wxImage(),
                          Weight_r :: number(),
                          Weight_g :: number(),
                          Weight_b :: number().

Returns a greyscale version of the image.

The returned image uses the luminance component of the original to calculate the greyscale. Defaults to using the standard ITU-T BT.601 when converting to YUV, where every pixel equals (R weight_r) + (G weight_g) + (B * weight_b).

-spec convertToMono(This, R, G, B) -> wxImage()
                 when This :: wxImage(), R :: integer(), G :: integer(), B :: integer().

Returns monochromatic version of the image.

The returned image has white colour where the original has (r,g,b) colour and black colour everywhere else.

-spec copy(This) -> wxImage() when This :: wxImage().

Returns an identical copy of this image.

-spec create(This, Width, Height) -> boolean()
          when This :: wxImage(), Width :: integer(), Height :: integer();
      (This, Sz, Data) -> boolean()
          when This :: wxImage(), Sz :: {W :: integer(), H :: integer()}, Data :: binary();
      (This, Sz, [Option]) -> boolean()
          when
              This :: wxImage(),
              Sz :: {W :: integer(), H :: integer()},
              Option :: {clear, boolean()}.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

-spec create(This, Width, Height, Data) -> boolean()
          when This :: wxImage(), Width :: integer(), Height :: integer(), Data :: binary();
      (This, Width, Height, [Option]) -> boolean()
          when
              This :: wxImage(),
              Width :: integer(),
              Height :: integer(),
              Option :: {clear, boolean()};
      (This, Sz, Data, Alpha) -> boolean()
          when
              This :: wxImage(),
              Sz :: {W :: integer(), H :: integer()},
              Data :: binary(),
              Alpha :: binary().

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

-spec create(This, Width, Height, Data, Alpha) -> boolean()
          when
              This :: wxImage(),
              Width :: integer(),
              Height :: integer(),
              Data :: binary(),
              Alpha :: binary().

Creates a fresh image.

See new/4 for more info.

Return: true if the call succeeded, false otherwise.

-spec 'Destroy'(This) -> ok when This :: wxImage().

Destroys the image data.

-spec destroy(This :: wxImage()) -> ok.

Destructor.

See reference-counted object destruction for more info.

-spec findFirstUnusedColour(This, [Option]) -> Result
                         when
                             Result ::
                                 {Res :: boolean(),
                                  R :: integer(),
                                  G :: integer(),
                                  B :: integer()},
                             This :: wxImage(),
                             Option ::
                                 {startR, integer()} | {startG, integer()} | {startB, integer()}.

Finds the first colour that is never used in the image.

The search begins at given initial colour and continues by increasing R, G and B components (in this order) by 1 until an unused colour is found or the colour space exhausted.

The parameters r, g, b are pointers to variables to save the colour.

The parameters startR, startG, startB define the initial values of the colour. The returned colour will have RGB values equal to or greater than these.

Return: Returns false if there is no unused colour left, true on success.

Note: This method involves computing the histogram, which is a computationally intensive operation.

-spec getAlpha(This) -> binary() when This :: wxImage().

Returns pointer to the array storing the alpha values for this image.

This pointer is NULL for the images without the alpha channel. If the image does have it, this pointer may be used to directly manipulate the alpha values which are stored as the RGB ones.

-spec getAlpha(This, X, Y) -> integer() when This :: wxImage(), X :: integer(), Y :: integer().

Return alpha value at given pixel location.

-spec getBlue(This, X, Y) -> integer() when This :: wxImage(), X :: integer(), Y :: integer().

Returns the blue intensity at the given coordinate.

-spec getData(This) -> binary() when This :: wxImage().

Returns the image data as an array.

This is most often used when doing direct image manipulation. The return value points to an array of characters in RGBRGBRGB... format in the top-to-bottom, left-to-right order, that is the first RGB triplet corresponds to the first pixel of the first row, the second one - to the second pixel of the first row and so on until the end of the first row, with second row following after it and so on.

You should not delete the returned pointer nor pass it to setData/4.

-spec getGreen(This, X, Y) -> integer() when This :: wxImage(), X :: integer(), Y :: integer().

Returns the green intensity at the given coordinate.

-spec getHeight(This) -> integer() when This :: wxImage().

Gets the height of the image in pixels.

See: getWidth/1, GetSize() (not implemented in wx)

-spec getImageCount(Filename, [Option]) -> integer()
                 when Filename :: unicode:chardata(), Option :: {type, wx:wx_enum()}.

If the image file contains more than one image and the image handler is capable of retrieving these individually, this function will return the number of available images.

For the overload taking the parameter filename, that's the name of the file to query. For the overload taking the parameter stream, that's the opened input stream with image data.

See wxImageHandler::GetImageCount() (not implemented in wx) for more info.

The parameter type may be one of the following values:

Return: Number of available images. For most image handlers, this is 1 (exceptions are TIFF and ICO formats as well as animated GIFs for which this function returns the number of frames in the animation).

-spec getImageExtWildcard() -> unicode:charlist().

Iterates all registered wxImageHandler (not implemented in wx) objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes.

Return: The format of the returned string is "(*.ext1;*.ext2)|*.ext1;*.ext2". It is usually a good idea to prepend a description before passing the result to the dialog. Example:

See: wxImageHandler (not implemented in wx)

-spec getMaskBlue(This) -> integer() when This :: wxImage().

Gets the blue value of the mask colour.

-spec getMaskGreen(This) -> integer() when This :: wxImage().

Gets the green value of the mask colour.

-spec getMaskRed(This) -> integer() when This :: wxImage().

Gets the red value of the mask colour.

-spec getOption(This, Name) -> unicode:charlist() when This :: wxImage(), Name :: unicode:chardata().

Gets a user-defined string-valued option.

Generic options:

Options specific to wxGIFHandler (not implemented in wx):

Return: The value of the option or an empty string if not found. Use hasOption/2 if an empty string can be a valid option value.

See: setOption/3, getOptionInt/2, hasOption/2

-spec getOptionInt(This, Name) -> integer() when This :: wxImage(), Name :: unicode:chardata().

Gets a user-defined integer-valued option.

The function is case-insensitive to name. If the given option is not present, the function returns 0. Use hasOption/2 if 0 is a possibly valid value for the option.

Generic options:

Since: 2.9.3

Options specific to wxPNGHandler (not implemented in wx):

Options specific to wxTIFFHandler (not implemented in wx):

Options specific to wxGIFHandler (not implemented in wx):

Note: Be careful when combining the options wxIMAGE_OPTION_TIFF_SAMPLESPERPIXEL, wxIMAGE_OPTION_TIFF_BITSPERSAMPLE, and wxIMAGE_OPTION_TIFF_PHOTOMETRIC. While some measures are taken to prevent illegal combinations and/or values, it is still easy to abuse them and come up with invalid results in the form of either corrupted images or crashes.

Return: The value of the option or 0 if not found. Use hasOption/2 if 0 can be a valid option value.

See: setOption/3, getOption/2

-spec getOrFindMaskColour(This) -> Result
                       when
                           Result ::
                               {Res :: boolean(), R :: integer(), G :: integer(), B :: integer()},
                           This :: wxImage().

Get the current mask colour or find a suitable unused colour that could be used as a mask colour.

Returns true if the image currently has a mask.

-spec getPalette(This) -> wxPalette:wxPalette() when This :: wxImage().

Returns the palette associated with the image.

Currently the palette is only used when converting to wxBitmap under Windows.

Some of the wxImage handlers have been modified to set the palette if one exists in the image file (usually 256 or less colour images in GIF or PNG format).

-spec getRed(This, X, Y) -> integer() when This :: wxImage(), X :: integer(), Y :: integer().

Returns the red intensity at the given coordinate.

-spec getSubImage(This, Rect) -> wxImage()
               when
                   This :: wxImage(),
                   Rect :: {X :: integer(), Y :: integer(), W :: integer(), H :: integer()}.

Returns a sub image of the current one as long as the rect belongs entirely to the image.

-spec getWidth(This) -> integer() when This :: wxImage().

Gets the width of the image in pixels.

See: getHeight/1, GetSize() (not implemented in wx)

-spec hasAlpha(This) -> boolean() when This :: wxImage().

Returns true if this image has alpha channel, false otherwise.

See: getAlpha/3, setAlpha/4

-spec hasMask(This) -> boolean() when This :: wxImage().

Returns true if there is a mask active, false otherwise.

-spec hasOption(This, Name) -> boolean() when This :: wxImage(), Name :: unicode:chardata().

Returns true if the given option is present.

The function is case-insensitive to name.

The lists of the currently supported options are in getOption/2 and getOptionInt/2 function docs.

See: setOption/3, getOption/2, getOptionInt/2

-spec initAlpha(This) -> ok when This :: wxImage().

Initializes the image alpha channel data.

It is an error to call it if the image already has alpha data. If it doesn't, alpha data will be by default initialized to all pixels being fully opaque. But if the image has a mask colour, all mask pixels will be completely transparent.

-spec initStandardHandlers() -> ok.

Internal use only.

Adds standard image format handlers. It only install wxBMPHandler for the time being, which is used by wxBitmap.

This function is called by wxWidgets on startup, and shouldn't be called by the user.

See: wxImageHandler (not implemented in wx), ?wxInitAllImageHandlers(), wxQuantize (not implemented in wx)

-spec isOk(This) -> boolean() when This :: wxImage().

Returns true if image data is present.

-spec isTransparent(This, X, Y, [Option]) -> boolean()
                 when
                     This :: wxImage(),
                     X :: integer(),
                     Y :: integer(),
                     Option :: {threshold, integer()}.

Returns true if the given pixel is transparent, i.e. either has the mask colour if this image has a mask or if this image has alpha channel and alpha value of this pixel is strictly less than threshold.

-spec loadFile(This, Name, [Option]) -> boolean()
            when
                This :: wxImage(),
                Name :: unicode:chardata(),
                Option :: {type, wx:wx_enum()} | {index, integer()}.

Loads an image from a file.

If no handler type is provided, the library will try to autodetect the format.

-spec loadFile(This, Name, Mimetype, [Option]) -> boolean()
            when
                This :: wxImage(),
                Name :: unicode:chardata(),
                Mimetype :: unicode:chardata(),
                Option :: {index, integer()}.

Loads an image from a file.

If no handler type is provided, the library will try to autodetect the format.

-spec mirror(This, [Option]) -> wxImage() when This :: wxImage(), Option :: {horizontally, boolean()}.

Returns a mirrored copy of the image.

The parameter horizontally indicates the orientation.

-spec new() -> wxImage().

Creates an empty wxImage object without an alpha channel.

-spec new(Width, Height) -> wxImage() when Width :: integer(), Height :: integer();
   (Name, [Option]) -> wxImage()
       when Name :: unicode:chardata(), Option :: {type, wx:wx_enum()} | {index, integer()};
   (Sz, Data) -> wxImage() when Sz :: {W :: integer(), H :: integer()}, Data :: binary();
   (Sz, [Option]) -> wxImage()
       when Sz :: {W :: integer(), H :: integer()}, Option :: {clear, boolean()}.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

-spec new(Width, Height, Data) -> wxImage()
       when Width :: integer(), Height :: integer(), Data :: binary();
   (Width, Height, [Option]) -> wxImage()
       when Width :: integer(), Height :: integer(), Option :: {clear, boolean()};
   (Name, Mimetype, [Option]) -> wxImage()
       when
           Name :: unicode:chardata(),
           Mimetype :: unicode:chardata(),
           Option :: {index, integer()};
   (Sz, Data, Alpha) -> wxImage()
       when Sz :: {W :: integer(), H :: integer()}, Data :: binary(), Alpha :: binary().

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

-spec new(Width, Height, Data, Alpha) -> wxImage()
       when Width :: integer(), Height :: integer(), Data :: binary(), Alpha :: binary().

Creates an image from data in memory.

If static_data is false then the wxImage will take ownership of the data and free it afterwards. For this, it has to be allocated with malloc.

-spec ok(This) -> boolean() when This :: wxImage().

See: isOk/1.

-spec removeHandler(Name) -> boolean() when Name :: unicode:chardata().

Finds the handler with the given name, and removes it.

The handler is also deleted.

Return: true if the handler was found and removed, false otherwise.

See: wxImageHandler (not implemented in wx)

-spec replace(This, R1, G1, B1, R2, G2, B2) -> ok
           when
               This :: wxImage(),
               R1 :: integer(),
               G1 :: integer(),
               B1 :: integer(),
               R2 :: integer(),
               G2 :: integer(),
               B2 :: integer().

Replaces the colour specified by r1,g1,b1 by the colour r2,g2,b2.

-spec rescale(This, Width, Height, [Option]) -> wxImage()
           when
               This :: wxImage(),
               Width :: integer(),
               Height :: integer(),
               Option :: {quality, wx:wx_enum()}.

Changes the size of the image in-place by scaling it: after a call to this function,the image will have the given width and height.

For a description of the quality parameter, see the scale/4 function. Returns the (modified) image itself.

See: scale/4

-spec resize(This, Size, Pos, [Option]) -> wxImage()
          when
              This :: wxImage(),
              Size :: {W :: integer(), H :: integer()},
              Pos :: {X :: integer(), Y :: integer()},
              Option :: {r, integer()} | {g, integer()} | {b, integer()}.

Changes the size of the image in-place without scaling it by adding either a border with the given colour or cropping as necessary.

The image is pasted into a new image with the given size and background colour at the position pos relative to the upper left of the new image.

If red = green = blue = -1 then use either the current mask colour if set or find, use, and set a suitable mask colour for any newly exposed areas.

Return: The (modified) image itself.

See: size/4

-spec rotate90(This, [Option]) -> wxImage() when This :: wxImage(), Option :: {clockwise, boolean()}.

Returns a copy of the image rotated 90 degrees in the direction indicated by clockwise.

-spec rotate(This, Angle, RotationCentre, [Option]) -> wxImage()
          when
              This :: wxImage(),
              Angle :: number(),
              RotationCentre :: {X :: integer(), Y :: integer()},
              Option ::
                  {interpolating, boolean()} |
                  {offset_after_rotation, {X :: integer(), Y :: integer()}}.

Rotates the image about the given point, by angle radians.

Passing true to interpolating results in better image quality, but is slower.

If the image has a mask, then the mask colour is used for the uncovered pixels in the rotated image background. Else, black (rgb 0, 0, 0) will be used.

Returns the rotated image, leaving this image intact.

-spec rotateHue(This, Angle) -> ok when This :: wxImage(), Angle :: number().

Rotates the hue of each pixel in the image by angle, which is a double in the range of -1.0 to +1.0, where -1.0 corresponds to -360 degrees and +1.0 corresponds to +360 degrees.

-spec saveFile(This, Name) -> boolean() when This :: wxImage(), Name :: unicode:chardata().

Saves an image in the named file.

File type is determined from the extension of the file name. Note that this function may fail if the extension is not recognized! You can use one of the forms above to save images to files with non-standard extensions.

-spec saveFile(This, Name, Type) -> boolean()
            when This :: wxImage(), Name :: unicode:chardata(), Type :: wx:wx_enum();
        (This, Name, Mimetype) -> boolean()
            when This :: wxImage(), Name :: unicode:chardata(), Mimetype :: unicode:chardata().

Saves an image in the named file.

-spec scale(This, Width, Height, [Option]) -> wxImage()
         when
             This :: wxImage(),
             Width :: integer(),
             Height :: integer(),
             Option :: {quality, wx:wx_enum()}.

Returns a scaled version of the image.

This is also useful for scaling bitmaps in general as the only other way to scale bitmaps is to blit a wxMemoryDC into another wxMemoryDC.

The parameter quality determines what method to use for resampling the image, see wxImageResizeQuality documentation.

It should be noted that although using wxIMAGE_QUALITY_HIGH produces much nicer looking results it is a slower method. Downsampling will use the box averaging method which seems to operate very fast. If you are upsampling larger images using this method you will most likely notice that it is a bit slower and in extreme cases it will be quite substantially slower as the bicubic algorithm has to process a lot of data.

It should also be noted that the high quality scaling may not work as expected when using a single mask colour for transparency, as the scaling will blur the image and will therefore remove the mask partially. Using the alpha channel will work.

Example:

See: rescale/4

-spec setAlpha(This, Alpha) -> ok when This :: wxImage(), Alpha :: binary().

This function is similar to setData/4 and has similar restrictions.

The pointer passed to it may however be NULL in which case the function will allocate the alpha array internally - this is useful to add alpha channel data to an image which doesn't have any.

If the pointer is not NULL, it must have one byte for each image pixel and be allocated with malloc(). wxImage takes ownership of the pointer and will free it unless static_data parameter is set to true - in this case the caller should do it.

-spec setAlpha(This, X, Y, Alpha) -> ok
            when This :: wxImage(), X :: integer(), Y :: integer(), Alpha :: integer().

Sets the alpha value for the given pixel.

This function should only be called if the image has alpha channel data, use hasAlpha/1 to check for this.

-spec setData(This, Data) -> ok when This :: wxImage(), Data :: binary().

Sets the image data without performing checks.

The data given must have the size (widthheight3) or results will be unexpected. Don't use this method if you aren't sure you know what you are doing.

The data must have been allocated with malloc(), NOT with operator new.

If static_data is false, after this call the pointer to the data is owned by the wxImage object, that will be responsible for deleting it. Do not pass to this function a pointer obtained through getData/1.

-spec setData(This, Data, New_width, New_height) -> ok
           when
               This :: wxImage(),
               Data :: binary(),
               New_width :: integer(),
               New_height :: integer().

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

-spec setMask(This, [Option]) -> ok when This :: wxImage(), Option :: {mask, boolean()}.

Specifies whether there is a mask or not.

The area of the mask is determined by the current mask colour.

-spec setMaskColour(This, Red, Green, Blue) -> ok
                 when This :: wxImage(), Red :: integer(), Green :: integer(), Blue :: integer().

Sets the mask colour for this image (and tells the image to use the mask).

-spec setMaskFromImage(This, Mask, Mr, Mg, Mb) -> boolean()
                    when
                        This :: wxImage(),
                        Mask :: wxImage(),
                        Mr :: integer(),
                        Mg :: integer(),
                        Mb :: integer().

Sets image's mask so that the pixels that have RGB value of mr,mg,mb in mask will be masked in the image.

This is done by first finding an unused colour in the image, setting this colour as the mask colour and then using this colour to draw all pixels in the image who corresponding pixel in mask has given RGB value.

The parameter mask is the mask image to extract mask shape from. It must have the same dimensions as the image.

The parameters mr, mg, mb are the RGB values of the pixels in mask that will be used to create the mask.

Return: Returns false if mask does not have same dimensions as the image or if there is no unused colour left. Returns true if the mask was successfully applied.

Note: Note that this method involves computing the histogram, which is a computationally intensive operation.

-spec setOption(This, Name, Value) -> ok
             when This :: wxImage(), Name :: unicode:chardata(), Value :: integer();
         (This, Name, Value) -> ok
             when This :: wxImage(), Name :: unicode:chardata(), Value :: unicode:chardata().

Sets a user-defined option.

The function is case-insensitive to name.

For example, when saving as a JPEG file, the option quality is used, which is a number between 0 and 100 (0 is terrible, 100 is very good).

The lists of the currently supported options are in getOption/2 and getOptionInt/2 function docs.

See: getOption/2, getOptionInt/2, hasOption/2

-spec setPalette(This, Palette) -> ok when This :: wxImage(), Palette :: wxPalette:wxPalette().

Associates a palette with the image.

The palette may be used when converting wxImage to wxBitmap (MSW only at present) or in file save operations (none as yet).

-spec setRGB(This, Rect, Red, Green, Blue) -> ok
          when
              This :: wxImage(),
              Rect :: {X :: integer(), Y :: integer(), W :: integer(), H :: integer()},
              Red :: integer(),
              Green :: integer(),
              Blue :: integer().

Sets the colour of the pixels within the given rectangle.

This routine performs bounds-checks for the coordinate so it can be considered a safe way to manipulate the data.

-spec setRGB(This, X, Y, R, G, B) -> ok
          when
              This :: wxImage(),
              X :: integer(),
              Y :: integer(),
              R :: integer(),
              G :: integer(),
              B :: integer().

Set the color of the pixel at the given x and y coordinate.

-spec size(This, Size, Pos, [Option]) -> wxImage()
        when
            This :: wxImage(),
            Size :: {W :: integer(), H :: integer()},
            Pos :: {X :: integer(), Y :: integer()},
            Option :: {r, integer()} | {g, integer()} | {b, integer()}.

Returns a resized version of this image without scaling it by adding either a border with the given colour or cropping as necessary.

The image is pasted into a new image with the given size and background colour at the position pos relative to the upper left of the new image.

If red = green = blue = -1 then the areas of the larger image not covered by this image are made transparent by filling them with the image mask colour (which will be allocated automatically if it isn't currently set).

Otherwise, the areas will be filled with the colour with the specified RGB components.

See: resize/4