wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -99,6 +99,7 @@ module Wx
   # @see Wx::Image#get_option_int. 
   # 
   # 
+  # @wxrb_require USE_IMAGE
   class ImageResolution < Wx::Enum
   
     # Resolution not specified.
@@ -119,6 +120,7 @@ module Wx
   # 
   # This is used with {Wx::Image#scale} and {Wx::Image#rescale}.
   # 
+  # @wxrb_require USE_IMAGE
   class ImageResizeQuality < Wx::Enum
   
     # Simplest and fastest algorithm.
@@ -151,6 +153,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_IMAGE
   class ImageAlphaBlendMode < Wx::Enum
   
     # Overwrite the original alpha values with the ones being pasted.
@@ -169,6 +172,7 @@ module Wx
   # @see Wx::Image#get_option_int. 
   # 
   # 
+  # @wxrb_require USE_IMAGE
   class ImagePNGType < Wx::Enum
   
     # Colour PNG image.
@@ -242,18 +246,19 @@ module Wx
   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
+  # ## 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
+  # ## Available image handlers
   # 
   # The following image handlers are available. {Wx::BMPHandler} is always installed by default. In wxRuby all image handlers are loaded by default at startup by {init_all_image_handlers}.
   # 
@@ -274,7 +279,6 @@ module Wx
   # 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}
@@ -283,6 +287,7 @@ module Wx
   # @see  Wx::PixelData 
   # 
   # 
+  # @wxrb_require USE_IMAGE
   class Image < Object
   
     # Returns an identical copy of this image.
@@ -291,6 +296,7 @@ module Wx
     
     # @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] 
@@ -304,6 +310,7 @@ module Wx
     #   @return [Boolean]
     # @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] 
@@ -317,6 +324,7 @@ module Wx
     #   @return [Boolean]
     # @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] 
@@ -342,11 +350,13 @@ module Wx
     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 
@@ -355,6 +365,7 @@ module Wx
     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 
@@ -363,6 +374,7 @@ module Wx
     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 
@@ -371,12 +383,14 @@ module Wx
     def blur_vertical(blurRadius) end
     
     # Returns a mirrored copy of the image.
+    # 
     # The parameter horizontally indicates the orientation.
     # @param horizontally [Boolean] 
     # @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.
@@ -396,6 +410,7 @@ module Wx
     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] 
@@ -405,6 +420,7 @@ module Wx
     def rescale(width, height, quality=Wx::ImageResizeQuality::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.
@@ -418,6 +434,7 @@ module Wx
     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.
@@ -443,18 +460,21 @@ module Wx
     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] 
@@ -463,6 +483,7 @@ module Wx
     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.
@@ -483,7 +504,11 @@ module Wx
     #   end
     # ```
     # 
-    # 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.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>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.
+    # </p>
+    # </div>
     # @see Wx::Image#rescale 
     # @param width [Integer] 
     # @param height [Integer] 
@@ -492,6 +517,7 @@ module Wx
     def scale(width, height, quality=Wx::ImageResizeQuality::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.
@@ -506,6 +532,7 @@ module Wx
     
     # @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.
@@ -513,6 +540,7 @@ module Wx
     #   @return [Boolean]
     # @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.
@@ -525,8 +553,14 @@ module Wx
     
     # @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.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This function calls {Wx::Colour.make_grey} for each pixel in the image. 
+    #   </p>
+    #   </div>
     #   @param weight_r [Float] 
     #   @param weight_g [Float] 
     #   @param weight_b [Float] 
@@ -537,8 +571,14 @@ module Wx
     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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function calls {Wx::Colour.make_mono} for each pixel in the image. 
+    # </p>
+    # </div>
     # @param r [Integer] 
     # @param g [Integer] 
     # @param b [Integer] 
@@ -546,25 +586,41 @@ module Wx
     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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function calls {Wx::Colour#make_disabled} for each pixel in the image.
+    # </p>
+    # </div>
     # @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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function calls {Wx::Colour#change_lightness} for each pixel in the image.
+    # </p>
+    # </div>
     # @param alpha [Integer] 
     # @return [Wx::Image]
     def change_lightness(alpha) 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.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This method involves computing the histogram, which is a computationally intensive operation. 
+    # </p>
+    # </div>
     # @param startR [Integer] 
     # @param startG [Integer] 
     # @param startB [Integer] 
@@ -609,6 +665,7 @@ module Wx
     
     # Gets the width of the image in pixels.
     # 
+    # 
     # @see Wx::Image#get_height
     # @see  Wx::Image#get_size 
     # @return [Integer]
@@ -617,6 +674,7 @@ module Wx
     
     # Gets the height of the image in pixels.
     # 
+    # 
     # @see Wx::Image#get_width
     # @see  Wx::Image#get_size 
     # @return [Integer]
@@ -625,12 +683,14 @@ module Wx
     
     # 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.
@@ -649,6 +709,7 @@ module Wx
     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: 
     # 
@@ -692,7 +753,11 @@ module Wx
     # 
     # - {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.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>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.
+    # </p>
+    # </div>
     # 
     # 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
@@ -703,12 +768,14 @@ module Wx
     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(Boolean,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 [Wx::Palette]
@@ -728,6 +795,7 @@ module Wx
     
     # Returns true if this image has alpha channel, false otherwise.
     # 
+    # 
     # @see Wx::Image#get_alpha
     # @see  Wx::Image#set_alpha 
     # @return [Boolean]
@@ -740,6 +808,7 @@ module Wx
     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
@@ -765,17 +834,27 @@ module Wx
     
     # @overload load_stream(stream, type=Wx::BitmapType::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.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Depending on how wxWidgets has been configured, not all formats may be available.
+    #   </p>
+    #   </div>
     #   
-    #   You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files: 
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files: 
     #   ```ruby
     #     hotspot_x = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_X)
     #     hotspot_y = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_Y)
     #   ```
+    #   
+    #   </p>
+    #   </div>
     #   @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 [Wx::BitmapType]  May be one of the following: 
@@ -817,6 +896,7 @@ module Wx
     
     # @overload load_file(name, type=Wx::BitmapType::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 [Wx::BitmapType]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
@@ -824,6 +904,7 @@ module Wx
     #   @return [Boolean]
     # @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')
@@ -833,15 +914,25 @@ module Wx
     
     # @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.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Depending on how wxWidgets has been configured, not all formats may be available.
+    #   </p>
+    #   </div>
     #   
-    #   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): 
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>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): 
     #   ```ruby
     #     image.set_option(Wx::IMAGE_OPTION_CUR_HOTSPOT_X, hotspot_x)
     #     image.set_option(Wx::IMAGE_OPTION_CUR_HOTSPOT_Y, hotspot_y)
     #   ```
+    #   
+    #   </p>
+    #   </div>
     #   @see Wx::Image#load_file 
     #   @param stream [IO,Wx::OutputStream]  Opened output stream to save the image to.
     #   @param mimetype [String]  MIME type.
@@ -883,29 +974,31 @@ module Wx
     #   @return [Boolean]
     # @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 [Boolean]
     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
@@ -916,9 +1009,9 @@ module Wx
     # @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: 
     # ```ruby
@@ -935,6 +1028,7 @@ module Wx
     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 [Boolean] 
     # @return [void]
@@ -949,12 +1043,17 @@ module Wx
     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.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Note that this method involves computing the histogram, which is a computationally intensive operation. 
+    # </p>
+    # </div>
     # @param mask [Wx::Image] 
     # @param mr [Integer] 
     # @param mg [Integer] 
@@ -964,6 +1063,7 @@ module Wx
     
     # @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.
@@ -981,6 +1081,7 @@ module Wx
     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]
@@ -997,6 +1098,7 @@ module Wx
     #   @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] 
@@ -1006,6 +1108,7 @@ module Wx
     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 [Wx::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.
@@ -1014,6 +1117,7 @@ module Wx
     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
@@ -1024,6 +1128,7 @@ module Wx
     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: 
@@ -1065,6 +1170,7 @@ module Wx
     #   @return [Wx::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.
@@ -1077,6 +1183,7 @@ module Wx
     #   @return [Wx::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.
@@ -1089,6 +1196,7 @@ module Wx
     #   @return [Wx::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.
@@ -1103,13 +1211,23 @@ module Wx
     #   @return [Wx::Image]
     # @overload initialize(name, type=Wx::BitmapType::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: 
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>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}.
+    #   </p>
+    #   </div>
+    #   
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files: 
     #   ```ruby
     #     hotspot_x = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_X)
     #     hotspot_y = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_Y)
     #   ```
+    #   
+    #   </p>
+    #   </div>
     #   @see Wx::Image#load_file 
     #   @param name [String]  Name of the file from which to load the image.
     #   @param type [Wx::BitmapType]  May be one of the following: 
@@ -1150,6 +1268,7 @@ module Wx
     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
@@ -1157,22 +1276,26 @@ module Wx
     
     # @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 [Boolean]
     # @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 [Boolean]
     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: 
     # ```ruby
     #   Wx::FileDialog(self, 'Choose Image', Dir.getwd, '',