wxruby3 0.9.0.pre.beta.8-x64-mingw-ucrt

data/lib/wx/doc/gen/image.rb

@@ -0,0 +1,1144 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  IMAGE_OPTION_QUALITY = "quality"
+  
+  # 
+  IMAGE_OPTION_FILENAME = "FileName"
+  
+  # 
+  IMAGE_OPTION_RESOLUTION = "Resolution"
+  
+  # 
+  IMAGE_OPTION_RESOLUTIONX = "ResolutionX"
+  
+  # 
+  IMAGE_OPTION_RESOLUTIONY = "ResolutionY"
+  
+  # 
+  IMAGE_OPTION_RESOLUTIONUNIT = "ResolutionUnit"
+  
+  # 
+  IMAGE_OPTION_MAX_WIDTH = "MaxWidth"
+  
+  # 
+  IMAGE_OPTION_MAX_HEIGHT = "MaxHeight"
+  
+  # 
+  IMAGE_OPTION_ORIGINAL_WIDTH = "OriginalWidth"
+  
+  # 
+  IMAGE_OPTION_ORIGINAL_HEIGHT = "OriginalHeight"
+  
+  # 
+  IMAGE_OPTION_BMP_FORMAT = "wxBMP_FORMAT"
+  
+  # 
+  IMAGE_OPTION_CUR_HOTSPOT_X = "HotSpotX"
+  
+  # 
+  IMAGE_OPTION_CUR_HOTSPOT_Y = "HotSpotY"
+  
+  # 
+  IMAGE_OPTION_GIF_COMMENT = "GifComment"
+  
+  # 
+  IMAGE_OPTION_GIF_TRANSPARENCY = "Transparency"
+  
+  # 
+  IMAGE_OPTION_GIF_TRANSPARENCY_HIGHLIGHT = "Highlight"
+  
+  # 
+  IMAGE_OPTION_GIF_TRANSPARENCY_UNCHANGED = "Unchanged"
+  
+  # 
+  IMAGE_OPTION_PNG_FORMAT = "PngFormat"
+  
+  # 
+  IMAGE_OPTION_PNG_BITDEPTH = "PngBitDepth"
+  
+  # 
+  IMAGE_OPTION_PNG_FILTER = "PngF"
+  
+  # 
+  IMAGE_OPTION_PNG_COMPRESSION_LEVEL = "PngZL"
+  
+  # 
+  IMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL = "PngZM"
+  
+  # 
+  IMAGE_OPTION_PNG_COMPRESSION_STRATEGY = "PngZS"
+  
+  # 
+  IMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE = "PngZB"
+  
+  # 
+  IMAGE_OPTION_TIFF_BITSPERSAMPLE = "BitsPerSample"
+  
+  # 
+  IMAGE_OPTION_TIFF_SAMPLESPERPIXEL = "SamplesPerPixel"
+  
+  # 
+  IMAGE_OPTION_TIFF_COMPRESSION = "Compression"
+  
+  # 
+  IMAGE_OPTION_TIFF_PHOTOMETRIC = "Photometric"
+  
+  # 
+  IMAGE_OPTION_TIFF_IMAGEDESCRIPTOR = "ImageDescriptor"
+  
+  # Possible values for the image resolution option.
+  # 
+  # 
+  # @see Wx::Image#get_option_int. 
+  # 
+  # 
+  class ImageResolution < Wx::Enum
+  
+    # Resolution not specified.
+    # 
+    IMAGE_RESOLUTION_NONE = Wx::ImageResolution.new(0)
+    
+    # Resolution specified in inches.
+    # 
+    IMAGE_RESOLUTION_INCHES = Wx::ImageResolution.new(1)
+    
+    # Resolution specified in centimetres.
+    # 
+    IMAGE_RESOLUTION_CM = Wx::ImageResolution.new(2)
+    
+  end # ImageResolution
+  
+  # Image resize algorithm.
+  # 
+  # This is used with {Wx::Image#scale} and {Wx::Image#rescale}.
+  # 
+  class ImageResizeQuality < Wx::Enum
+  
+    # Simplest and fastest algorithm.
+    # 
+    IMAGE_QUALITY_NEAREST = Wx::ImageResizeQuality.new(0)
+    
+    # Compromise between {Wx::ImageResizeQuality::IMAGE_QUALITY_NEAREST} and {Wx::ImageResizeQuality::IMAGE_QUALITY_BICUBIC}.
+    # 
+    IMAGE_QUALITY_BILINEAR = Wx::ImageResizeQuality.new(1)
+    
+    # Highest quality but slowest execution time.
+    # 
+    IMAGE_QUALITY_BICUBIC = Wx::ImageResizeQuality.new(2)
+    
+    # Use surrounding pixels to calculate an average that will be used for new pixels.
+    # 
+    IMAGE_QUALITY_BOX_AVERAGE = Wx::ImageResizeQuality.new(3)
+    
+    # Default image resizing algorithm used by {Wx::Image#scale}.
+    # 
+    IMAGE_QUALITY_NORMAL = Wx::ImageResizeQuality.new(0)
+    
+    # Best image resizing algorithm.
+    # 
+    IMAGE_QUALITY_HIGH = Wx::ImageResizeQuality.new(4)
+    
+  end # ImageResizeQuality
+  
+  # Constants for {Wx::Image#paste} for specifying alpha blending option.
+  # 
+  # 
+  # 
+  class ImageAlphaBlendMode < Wx::Enum
+  
+    # Overwrite the original alpha values with the ones being pasted.
+    # 
+    IMAGE_ALPHA_BLEND_OVER = Wx::ImageAlphaBlendMode.new(0)
+    
+    # Compose the original alpha values with the ones being pasted.
+    # 
+    IMAGE_ALPHA_BLEND_COMPOSE = Wx::ImageAlphaBlendMode.new(1)
+    
+  end # ImageAlphaBlendMode
+  
+  # Possible values for PNG image type option.
+  # 
+  # 
+  # @see Wx::Image#get_option_int. 
+  # 
+  # 
+  class ImagePNGType < Wx::Enum
+  
+    # Colour PNG image.
+    # 
+    PNG_TYPE_COLOUR = Wx::ImagePNGType.new(0)
+    
+    # Greyscale PNG image converted from RGB.
+    # 
+    PNG_TYPE_GREY = Wx::ImagePNGType.new(2)
+    
+    # Greyscale PNG image using red as grey.
+    # 
+    PNG_TYPE_GREY_RED = Wx::ImagePNGType.new(3)
+    
+    # Palette encoding.
+    # 
+    PNG_TYPE_PALETTE = Wx::ImagePNGType.new(4)
+    
+  end # ImagePNGType
+  
+  # 
+  # 
+  BMP_24BPP = 24
+  
+  # 
+  # 
+  BMP_8BPP = 8
+  
+  # 
+  # 
+  BMP_8BPP_GREY = 9
+  
+  # 
+  # 
+  BMP_8BPP_GRAY = 9
+  
+  # 
+  # 
+  BMP_8BPP_RED = 10
+  
+  # 
+  # 
+  BMP_8BPP_PALETTE = 11
+  
+  # 
+  # 
+  BMP_4BPP = 4
+  
+  # 
+  # 
+  BMP_1BPP = 1
+  
+  # 
+  # 
+  BMP_1BPP_BW = 2
+  
+  # Constant used to indicate the alpha value conventionally defined as the complete transparency.
+  # 
+  IMAGE_ALPHA_TRANSPARENT = 0
+  
+  # Constant used to indicate the alpha value conventionally defined as the complete opacity.
+  # 
+  IMAGE_ALPHA_OPAQUE = 255
+  
+  # 
+  # 
+  IMAGE_ALPHA_THRESHOLD = 128
+  
+  # An instance of an empty image without an alpha channel.
+  # 
+  NULL_IMAGE = nil
+  
+  # This class encapsulates a platform-independent image.
+  # An image can be created from data, or using {Wx::Bitmap#convert_to_image}. An image can be loaded from a file in a variety of formats, and is extensible to new formats via image format handlers. Functions are available to set and get image bits, so it can be used for basic image manipulation.
+  # A {Wx::Image} cannot (currently) be drawn directly to a {Wx::DC}. Instead, a platform-specific {Wx::Bitmap} object must be created from it using the {Wx::Bitmap#initialize(wxImage,depth)} constructor. This bitmap can then be drawn in a device context, using {Wx::DC#draw_bitmap}.
+  # More on the difference between {Wx::Image} and {Wx::Bitmap}: {Wx::Image} is just a buffer of RGB bytes with an optional buffer for the alpha bytes. It is all generic, platform independent and image file format independent code. It includes generic code for scaling, resizing, clipping, and other manipulations of the image data. OTOH, {Wx::Bitmap} is intended to be a wrapper of whatever is the native image format that is quickest/easiest to draw to a DC or to be the target of the drawing operations performed on a {Wx::MemoryDC}. By splitting the responsibilities between {Wx::Image}/{Wx::Bitmap} like this then it's easier to use generic code shared by all platforms and image types for generic operations and platform specific code where performance or compatibility is needed.
+  # One colour value of the image may be used as a mask colour which will lead to the automatic creation of a {Wx::Mask} object associated to the bitmap object.
+  # 
+  # == Alpha channel support
+  # 
+  # Starting from wxWidgets 2.5.0 {Wx::Image} supports alpha channel data, that is in addition to a byte for the red, green and blue colour components for each pixel it also stores a byte representing the pixel opacity.
+  # An alpha value of 0 corresponds to a transparent pixel (null opacity) while a value of 255 means that the pixel is 100% opaque. The constants {Wx::IMAGE_ALPHA_TRANSPARENT} and {Wx::IMAGE_ALPHA_OPAQUE} can be used to indicate those values in a more readable form.
+  # While all images have RGB data, not all images have an alpha channel. Before using {Wx::Image#get_alpha} you should check if this image contains an alpha channel with {Wx::Image#has_alpha}. Currently the BMP, PNG, TGA, and TIFF format handlers have full alpha channel support for loading so if you want to use alpha you have to use one of these formats. If you initialize the image alpha channel yourself using {Wx::Image#set_alpha}, you should save it in either PNG, TGA, or TIFF format to avoid losing it as these are the only handlers that currently support saving with alpha.
+  # 
+  # == Available image handlers
+  # 
+  # The following image handlers are available. {Wx::BMPHandler} is always installed by default. To use other image formats, install the appropriate handler with {Wx::Image.add_handler} or call {init_all_image_handlers}.
+  # 
+  # - {Wx::BMPHandler}: For loading (including alpha support) and saving, always installed.- {Wx::PNGHandler}: For loading and saving. Includes alpha support.- {Wx::JPEGHandler}: For loading and saving.- {Wx::GIFHandler}: For loading and saving (see below).- {Wx::PCXHandler}: For loading and saving (see below).- {Wx::PNMHandler}: For loading and saving (see below).- {Wx::TIFFHandler}: For loading and saving. Includes alpha support.- {Wx::TGAHandler}: For loading and saving. Includes alpha support.- {Wx::IFFHandler}: For loading only.- {Wx::XPMHandler}: For loading and saving.- {Wx::ICOHandler}: For loading and saving.- {Wx::CURHandler}: For loading and saving.- {Wx::ANIHandler}: For loading only.
+  # 
+  # When saving in PCX format, {Wx::PCXHandler} will count the number of different colours in the image; if there are 256 or less colours, it will save as 8 bit, else it will save as 24 bit.
+  # Loading PNMs only works for ASCII or raw RGB images. When saving in PNM format, {Wx::PNMHandler} will always save as raw RGB.
+  # Saving GIFs requires images of maximum 8 bpp (see {Wx::Quantize}), and the alpha channel converted to a mask (see {Wx::Image#convert_alpha_to_mask}). Saving an animated GIF requires images of the same size (see Wx::GIFHandler::SaveAnimation)
+  # === 
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers: {Wx::NULL_IMAGE}
+  # @see Wx::Bitmap
+  # @see  init_all_image_handlers
+  # @see  Wx::PixelData 
+  # 
+  # 
+  class Image < Object
+  
+    # Returns an identical copy of this image.
+    # @return [Wx::Image]
+    def copy; end
+    
+    # @overload create(width, height, clear=true)
+    #   Creates a fresh image.
+    #   See {Wx::Image#initialize(int,int,bool)} for more info.
+    #   true if the call succeeded, false otherwise.
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @param clear [true,false] 
+    #   @return [true,false]
+    # @overload create(sz, clear=true)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param clear [true,false] 
+    #   @return [true,false]
+    # @overload create(width, height, data)
+    #   Creates a fresh image.
+    #   See wxImage::wxImage(int,int,unsigned char*,bool) for more info.
+    #   true if the call succeeded, false otherwise.
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @param data [String] 
+    #   @return [true,false]
+    # @overload create(sz, data)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param data [String] 
+    #   @return [true,false]
+    # @overload create(width, height, data, alpha)
+    #   Creates a fresh image.
+    #   See wxImage::wxImage(int,int,unsigned char*,unsigned char*,bool) for more info.
+    #   true if the call succeeded, false otherwise.
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @param data [String] 
+    #   @param alpha [String] 
+    #   @return [true,false]
+    # @overload create(sz, data, alpha)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param data [String] 
+    #   @param alpha [String] 
+    #   @return [true,false]
+    def create(*args) end
+    
+    # Initialize the image data with zeroes (the default) or with the byte value given as value.
+    # @param value [Integer] 
+    # @return [void]
+    def clear(value=0) end
+    
+    # Destroys the image data.
+    # @return [void]
+    def destroy; end
+    
+    # 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.
+    # @return [void]
+    def init_alpha; end
+    
+    # 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 Wx::Image#blur_horizontal
+    # @see  Wx::Image#blur_vertical 
+    # @param blurRadius [Integer] 
+    # @return [Wx::Image]
+    def blur(blurRadius) end
+    
+    # Blurs the image in the horizontal direction only.
+    # This should not be used when using a single mask colour for transparency.
+    # @see Wx::Image#blur
+    # @see  Wx::Image#blur_vertical 
+    # @param blurRadius [Integer] 
+    # @return [Wx::Image]
+    def blur_horizontal(blurRadius) end
+    
+    # Blurs the image in the vertical direction only.
+    # This should not be used when using a single mask colour for transparency.
+    # @see Wx::Image#blur
+    # @see  Wx::Image#blur_horizontal 
+    # @param blurRadius [Integer] 
+    # @return [Wx::Image]
+    def blur_vertical(blurRadius) end
+    
+    # Returns a mirrored copy of the image.
+    # The parameter horizontally indicates the orientation.
+    # @param horizontally [true,false] 
+    # @return [Wx::Image]
+    def mirror(horizontally=true) end
+    
+    # Copy the data of the given image to the specified position in this image.
+    # Takes care of the mask colour and out of bounds problems.
+    # @param image [Wx::Image]  The image containing the data to copy, must be valid.
+    # @param x [Integer]  The horizontal position of the position to copy the data to.
+    # @param y [Integer]  The vertical position of the position to copy the data to.
+    # @param alphaBlend [ImageAlphaBlendMode]  This parameter (new in wx 3.1.5) determines whether the alpha values of the original image replace (default) or are composed with the alpha channel of this image. Notice that alpha blending overrides the mask handling.
+    # @return [void]
+    def paste(image, x, y, alphaBlend=Wx::IMAGE_ALPHA_BLEND_OVER) end
+    
+    # Replaces the colour specified by r1,g1,b1 by the colour r2,g2,b2.
+    # @param r1 [Integer] 
+    # @param g1 [Integer] 
+    # @param b1 [Integer] 
+    # @param r2 [Integer] 
+    # @param g2 [Integer] 
+    # @param b2 [Integer] 
+    # @return [void]
+    def replace(r1, g1, b1, r2, g2, b2) end
+    
+    # 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 {Wx::Image#scale} function. Returns the (modified) image itself.
+    # @see Wx::Image#scale 
+    # @param width [Integer] 
+    # @param height [Integer] 
+    # @param quality [ImageResizeQuality] 
+    # @return [Wx::Image]
+    def rescale(width, height, quality=Wx::IMAGE_QUALITY_NORMAL) end
+    
+    # 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.
+    # The (modified) image itself.
+    # @see Wx::Image#size 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param red [Integer] 
+    # @param green [Integer] 
+    # @param blue [Integer] 
+    # @return [Wx::Image]
+    def resize(size, pos, red=-1, green=-1, blue=-1) end
+    
+    # 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.
+    # @param angle [Float] 
+    # @param rotationCentre [Array(Integer, Integer), Wx::Point] 
+    # @param interpolating [true,false] 
+    # @param offsetAfterRotation [Wx::Point] 
+    # @return [Wx::Image]
+    def rotate(angle, rotationCentre, interpolating=true, offsetAfterRotation=nil) end
+    
+    # Returns a copy of the image rotated 90 degrees in the direction indicated by clockwise.
+    # @param clockwise [true,false] 
+    # @return [Wx::Image]
+    def rotate90(clockwise=true) end
+    
+    # Returns a copy of the image rotated by 180 degrees.
+    # @return [Wx::Image]
+    def rotate180; end
+    
+    # Rotates the hue of each pixel in the image by angle, which is a double in the range [-1.0..+1.0], where -1.0 corresponds to -360 degrees and +1.0 corresponds to +360 degrees.
+    # @param angle [Float] 
+    # @return [void]
+    def rotate_hue(angle) end
+    
+    # Changes the saturation of each pixel in the image.
+    # factor is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent.
+    # @param factor [Float] 
+    # @return [void]
+    def change_saturation(factor) end
+    
+    # Changes the brightness (value) of each pixel in the image.
+    # factor is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent.
+    # @param factor [Float] 
+    # @return [void]
+    def change_brightness(factor) end
+    
+    # Changes the hue, the saturation and the brightness (value) of each pixel in the image.
+    # angleH is a double in the range [-1.0..+1.0], where -1.0 corresponds to -360 degrees and +1.0 corresponds to +360 degrees, factorS is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent and factorV is a double in the range [-1.0..+1.0], where -1.0 corresponds to -100 percent and +1.0 corresponds to +100 percent.
+    # @param angleH [Float] 
+    # @param factorS [Float] 
+    # @param factorV [Float] 
+    # @return [void]
+    def change_hsv(angleH, factorS, factorV) end
+    
+    # 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 {Wx::MemoryDC} into another {Wx::MemoryDC}.
+    # The parameter quality determines what method to use for resampling the image, see {Wx::ImageResizeQuality} documentation.
+    # It should be noted that although using {Wx::ImageResizeQuality::IMAGE_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: 
+    # 
+    #   // get the bitmap from somewhere
+    #   wxBitmap bmp = ...;
+    #   
+    #   // rescale it to have size of 32*32
+    #   if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
+    #   {
+    #       wxImage image = bmp.ConvertToImage();
+    #       bmp = wxBitmap(image.Scale(32, 32));
+    #   
+    #       // another possibility:
+    #       image.Rescale(32, 32);
+    #       bmp = image;
+    #   }
+    # 
+    # The algorithm used for the default (normal) quality value doesn't work with images larger than 65536 (2^16) pixels in either dimension for 32-bit programs. For 64-bit programs the limit is 2^48 and so not relevant in practice.
+    # @see Wx::Image#rescale 
+    # @param width [Integer] 
+    # @param height [Integer] 
+    # @param quality [ImageResizeQuality] 
+    # @return [Wx::Image]
+    def scale(width, height, quality=Wx::IMAGE_QUALITY_NORMAL) end
+    
+    # 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 Wx::Image#resize 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param red [Integer] 
+    # @param green [Integer] 
+    # @param blue [Integer] 
+    # @return [Wx::Image]
+    def size(size, pos, red=-1, green=-1, blue=-1) end
+    
+    # @overload convert_alpha_to_mask(threshold=Wx::IMAGE_ALPHA_THRESHOLD)
+    #   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 {Wx::Image#find_first_unused_colour}, see the overload below if this is not appropriate.
+    #   Returns true on success, false on error.
+    #   @param threshold [Integer] 
+    #   @return [true,false]
+    # @overload convert_alpha_to_mask(mr, mg, mb, threshold=Wx::IMAGE_ALPHA_THRESHOLD)
+    #   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.
+    #   
+    #   Returns true on success, false on error.
+    #   @param mr [Integer]  The red component of the mask colour.
+    #   @param mg [Integer]  The green component of the mask colour.
+    #   @param mb [Integer]  The blue component of the mask colour.
+    #   @param threshold [Integer]  Pixels with alpha channel values below the given threshold are considered to be transparent, i.e. the corresponding mask pixels are set. Pixels with the alpha values above the threshold are considered to be opaque.
+    #   @return [true,false]
+    def convert_alpha_to_mask(*args) end
+    
+    # @overload convert_to_greyscale(weight_r, weight_g, weight_b)
+    #   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).
+    #   This function calls {Wx::Colour.make_grey} for each pixel in the image.
+    #   @param weight_r [Float] 
+    #   @param weight_g [Float] 
+    #   @param weight_b [Float] 
+    #   @return [Wx::Image]
+    # @overload convert_to_greyscale()
+    #   Returns a greyscale version of the image.
+    #   @return [Wx::Image]
+    def convert_to_greyscale(*args) end
+    
+    # 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.
+    # This function calls {Wx::Colour.make_mono} for each pixel in the image.
+    # @param r [Integer] 
+    # @param g [Integer] 
+    # @param b [Integer] 
+    # @return [Wx::Image]
+    def convert_to_mono(r, g, b) end
+    
+    # Returns disabled (dimmed) version of the image.
+    # This function calls {Wx::Colour#make_disabled} for each pixel in the image.
+    # @param brightness [Integer] 
+    # @return [Wx::Image]
+    def convert_to_disabled(brightness=255) end
+    
+    # Returns a changed version of the image based on the given lightness.
+    # This utility function simply darkens or lightens a color, based on the specified percentage ialpha. ialpha of 0 would make the color completely black, 200 completely white and 100 would not change the color.
+    # This function calls {Wx::Colour#change_lightness} for each pixel in the image.
+    # @param alpha [Integer] 
+    # @return [Wx::Image]
+    def change_lightness(alpha) end
+    
+    # Computes the histogram of the image.
+    # histogram is a reference to {Wx::ImageHistogram} object. {Wx::ImageHistogram} is a specialization of {Wx::HashMap} "template" and is defined as follows:
+    # 
+    #   class WXDLLEXPORT wxImageHistogramEntry
+    #   {
+    #   public:
+    #       wxImageHistogramEntry() : index(0), value(0) {}
+    #       unsigned long index;
+    #       unsigned long value;
+    #   };
+    #   
+    #   WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
+    #                               wxIntegerHash, wxIntegerEqual,
+    #                               wxImageHistogram);
+    # 
+    # Returns number of colours in the histogram.
+    # @param histogram [Wx::ImageHistogram] 
+    # @return [Integer]
+    def compute_histogram(histogram) end
+    
+    # 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.
+    # Returns false if there is no unused colour left, true on success.
+    # 
+    # This method involves computing the histogram, which is a computationally intensive operation.
+    # @param startR [Integer] 
+    # @param startG [Integer] 
+    # @param startB [Integer] 
+    # @return [Array(true,false,Integer,Integer,Integer)]
+    def find_first_unused_colour(startR=1, startG=0, startB=0) end
+    
+    # Returns the red intensity at the given coordinate.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @return [Integer]
+    def get_red(x, y) end
+    alias_method :red, :get_red
+    
+    # Returns the green intensity at the given coordinate.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @return [Integer]
+    def get_green(x, y) end
+    alias_method :green, :get_green
+    
+    # Returns the blue intensity at the given coordinate.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @return [Integer]
+    def get_blue(x, y) end
+    alias_method :blue, :get_blue
+    
+    # Gets the red value of the mask colour.
+    # @return [Integer]
+    def get_mask_red; end
+    alias_method :mask_red, :get_mask_red
+    
+    # Gets the green value of the mask colour.
+    # @return [Integer]
+    def get_mask_green; end
+    alias_method :mask_green, :get_mask_green
+    
+    # Gets the blue value of the mask colour.
+    # @return [Integer]
+    def get_mask_blue; end
+    alias_method :mask_blue, :get_mask_blue
+    
+    # Gets the width of the image in pixels.
+    # 
+    # @see Wx::Image#get_height
+    # @see  Wx::Image#get_size 
+    # @return [Integer]
+    def get_width; end
+    alias_method :width, :get_width
+    
+    # Gets the height of the image in pixels.
+    # 
+    # @see Wx::Image#get_width
+    # @see  Wx::Image#get_size 
+    # @return [Integer]
+    def get_height; end
+    alias_method :height, :get_height
+    
+    # Returns the size of the image in pixels.
+    # 
+    # @see Wx::Image#get_height
+    # @see  Wx::Image#get_width 
+    # @return [Wx::Size]
+    def get_size; end
+    
+    # Gets a user-defined string-valued option.
+    # Generic options: 
+    # - {Wx::IMAGE_OPTION_FILENAME}: The name of the file from which the image was loaded.
+    # 
+    # Options specific to {Wx::GIFHandler}: 
+    # - {Wx::IMAGE_OPTION_GIF_COMMENT}: The comment text that is read from or written to the GIF file. In an animated GIF each frame can have its own comment. If there is only a comment in the first frame of a GIF it will not be repeated in other frames.
+    # 
+    # The value of the option or an empty string if not found. Use {Wx::Image#has_option} if an empty string can be a valid option value.
+    # @see Wx::Image#set_option
+    # @see  Wx::Image#get_option_int
+    # @see  Wx::Image#has_option 
+    # @param name [String]  The name of the option, case-insensitive.
+    # @return [String]
+    def get_option(name) end
+    alias_method :option, :get_option
+    
+    # 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 {Wx::Image#has_option} if 0 is a possibly valid value for the option.
+    # Generic options: 
+    # - {Wx::IMAGE_OPTION_MAX_WIDTH} and {Wx::IMAGE_OPTION_MAX_HEIGHT}: If either of these options is specified, the loaded image will be scaled down (preserving its aspect ratio) so that its width is less than the max width given if it is not 0 and its height is less than the max height given if it is not 0. This is typically used for loading thumbnails and the advantage of using these options compared to calling {Wx::Image#rescale} after loading is that some handlers (only JPEG one right now) support rescaling the image during loading which is vastly more efficient than loading the entire huge image and rescaling it later (if these options are not supported by the handler, this is still what happens however). These options must be set before calling {Wx::Image#load_file} to have any effect.
+    # 
+    # - {Wx::IMAGE_OPTION_ORIGINAL_WIDTH} and {Wx::IMAGE_OPTION_ORIGINAL_HEIGHT}: These options will return the original size of the image if either {Wx::IMAGE_OPTION_MAX_WIDTH} or {Wx::IMAGE_OPTION_MAX_HEIGHT} is specified. 
+    # - {Wx::IMAGE_OPTION_QUALITY}: JPEG quality used when saving. This is an integer in 0..100 range with 0 meaning very poor and 100 excellent (but very badly compressed). This option is currently ignored for the other formats.
+    # 
+    # - {Wx::IMAGE_OPTION_RESOLUTIONUNIT}: The value of this option determines whether the resolution of the image is specified in centimetres or inches, see {Wx::ImageResolution} enum elements.
+    # 
+    # - {Wx::IMAGE_OPTION_RESOLUTION}, {Wx::IMAGE_OPTION_RESOLUTIONX} and {Wx::IMAGE_OPTION_RESOLUTIONY}: These options define the resolution of the image in the units corresponding to {Wx::IMAGE_OPTION_RESOLUTIONUNIT} options value. The first option can be set before saving the image to set both horizontal and vertical resolution to the same value. The X and Y options are set by the image handlers if they support the image resolution (currently BMP, JPEG and TIFF handlers do) and the image provides the resolution information and can be queried after loading the image.
+    # 
+    # Options specific to {Wx::PNGHandler}: 
+    # - {Wx::IMAGE_OPTION_PNG_FORMAT}: Format for saving a PNG file, see {Wx::ImagePNGType} for the supported values. 
+    # - {Wx::IMAGE_OPTION_PNG_BITDEPTH}: Bit depth for every channel (R/G/B/A). 
+    # - {Wx::IMAGE_OPTION_PNG_FILTER}: Filter for saving a PNG file, see libpng (http://www.libpng.org/pub/png/libpng-1.2.5-manual.html) for possible values (e.g. PNG_FILTER_NONE, PNG_FILTER_SUB, PNG_FILTER_UP, etc). 
+    # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_LEVEL}: Compression level (0..9) for saving a PNG file. A high value creates smaller-but-slower PNG file. Note that unlike other formats (e.g. JPEG) the PNG format is always lossless and thus this compression level doesn't tradeoff the image quality. 
+    # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL}: Compression memory usage level (1..9) for saving a PNG file. A high value means the saving process consumes more memory, but may create smaller PNG file. 
+    # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_STRATEGY}: Possible values are 0 for default strategy, 1 for filter, and 2 for Huffman-only. You can use OptiPNG (http://optipng.sourceforge.net/) to get a suitable value for your application. 
+    # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE}: Internal buffer size (in bytes) for saving a PNG file. Ideally this should be as big as the resulting PNG file. Use this option if your application produces images with small size variation.
+    # 
+    # Options specific to {Wx::TIFFHandler}: 
+    # - {Wx::IMAGE_OPTION_TIFF_BITSPERSAMPLE}: Number of bits per sample (channel). Currently values of 1 and 8 are supported. A value of 1 results in a black and white image. A value of 8 (the default) can mean greyscale or RGB, depending on the value of {Wx::IMAGE_OPTION_TIFF_SAMPLESPERPIXEL}. 
+    # - {Wx::IMAGE_OPTION_TIFF_SAMPLESPERPIXEL}: Number of samples (channels) per pixel. Currently values of 1 and 3 are supported. A value of 1 results in either a greyscale (by default) or black and white image, depending on the value of {Wx::IMAGE_OPTION_TIFF_BITSPERSAMPLE}. A value of 3 (the default) will result in an RGB image. 
+    # - {Wx::IMAGE_OPTION_TIFF_COMPRESSION}: Compression type. By default it is set to 1 (COMPRESSION_NONE). Typical other values are 5 (COMPRESSION_LZW) and 7 (COMPRESSION_JPEG). See tiff.h for more options. 
+    # - {Wx::IMAGE_OPTION_TIFF_PHOTOMETRIC}: Specifies the photometric interpretation. By default it is set to 2 (PHOTOMETRIC_RGB) for RGB images and 0 (PHOTOMETRIC_MINISWHITE) for greyscale or black and white images. It can also be set to 1 (PHOTOMETRIC_MINISBLACK) to treat the lowest value as black and highest as white. If you want a greyscale image it is also sufficient to only specify {Wx::IMAGE_OPTION_TIFF_PHOTOMETRIC} and set it to either PHOTOMETRIC_MINISWHITE or PHOTOMETRIC_MINISBLACK. The other values are taken care of.
+    # 
+    # Options specific to {Wx::GIFHandler}: 
+    # - {Wx::IMAGE_OPTION_GIF_TRANSPARENCY}: How to deal with transparent pixels. By default, the color of transparent pixels is changed to bright pink, so that if the image is accidentally drawn without transparency, it will be obvious. Normally, this would not be noticed, as these pixels will not be rendered. But in some cases it might be useful to load a GIF without making any modifications to its colours. Use {Wx::IMAGE_OPTION_GIF_TRANSPARENCY_UNCHANGED} to keep the colors correct. Use {Wx::IMAGE_OPTION_GIF_TRANSPARENCY_HIGHLIGHT} to convert transparent pixels to pink (default). This option has been added in wxWidgets 3.1.1.
+    # 
+    # Be careful when combining the options {Wx::IMAGE_OPTION_TIFF_SAMPLESPERPIXEL}, {Wx::IMAGE_OPTION_TIFF_BITSPERSAMPLE}, and {Wx::IMAGE_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.
+    # 
+    # The value of the option or 0 if not found. Use {Wx::Image#has_option} if 0 can be a valid option value.
+    # @see Wx::Image#set_option
+    # @see  Wx::Image#get_option 
+    # @param name [String]  The name of the option, case-insensitive.
+    # @return [Integer]
+    def get_option_int(name) end
+    alias_method :option_int, :get_option_int
+    
+    # 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.
+    # @return [Array(true,false,Integer,Integer,Integer)]
+    def get_or_find_mask_colour; end
+    alias_method :or_find_mask_colour, :get_or_find_mask_colour
+    
+    # Returns the palette associated with the image.
+    # Currently the palette is only used when converting to {Wx::Bitmap} under Windows.
+    # Some of the {Wx::Image} 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).
+    # @return [void]
+    def get_palette; end
+    alias_method :palette, :get_palette
+    
+    # Returns a sub image of the current one as long as the rect belongs entirely to the image.
+    # @param rect [Wx::Rect] 
+    # @return [Wx::Image]
+    def get_sub_image(rect) end
+    alias_method :sub_image, :get_sub_image
+    
+    # Gets the type of image found by {Wx::Image#load_file} or specified with {Wx::Image#save_file}.
+    # @return [BitmapType]
+    def get_type; end
+    alias_method :type, :get_type
+    
+    # Returns true if this image has alpha channel, false otherwise.
+    # 
+    # @see Wx::Image#get_alpha
+    # @see  Wx::Image#set_alpha 
+    # @return [true,false]
+    def has_alpha; end
+    alias_method :has_alpha?, :has_alpha
+    
+    # Returns true if there is a mask active, false otherwise.
+    # @return [true,false]
+    def has_mask; end
+    alias_method :has_mask?, :has_mask
+    
+    # Returns true if the given option is present.
+    # The function is case-insensitive to name.
+    # The lists of the currently supported options are in {Wx::Image#get_option} and {Wx::Image#get_option_int} function docs.
+    # @see Wx::Image#set_option
+    # @see  Wx::Image#get_option
+    # @see  Wx::Image#get_option_int 
+    # @param name [String] 
+    # @return [true,false]
+    def has_option(name) end
+    alias_method :has_option?, :has_option
+    
+    # Returns true if image data is present.
+    # @return [true,false]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # 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.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @param threshold [Integer] 
+    # @return [true,false]
+    def is_transparent(x, y, threshold=Wx::IMAGE_ALPHA_THRESHOLD) end
+    alias_method :transparent?, :is_transparent
+    
+    # @overload load_stream(stream, type=Wx::BITMAP_TYPE_ANY, index=-1)
+    #   Loads an image from an input stream.
+    #   If the file can't be loaded, this function returns false and logs an error using {log_error}. If the file can be loaded but some problems were detected while doing it, it can also call {log_warning} to notify about these problems. If this is undesirable, use {Wx::Image#set_load_flags} to reset Load_Verbose flag and suppress these warnings.
+    #   
+    #   true if the operation succeeded, false otherwise. If the optional index parameter is out of range, false is returned and a call to {log_error} takes place.
+    #   
+    #   Depending on how wxWidgets has been configured, not all formats may be available.
+    #   
+    #   You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files: 
+    #   
+    #     int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
+    #     int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+    #   @see Wx::Image#save_file 
+    #   @param stream [IO,Wx::InputStream]  Opened input stream from which to load the image. Currently, the stream must support seeking.
+    #   @param type [BitmapType]  May be one of the following: 
+    #     - {Wx::BitmapType::BITMAP_TYPE_BMP}: Load a Windows bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_GIF}: Load a GIF bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Load a JPEG bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PNG}: Load a PNG bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PCX}: Load a PCX bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PNM}: Load a PNM bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Load a TIFF bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_TGA}: Load a TGA bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_XPM}: Load a XPM bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_ICO}: Load a Windows icon file (ICO). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_CUR}: Load a Windows cursor file (CUR). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_ANI}: Load a Windows animated cursor file (ANI). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_ANY}: Will try to autodetect the format.
+    #   @param index [Integer]  Index of the image to load in the case that the image file contains multiple images. This is only used by GIF, ICO and TIFF handlers. The default value (-1) means "choose the default image" and is interpreted as the first image (index=0) by the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.
+    #   @return [true,false]
+    # @overload load_stream(stream, mimetype, index=-1)
+    #   Loads an image from an input stream.
+    #   @param stream [IO,Wx::InputStream]  Opened input stream from which to load the image. Currently, the stream must support seeking.
+    #   @param mimetype [String]  MIME type string (for example 'image/jpeg')
+    #   @param index [Integer]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
+    #   @return [true,false]
+    def load_stream(*args) end
+    
+    # @overload load_file(name, type=Wx::BITMAP_TYPE_ANY, index=-1)
+    #   Loads an image from a file.
+    #   If no handler type is provided, the library will try to autodetect the format.
+    #   @param name [String]  Name of the file from which to load the image.
+    #   @param type [BitmapType]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
+    #   @param index [Integer]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
+    #   @return [true,false]
+    # @overload load_file(name, mimetype, index=-1)
+    #   Loads an image from a file.
+    #   If no handler type is provided, the library will try to autodetect the format.
+    #   @param name [String]  Name of the file from which to load the image.
+    #   @param mimetype [String]  MIME type string (for example 'image/jpeg')
+    #   @param index [Integer]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
+    #   @return [true,false]
+    def load_file(*args) end
+    
+    # @overload write(stream, mimetype)
+    #   Saves an image in the given stream.
+    #   true if the operation succeeded, false otherwise.
+    #   
+    #   Depending on how wxWidgets has been configured, not all formats may be available.
+    #   
+    #   You can use {Wx::Image#set_option} to set the hotspot when saving an image into a cursor file (default hotspot is in the centre of the image): 
+    #   
+    #     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotspotX);
+    #     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotspotY);
+    #   @see Wx::Image#load_file 
+    #   @param stream [IO,Wx::OutputStream]  Opened output stream to save the image to.
+    #   @param mimetype [String]  MIME type.
+    #   @return [true,false]
+    # @overload write(stream, type)
+    #   Saves an image in the given stream.
+    #   @param stream [IO,Wx::OutputStream]  Opened output stream to save the image to.
+    #   @param type [BitmapType]  MIME type.
+    #   @return [true,false]
+    def write(*args) end
+    
+    # @overload save_file(name, type)
+    #   Saves an image in the named file.
+    #   @param name [String]  Name of the file to save the image to.
+    #   @param type [BitmapType]  Currently these types can be used: 
+    #     - {Wx::BitmapType::BITMAP_TYPE_BMP}: Save a BMP image file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Save a JPEG image file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PNG}: Save a PNG image file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PCX}: Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PNM}: Save a PNM image file (as raw RGB always). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Save a TIFF image file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_XPM}: Save a XPM image file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_ICO}: Save a Windows icon file (ICO). The size may be up to 255 wide by 127 high. A single image is saved in 8 colors at the size supplied. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_CUR}: Save a Windows cursor file (CUR).
+    #   @return [true,false]
+    # @overload save_file(name, mimetype)
+    #   Saves an image in the named file.
+    #   @param name [String]  Name of the file to save the image to.
+    #   @param mimetype [String]  MIME type.
+    #   @return [true,false]
+    # @overload save_file(name)
+    #   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.
+    #   @param name [String]  Name of the file to save the image to.
+    #   @return [true,false]
+    def save_file(*args) end
+    
+    # This function is similar to {Wx::Image#set_data} 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(). {Wx::Image} 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.
+    # @param alpha [String] 
+    # @return [void]
+    def set_alpha_data(alpha=nil) end
+    alias_method :alpha_data=, :set_alpha_data
+    
+    # Sets the alpha value for the given pixel.
+    # This function should only be called if the image has alpha channel data, use {Wx::Image#has_alpha} to check for this.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @param alpha [Integer] 
+    # @return [void]
+    def set_alpha(x, y, alpha) end
+    alias_method :alpha=, :set_alpha
+    
+    # Removes the alpha channel from the image.
+    # This function should only be called if the image has alpha channel data, use {Wx::Image#has_alpha} to check for this.
+    # @return [void]
+    def clear_alpha; end
+    
+    # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    # @param data [String] 
+    # @param new_width [Integer] 
+    # @param new_height [Integer] 
+    # @return [void]
+    def set_rgb_data_with_size(data, new_width, new_height) end
+    alias_method :rgb_data_with_size=, :set_rgb_data_with_size
+    
+    # Sets the flags used for loading image files by this object.
+    # The flags will affect any future calls to {Wx::Image#load_file} for this object. To change the flags for all image objects, call {Wx::Image.set_default_load_flags} before creating any of them.
+    # Currently the only defined flag is Load_Verbose which determines if the non-fatal (i.e. not preventing the file from being loaded completely) problems should result in the calls to {log_warning} function. It is recommended to customize handling of these warnings by e.g. defining a custom log target (see Logging Overview), but if such warnings should be completely suppressed, clearing this flag provides a simple way to do it, for example: 
+    # 
+    #   wxImage image;
+    #   image.SetLoadFlags(image.GetLoadFlags() & ~wxImage::Load_Verbose);
+    #   image.LoadFile(...);
+    # @see Wx::Image#load_file
+    # @see  Wx::Image#set_load_flags
+    # @see  Wx::Image#get_load_flags
+    # @param flags [Integer] 
+    # @return [void]
+    def set_load_flags(flags) end
+    alias_method :load_flags=, :set_load_flags
+    
+    # Specifies whether there is a mask or not.
+    # The area of the mask is determined by the current mask colour.
+    # @param hasMask [true,false] 
+    # @return [void]
+    def set_mask(hasMask=true) end
+    alias_method :mask=, :set_mask
+    
+    # Sets the mask colour for this image (and tells the image to use the mask).
+    # @param red [Integer] 
+    # @param green [Integer] 
+    # @param blue [Integer] 
+    # @return [void]
+    def set_mask_colour(red, green, blue) end
+    
+    # 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.
+    # 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 that this method involves computing the histogram, which is a computationally intensive operation.
+    # @param mask [Wx::Image] 
+    # @param mr [Integer] 
+    # @param mg [Integer] 
+    # @param mb [Integer] 
+    # @return [true,false]
+    def set_mask_from_image(mask, mr, mg, mb) end
+    
+    # @overload set_option(name, value)
+    #   Sets a user-defined option.
+    #   The function is case-insensitive to name.
+    #   For example, when saving as a JPEG file, the option <b>quality</b> 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 {Wx::Image#get_option} and {Wx::Image#get_option_int} function docs.
+    #   @see Wx::Image#get_option
+    #   @see  Wx::Image#get_option_int
+    #   @see  Wx::Image#has_option 
+    #   @param name [String] 
+    #   @param value [String] 
+    #   @return [void]
+    # @overload set_option(name, value)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param name [String] 
+    #   @param value [Integer] 
+    #   @return [void]
+    def set_option(*args) end
+    
+    # Associates a palette with the image.
+    # The palette may be used when converting {Wx::Image} to {Wx::Bitmap} (MSW only at present) or in file save operations (none as yet).
+    # @param palette [Wx::Palette] 
+    # @return [void]
+    def set_palette(palette) end
+    alias_method :palette=, :set_palette
+    
+    # @overload set_rgb(x, y, r, g, b)
+    #   Set the color of the pixel at the given x and y coordinate.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param r [Integer] 
+    #   @param g [Integer] 
+    #   @param b [Integer] 
+    #   @return [void]
+    # @overload set_rgb(rect, red, green, blue)
+    #   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.
+    #   @param rect [Wx::Rect] 
+    #   @param red [Integer] 
+    #   @param green [Integer] 
+    #   @param blue [Integer] 
+    #   @return [void]
+    def set_rgb(*args) end
+    
+    # Set the type of image returned by {Wx::Image#get_type}.
+    # This method is mostly used internally by the library but can also be called from the user code if the image was created from data in the given bitmap format without using {Wx::Image#load_file} (which would set the type correctly automatically).
+    # Notice that the image must be created before this function is called.
+    # @param type [BitmapType]  One of bitmap type constants, {Wx::BitmapType::BITMAP_TYPE_INVALID} is a valid value for it and can be used to reset the bitmap type to default but {Wx::BITMAP_TYPE_MAX} is not allowed here.
+    # @return [void]
+    def set_type(type) end
+    alias_method :type=, :set_type
+    
+    # Sets the default value for the flags used for loading image files.
+    # This method changes the global value of the flags used for all the subsequently created {Wx::Image} objects by default. It doesn't affect the already existing objects.
+    # By default, the global flags include Load_Verbose flag value.
+    # @see Wx::Image#load_file
+    # @see  Wx::Image#set_load_flags
+    # @see  Wx::Image.get_default_load_flags
+    # @param flags [Integer] 
+    # @return [void]
+    def self.set_default_load_flags(flags) end
+    
+    # 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 Wx::ImageHandler#get_image_count for more info.
+    # The parameter type may be one of the following values: 
+    # - {Wx::BitmapType::BITMAP_TYPE_BMP}: Load a Windows bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_GIF}: Load a GIF bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Load a JPEG bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_PNG}: Load a PNG bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_PCX}: Load a PCX bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_PNM}: Load a PNM bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Load a TIFF bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_TGA}: Load a TGA bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_XPM}: Load a XPM bitmap file. 
+    # - {Wx::BitmapType::BITMAP_TYPE_ICO}: Load a Windows icon file (ICO). 
+    # - {Wx::BitmapType::BITMAP_TYPE_CUR}: Load a Windows cursor file (CUR). 
+    # - {Wx::BitmapType::BITMAP_TYPE_ANI}: Load a Windows animated cursor file (ANI). 
+    # - {Wx::BitmapType::BITMAP_TYPE_ANY}: Will try to autodetect the format.
+    # 
+    # 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).
+    # @param filename [String] 
+    # @param type [BitmapType] 
+    # @return [Integer]
+    def self.get_image_count(filename, type=Wx::BITMAP_TYPE_ANY) end
+    
+    # @overload initialize()
+    #   Creates an empty {Wx::Image} object without an alpha channel.
+    #   @return [Image]
+    # @overload initialize(width, height, clear=true)
+    #   Creates an image with the given size and clears it if requested.
+    #   Does not create an alpha channel.
+    #   @param width [Integer]  Specifies the width of the image.
+    #   @param height [Integer]  Specifies the height of the image.
+    #   @param clear [true,false]  If true, initialize the image to black.
+    #   @return [Image]
+    # @overload initialize(sz, clear=true)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param clear [true,false] 
+    #   @return [Image]
+    # @overload initialize(width, height, data)
+    #   Creates an image from data in memory.
+    #   If static_data is false then the {Wx::Image} will take ownership of the data and free it afterwards. For this, it has to be allocated with malloc.
+    #   @param width [Integer]  Specifies the width of the image.
+    #   @param height [Integer]  Specifies the height of the image.
+    #   @param data [String]  A pointer to RGB data
+    #   @return [Image]
+    # @overload initialize(sz, data)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param data [String] 
+    #   @return [Image]
+    # @overload initialize(width, height, data, alpha)
+    #   Creates an image from data in memory.
+    #   If static_data is false then the {Wx::Image} will take ownership of the data and free it afterwards. For this, it has to be allocated with malloc.
+    #   @param width [Integer]  Specifies the width of the image.
+    #   @param height [Integer]  Specifies the height of the image.
+    #   @param data [String]  A pointer to RGB data
+    #   @param alpha [String]  A pointer to alpha-channel data
+    #   @return [Image]
+    # @overload initialize(sz, data, alpha)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param data [String] 
+    #   @param alpha [String] 
+    #   @return [Image]
+    # @overload initialize(xpmData)
+    #   Creates an image from XPM data.
+    #   <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}. 
+    #   This constructor has become explicit in wxWidgets 3.1.6.
+    #   @param xpmData [char]  A pointer to XPM image data.
+    #   @return [Image]
+    # @overload initialize(name, type=Wx::BITMAP_TYPE_ANY, index=-1)
+    #   Creates an image from a file.
+    #   Depending on how wxWidgets has been configured and by which handlers have been loaded, not all formats may be available. Any handler other than BMP must be previously initialized with {Wx::Image.add_handler} or {init_all_image_handlers}.
+    #   
+    #   You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files: 
+    #   
+    #     int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
+    #     int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+    #   @see Wx::Image#load_file 
+    #   @param name [String]  Name of the file from which to load the image.
+    #   @param type [BitmapType]  May be one of the following: 
+    #     - {Wx::BitmapType::BITMAP_TYPE_BMP}: Load a Windows bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_GIF}: Load a GIF bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Load a JPEG bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PNG}: Load a PNG bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PCX}: Load a PCX bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_PNM}: Load a PNM bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Load a TIFF bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_TGA}: Load a TGA bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_XPM}: Load a XPM bitmap file. 
+    #     - {Wx::BitmapType::BITMAP_TYPE_ICO}: Load a Windows icon file (ICO). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_CUR}: Load a Windows cursor file (CUR). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_ANI}: Load a Windows animated cursor file (ANI). 
+    #     - {Wx::BitmapType::BITMAP_TYPE_ANY}: Will try to autodetect the format.
+    #   @param index [Integer]  Index of the image to load in the case that the image file contains multiple images. This is only used by GIF, ICO and TIFF handlers. The default value (-1) means "choose the default image" and is interpreted as the first image (index=0) by the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.
+    #   @return [Image]
+    # @overload initialize(name, mimetype, index=-1)
+    #   Creates an image from a file using MIME-types to specify the type.
+    #   @param name [String]  Name of the file from which to load the image.
+    #   @param mimetype [String]  MIME type string (for example 'image/jpeg')
+    #   @param index [Integer]  See description in wxImage(const wxString&, wxBitmapType, int) overload.
+    #   @return [Image]
+    def initialize(*args) end
+    
+    # Returns the file load flags used for this object.
+    # See {Wx::Image#set_load_flags} for more information about these flags.
+    # @return [Integer]
+    def get_load_flags; end
+    alias_method :load_flags, :get_load_flags
+    
+    # @overload self.can_read(filename)
+    #   Returns true if at least one of the available image handlers can read the file with the given name.
+    #   See Wx::ImageHandler::CanRead for more info.
+    #   @param filename [String] 
+    #   @return [true,false]
+    # @overload self.can_read(stream)
+    #   Returns true if at least one of the available image handlers can read the data in the given stream.
+    #   See Wx::ImageHandler::CanRead for more info.
+    #   @param stream [IO,Wx::InputStream] 
+    #   @return [true,false]
+    def self.can_read(*args) end
+    
+    # Returns the currently used default file load flags.
+    # See {Wx::Image.set_default_load_flags} for more information about these flags.
+    # @return [Integer]
+    def self.get_default_load_flags; end
+    
+    # Iterates all registered {Wx::ImageHandler} objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes.
+    # The format of the returned string is <code>"(*.ext1;*.ext2)|*.ext1;*.ext2"</code>. It is usually a good idea to prepend a description before passing the result to the dialog. Example: 
+    # 
+    #   wxFileDialog FileDlg( this, "Choose Image", ::wxGetCwd(), "",
+    #                         _("Image Files ") + wxImage::GetImageExtWildcard(),
+    #                         wxFD_OPEN );
+    # @see Wx::ImageHandler 
+    # @return [String]
+    def self.get_image_ext_wildcard; end
+    
+    # Converts a color in RGB color space to HSV color space.
+    # @param rgb [Wx::Image::RGBValue] 
+    # @return [Wx::Image::HSVValue]
+    def self.rg_bto_hsv(rgb) end
+    
+    # Converts a color in HSV color space to RGB color space.
+    # @param hsv [Wx::Image::HSVValue] 
+    # @return [Wx::Image::RGBValue]
+    def self.hs_vto_rgb(hsv) end
+    
+  end # Image
+  
+
+end