wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

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

@@ -0,0 +1,1278 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Logical raster operations which can be used with {Wx::DC#set_logical_function} and some other {Wx::DC} functions (e.g.
+  # 
+  # {Wx::DC#blit} and {Wx::DC#stretch_blit}).
+  # The description of the values below refer to how a generic src source pixel and the corresponding dst destination pixel gets combined together to produce the final pixel. E.g. {Wx::RasterOperationMode::CLEAR} and {Wx::RasterOperationMode::SET} completely ignore the source and the destination pixel and always put zeroes or ones in the final surface.
+  # Note that not all modes are supported under all platforms. Notably {Wx::GTK3} and {Wx::Mac} only support the following modes:
+  # - {Wx::RasterOperationMode::COPY}- {Wx::RasterOperationMode::OR}- {Wx::RasterOperationMode::NO_OP}- {Wx::RasterOperationMode::CLEAR}- {Wx::RasterOperationMode::XOR} and only support the commonly used {Wx::RasterOperationMode::INVERT} when the source colour is white (as it is implemented using {Wx::CompositionMode::COMPOSITION_DIFF} composition mode).
+  # 
+  class RasterOperationMode < Wx::Enum
+  
+    # 0
+    # 
+    CLEAR = Wx::RasterOperationMode.new(0)
+    
+    # src XOR dst
+    # 
+    XOR = Wx::RasterOperationMode.new(1)
+    
+    # NOT dst.
+    # 
+    INVERT = Wx::RasterOperationMode.new(2)
+    
+    # src OR (NOT dst)
+    # 
+    OR_REVERSE = Wx::RasterOperationMode.new(3)
+    
+    # src AND (NOT dst)
+    # 
+    AND_REVERSE = Wx::RasterOperationMode.new(4)
+    
+    # src
+    # 
+    COPY = Wx::RasterOperationMode.new(5)
+    
+    # src AND dst
+    # 
+    AND = Wx::RasterOperationMode.new(6)
+    
+    # (NOT src) AND dst
+    # 
+    AND_INVERT = Wx::RasterOperationMode.new(7)
+    
+    # dst
+    # 
+    NO_OP = Wx::RasterOperationMode.new(8)
+    
+    # (NOT src) AND (NOT dst)
+    # 
+    NOR = Wx::RasterOperationMode.new(9)
+    
+    # (NOT src) XOR dst
+    # 
+    EQUIV = Wx::RasterOperationMode.new(10)
+    
+    # (NOT src)
+    # 
+    SRC_INVERT = Wx::RasterOperationMode.new(11)
+    
+    # (NOT src) OR dst
+    # 
+    OR_INVERT = Wx::RasterOperationMode.new(12)
+    
+    # (NOT src) OR (NOT dst)
+    # 
+    NAND = Wx::RasterOperationMode.new(13)
+    
+    # src OR dst
+    # 
+    OR = Wx::RasterOperationMode.new(14)
+    
+    # 1
+    # 
+    SET = Wx::RasterOperationMode.new(15)
+    
+  end # RasterOperationMode
+  
+  # Flood styles used by {Wx::DC#flood_fill}.
+  # 
+  # 
+  # 
+  class FloodFillStyle < Wx::Enum
+  
+    # The flooding occurs until a colour other than the given colour is encountered.
+    # 
+    FLOOD_SURFACE = Wx::FloodFillStyle.new(1)
+    
+    # The area to be flooded is bounded by the given colour.
+    # 
+    FLOOD_BORDER = Wx::FloodFillStyle.new(2)
+    
+  end # FloodFillStyle
+  
+  # The mapping used to transform logical units to device units.
+  # 
+  # See {Wx::DC#set_map_mode}.
+  # 
+  class MappingMode < Wx::Enum
+  
+    # Each logical unit is 1 device pixel.
+    # 
+    MM_TEXT = Wx::MappingMode.new(1)
+    
+    # Each logical unit is 1 millimeter.
+    # 
+    MM_METRIC = Wx::MappingMode.new(2)
+    
+    # Each logical unit is 1/10 of a millimeter.
+    # 
+    MM_LOMETRIC = Wx::MappingMode.new(3)
+    
+    # Each logical unit is 1/20 of a "printer point", or 1/1440 of an inch (also known as "twip").
+    # 
+    MM_TWIPS = Wx::MappingMode.new(4)
+    
+    # Each logical unit is a "printer point" i.e. 1/72 of an inch.
+    # 
+    MM_POINTS = Wx::MappingMode.new(5)
+    
+  end # MappingMode
+  
+  # A {Wx::DC} is a "device context" onto which graphics and text can be drawn.
+  # It is intended to represent different output devices and offers a common abstract API for drawing on any of them.
+  # wxWidgets offers an alternative drawing API based on the modern drawing backends GDI+, CoreGraphics, Cairo and Direct2D. See {Wx::GraphicsContext}, {Wx::GraphicsRenderer} and related classes. There is also a {Wx::GCDC} linking the APIs by offering the {Wx::DC} API on top of a {Wx::GraphicsContext}.
+  # {Wx::DC} is an abstract base class and cannot be created directly. Use {Wx::PaintDC}, {Wx::ClientDC}, {Wx::WindowDC}, {Wx::ScreenDC}, {Wx::MemoryDC} or {Wx::PRT::PrinterDC}. Notice that device contexts which are associated with windows (i.e. {Wx::ClientDC}, {Wx::WindowDC} and {Wx::PaintDC}) use the window font and colours by default (starting with wxWidgets 2.9.0) but the other device context classes use system-default values so you always must set the appropriate fonts and colours before using them.
+  # In addition to the versions of the methods documented below, there are also versions which accept single {Wx::Point} parameter instead of the two {Wx::Coord} ones or {Wx::Point} and {Wx::Size} instead of the four {Wx::Coord} parameters.
+  # Beginning with wxWidgets 2.9.0 the entire {Wx::DC} code has been reorganized. All platform dependent code (actually all drawing code) has been moved into backend classes which derive from a common {Wx::DCImpl} class. The user-visible classes such as {Wx::ClientDC} and {Wx::PaintDC} merely forward all calls to the backend implementation.
+  # 
+  # == Device and logical units
+  # 
+  # In the {Wx::DC} context there is a distinction between logical units and device units.
+  # <b>Device</b> units are the units native to the particular device; e.g. for a screen, a device unit is a pixel. For a printer, the device unit is defined by the resolution of the printer (usually given in DPI: dot-per-inch).
+  # All {Wx::DC} functions use instead <b>logical</b> units, unless where explicitly stated. Logical units are arbitrary units mapped to device units using the current mapping mode (see {Wx::DC#set_map_mode}).
+  # This mechanism allows reusing the same code which prints on e.g. a window on the screen to print on e.g. a paper.
+  # 
+  # == Support for Transparency / Alpha Channel
+  # 
+  # In general {Wx::DC} methods don't support alpha transparency and the alpha component of {Wx::Colour} is simply ignored and you need to use {Wx::GraphicsContext} for full transparency support. There are, however, a few exceptions: first, under macOS and GTK+ 3 colours with alpha channel are supported in all the normal {Wx::DC}-derived classes as they use {Wx::GraphicsContext} internally. Second, under all platforms {Wx::SVGFileDC} also fully supports alpha channel. In both of these cases the instances of {Wx::Pen} or {Wx::Brush} that are built from {Wx::Colour} use the colour's alpha values when stroking or filling.
+  # 
+  # == Support for Transformation Matrix
+  # 
+  # On some platforms (currently under MSW, GTK+ 3, macOS) {Wx::DC} has support for applying an arbitrary affine transformation matrix to its coordinate system (since 3.1.1 this feature is also supported by {Wx::GCDC} in all ports). Call {Wx::DC#can_use_transform_matrix} to check if this support is available and then call {Wx::DC#set_transform_matrix} if it is. If the transformation matrix is not supported, {Wx::DC#set_transform_matrix} always simply returns false and doesn't do anything.
+  # This feature is only available when {Wx::Setup::USE_DC_TRANSFORM_MATRIX} build option is enabled.
+  # === 
+  # 
+  # Category:  Device Contexts, Graphics Device Interface (GDI)
+  # 
+  # TodoPrecise definition of default/initial state. 
+  # Pixelwise definition of operations (e.g. last point of a line not drawn).
+  # @see Device Contexts
+  # @see  Wx::GraphicsContext
+  # @see  Wx::DCFontChanger
+  # @see  Wx::DCTextColourChanger
+  # @see  Wx::DCPenChanger
+  # @see  Wx::DCBrushChanger
+  # @see  Wx::DCClipper
+  # 
+  # 
+  class DC < Object
+  
+    # Convert device X coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param x [Integer] 
+    # @return [Integer]
+    def device_to_logical_x(x) end
+    
+    # Convert device X coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # Use this for converting a horizontal distance like for example a width.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param x [Integer] 
+    # @return [Integer]
+    def device_to_logical_x_rel(x) end
+    
+    # Converts device Y coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param y [Integer] 
+    # @return [Integer]
+    def device_to_logical_y(y) end
+    
+    # Convert device Y coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # Use this for converting a vertical distance like for example a height.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param y [Integer] 
+    # @return [Integer]
+    def device_to_logical_y_rel(y) end
+    
+    # Converts logical X coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param x [Integer] 
+    # @return [Integer]
+    def logical_to_device_x(x) end
+    
+    # Converts logical X coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # Use this for converting a horizontal distance like for example a width.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param x [Integer] 
+    # @return [Integer]
+    def logical_to_device_x_rel(x) end
+    
+    # Converts logical Y coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param y [Integer] 
+    # @return [Integer]
+    def logical_to_device_y(y) end
+    
+    # Converts logical Y coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # Use this for converting a vertical distance like for example a height.
+    # Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account.
+    # @param y [Integer] 
+    # @return [Integer]
+    def logical_to_device_y_rel(y) end
+    
+    # @overload device_to_logical(x, y)
+    #   Converts device (x, y) coordinates to logical coordinates taking into account all applied transformations like the current mapping mode, scale factors, device origin, axes orientation, affine transformation.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [Wx::Point]
+    # @overload device_to_logical(pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [Wx::Point]
+    def device_to_logical(*args) end
+    
+    # @overload device_to_logical_rel(x, y)
+    #   Converts device x, y coordinates to relative logical coordinates taking into account all applied transformations like the current mapping mode, scale factors, affine transformation.
+    #   Use this for converting distances like e.g. width and height.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [Wx::Size]
+    # @overload device_to_logical_rel(dim)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param dim [Array(Integer, Integer), Wx::Size] 
+    #   @return [Wx::Size]
+    def device_to_logical_rel(*args) end
+    
+    # @overload logical_to_device(x, y)
+    #   Converts logical (x, y) coordinates to device coordinates taking into account all applied transformations like the current mapping mode, scale factors, device origin, axes orientation, affine transformation.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [Wx::Point]
+    # @overload logical_to_device(pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [Wx::Point]
+    def logical_to_device(*args) end
+    
+    # @overload logical_to_device_rel(x, y)
+    #   Converts logical x, y coordinates to relative device coordinates taking into account all applied transformations like the current mapping mode, scale factors, affine transformation.
+    #   Use this for converting distances like e.g. width and height.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [Wx::Size]
+    # @overload logical_to_device_rel(dim)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param dim [Array(Integer, Integer), Wx::Size] 
+    #   @return [Wx::Size]
+    def logical_to_device_rel(*args) end
+    
+    # Clears the device context using the current background brush.
+    # Note that {Wx::DC#set_background} method must be used to set the brush used by {Wx::DC#clear}, the brush used for filling the shapes set by {Wx::DC#set_brush} is ignored by it.
+    # If no background brush was set, solid white brush is used to clear the device context.
+    # @return [void]
+    def clear; end
+    
+    # @overload draw_arc(xStart, yStart, xEnd, yEnd, xc, yc)
+    #   Draws an arc from the given start to the given end point.
+    #   {Wx::DC#draw_elliptic_arc} has more clear semantics and it is recommended to use it instead of this function.
+    #   
+    #   The arc drawn is an arc of the circle centered at (xc, yc). Its start point is (xStart, yStart) whereas its end point is the point of intersection of the line passing by (xc, yc) and (xEnd, yEnd) with the circle passing by (xStart, yStart).
+    #   The arc is drawn in a counter-clockwise direction between the start and the end points.
+    #   The current pen is used for the outline and the current brush for filling the shape. Notice that unless the brush is transparent, the lines connecting the centre of the circle to the end points of the arc are drawn as well.
+    #   @param xStart [Integer] 
+    #   @param yStart [Integer] 
+    #   @param xEnd [Integer] 
+    #   @param yEnd [Integer] 
+    #   @param xc [Integer] 
+    #   @param yc [Integer] 
+    #   @return [void]
+    # @overload draw_arc(ptStart, ptEnd, centre)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param ptStart [Array(Integer, Integer), Wx::Point] 
+    #   @param ptEnd [Array(Integer, Integer), Wx::Point] 
+    #   @param centre [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def draw_arc(*args) end
+    
+    # @overload draw_bitmap(bitmap, x, y, useMask=false)
+    #   Draw a bitmap on the device context at the specified point.
+    #   If useMask is true and the bitmap has a transparency mask, the bitmap will be drawn transparently.
+    #   When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground of the bitmap (all bits set to 1), and the current text background colour to draw the background (all bits set to 0).
+    #   @see Wx::DC#set_text_foreground
+    #   @see  Wx::DC#set_text_background
+    #   @see  Wx::MemoryDC 
+    #   @param bitmap [Wx::Bitmap] 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param useMask [true,false] 
+    #   @return [void]
+    # @overload draw_bitmap(bmp, pt, useMask=false)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param bmp [Wx::Bitmap] 
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param useMask [true,false] 
+    #   @return [void]
+    def draw_bitmap(*args) end
+    
+    # @overload draw_check_mark(x, y, width, height)
+    #   Draws a check mark inside the given rectangle.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @return [void]
+    # @overload draw_check_mark(rect)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param rect [Wx::Rect] 
+    #   @return [void]
+    def draw_check_mark(*args) end
+    
+    # @overload draw_circle(x, y, radius)
+    #   Draws a circle with the given centre and radius.
+    #   
+    #   @see Wx::DC#draw_ellipse 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param radius [Integer] 
+    #   @return [void]
+    # @overload draw_circle(pt, radius)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param radius [Integer] 
+    #   @return [void]
+    def draw_circle(*args) end
+    
+    # @overload draw_ellipse(x, y, width, height)
+    #   Draws an ellipse contained in the rectangle specified either with the given top left corner and the given size or directly.
+    #   The current pen is used for the outline and the current brush for filling the shape.
+    #   @see Wx::DC#draw_circle 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @return [void]
+    # @overload draw_ellipse(pt, size)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @return [void]
+    # @overload draw_ellipse(rect)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param rect [Wx::Rect] 
+    #   @return [void]
+    def draw_ellipse(*args) end
+    
+    # @overload draw_elliptic_arc(x, y, width, height, start, end_)
+    #   Draws an arc of an ellipse.
+    #   The current pen is used for drawing the arc and the current brush is used for drawing the pie.
+    #   x and y specify the x and y coordinates of the upper-left corner of the rectangle that contains the ellipse.
+    #   width and height specify the width and height of the rectangle that contains the ellipse.
+    #   start and end specify the end points of the arc relative to the three-o'clock position from the center of the rectangle. Angles are specified in degrees with 0 degree angle corresponding to the positive horizontal axis (3 o'clock) direction.
+    #   Independently of whether start is greater than or less than end, the arc is drawn in the counter-clockwise direction. Also, if start is equal to end, a complete ellipse is drawn.
+    #   Notice that unlike {Wx::DC#draw_arc}, this function does not draw the lines to the arc ends, even when using non-transparent brush.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @param start [Float] 
+    #   @param end_ [Float] 
+    #   @return [void]
+    # @overload draw_elliptic_arc(pt, sz, sa, ea)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param sa [Float] 
+    #   @param ea [Float] 
+    #   @return [void]
+    def draw_elliptic_arc(*args) end
+    
+    # @overload draw_icon(icon, x, y)
+    #   Draw an icon on the display (does nothing if the device context is PostScript).
+    #   This can be the simplest way of drawing bitmaps on a window.
+    #   @param icon [Wx::Icon] 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [void]
+    # @overload draw_icon(icon, pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param icon [Wx::Icon] 
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def draw_icon(*args) end
+    
+    # @overload draw_label(text, bitmap, rect, alignment=(Wx::ALIGN_LEFT|Wx::ALIGN_TOP), indexAccel=-1, rectBounding=nil)
+    #   Draw optional bitmap and the text into the given rectangle and aligns it as specified by alignment parameter; it also will emphasize the character with the given index if it is != -1 and return the bounding rectangle if required.
+    #   @param text [String] 
+    #   @param bitmap [Wx::Bitmap] 
+    #   @param rect [Wx::Rect] 
+    #   @param alignment [Integer] 
+    #   @param indexAccel [Integer] 
+    #   @param rectBounding [Wx::Rect] 
+    #   @return [void]
+    # @overload draw_label(text, rect, alignment=(Wx::ALIGN_LEFT|Wx::ALIGN_TOP), indexAccel=-1)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param text [String] 
+    #   @param rect [Wx::Rect] 
+    #   @param alignment [Integer] 
+    #   @param indexAccel [Integer] 
+    #   @return [void]
+    def draw_label(*args) end
+    
+    # @overload draw_line(x1, y1, x2, y2)
+    #   Draws a line from the first point to the second.
+    #   The current pen is used for drawing the line. Note that the point (x2, y2) is not part of the line and is not drawn by this function (this is consistent with the behaviour of many other toolkits).
+    #   @param x1 [Integer] 
+    #   @param y1 [Integer] 
+    #   @param x2 [Integer] 
+    #   @param y2 [Integer] 
+    #   @return [void]
+    # @overload draw_line(pt1, pt2)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt1 [Array(Integer, Integer), Wx::Point] 
+    #   @param pt2 [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def draw_line(*args) end
+    
+    # Draws lines using an array of points of size n adding the optional offset coordinate.
+    # The current pen is used for drawing the lines.
+    # <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
+    # @param points [Array<Wx::Point>,Array<Array<Integer>>] 
+    # @param xoffset [Integer] 
+    # @param yoffset [Integer] 
+    # @return [void]
+    def draw_lines(points, xoffset=0, yoffset=0) end
+    
+    # @overload draw_point(x, y)
+    #   Draws a point using the color of the current pen.
+    #   Note that the other properties of the pen are not used, such as width.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [void]
+    # @overload draw_point(pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def draw_point(*args) end
+    
+    # Draws a filled polygon using an array of points of size n, adding the optional offset coordinate.
+    # The first and last points are automatically closed.
+    # The last argument specifies the fill rule: <b>{Wx::PolygonFillMode::ODDEVEN_RULE}</b> (the default) or <b>{Wx::PolygonFillMode::WINDING_RULE}</b>.
+    # The current pen is used for drawing the outline, and the current brush for filling the shape. Using a transparent brush suppresses filling.
+    # <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
+    # @param points [Array<Wx::Point>,Array<Array<Integer>>] 
+    # @param xoffset [Integer] 
+    # @param yoffset [Integer] 
+    # @param fill_style [PolygonFillMode] 
+    # @return [void]
+    def draw_polygon(points, xoffset=0, yoffset=0, fill_style=Wx::ODDEVEN_RULE) end
+    
+    # Draws two or more filled polygons using an array of points, adding the optional offset coordinates.
+    # Notice that for the platforms providing a native implementation of this function (Windows and PostScript-based {Wx::DC} currently), this is more efficient than using {Wx::DC#draw_polygon} in a loop.
+    # n specifies the number of polygons to draw, the array count of size n specifies the number of points in each of the polygons in the points array.
+    # The last argument specifies the fill rule: <b>{Wx::PolygonFillMode::ODDEVEN_RULE}</b> (the default) or <b>{Wx::PolygonFillMode::WINDING_RULE}</b>.
+    # The current pen is used for drawing the outline, and the current brush for filling the shape. Using a transparent brush suppresses filling.
+    # The polygons maybe disjoint or overlapping. Each polygon specified in a call to {Wx::DC#draw_poly_polygon} must be closed. Unlike polygons created by the {Wx::DC#draw_polygon} member function, the polygons created by this method are not closed automatically.
+    # @param points [Array<Array<Wx::Point>>,Array<Array<Array<Integer>>>] 
+    # @param xoffset [Integer] 
+    # @param yoffset [Integer] 
+    # @param fill_style [PolygonFillMode] 
+    # @return [void]
+    def draw_poly_polygon(points, xoffset=0, yoffset=0, fill_style=Wx::ODDEVEN_RULE) end
+    
+    # @overload draw_rectangle(x, y, width, height)
+    #   Draws a rectangle with the given corner coordinate and size.
+    #   Normally, x and y specify the top left corner coordinates and both width and height are positive, however they are also allowed to be negative, in which case the corresponding corner coordinate refers to the right or bottom corner instead.
+    #   The current pen is used for the outline and the current brush for filling the shape.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @return [void]
+    # @overload draw_rectangle(pt, sz)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @return [void]
+    # @overload draw_rectangle(rect)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param rect [Wx::Rect] 
+    #   @return [void]
+    def draw_rectangle(*args) end
+    
+    # @overload draw_rotated_text(text, x, y, angle)
+    #   Draws the text rotated by angle degrees (positive angles are counterclockwise; the full angle is 360 degrees).
+    #   Notice that, as with {Wx::DC#draw_text}, the text can contain multiple lines separated by the new line (<code>'\n'</code>) characters.
+    #   Under MSW only TrueType fonts can be drawn by this function. In particular, a font different from {Wx::NORMAL_FONT} should be used as the latter is not a TrueType font. {Wx::SWISS_FONT} is an example of a font which is.
+    #   @see Wx::DC#draw_text 
+    #   @param text [String] 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param angle [Float] 
+    #   @return [void]
+    # @overload draw_rotated_text(text, point, angle)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param text [String] 
+    #   @param point [Array(Integer, Integer), Wx::Point] 
+    #   @param angle [Float] 
+    #   @return [void]
+    def draw_rotated_text(*args) end
+    
+    # @overload draw_rounded_rectangle(x, y, width, height, radius)
+    #   Draws a rectangle with the given top left corner, and with the given size.
+    #   The corners are quarter-circles using the given radius. The current pen is used for the outline and the current brush for filling the shape.
+    #   If radius is positive, the value is assumed to be the radius of the rounded corner. If radius is negative, the absolute value is assumed to be the proportion of the smallest dimension of the rectangle. This means that the corner can be a sensible size relative to the size of the rectangle, and also avoids the strange effects X produces when the corners are too big for the rectangle.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @param radius [Float] 
+    #   @return [void]
+    # @overload draw_rounded_rectangle(pt, sz, radius)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @param radius [Float] 
+    #   @return [void]
+    # @overload draw_rounded_rectangle(rect, radius)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param rect [Wx::Rect] 
+    #   @param radius [Float] 
+    #   @return [void]
+    def draw_rounded_rectangle(*args) end
+    
+    # @overload draw_spline(points)
+    #   Draws a spline between all given points using the current pen.
+    #   The number of points must be at least 2 for the spline to be drawn.
+    #   Drawn curve is not an interpolating curve - it does not go through all points. It may be considered a smoothing curve.
+    #   
+    #   <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
+    #   @param points [Array<Wx::Point>,Array<Array<Integer>>] 
+    #   @return [void]
+    # @overload draw_spline(x1, y1, x2, y2, x3, y3)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
+    #   @param x1 [Integer] 
+    #   @param y1 [Integer] 
+    #   @param x2 [Integer] 
+    #   @param y2 [Integer] 
+    #   @param x3 [Integer] 
+    #   @param y3 [Integer] 
+    #   @return [void]
+    def draw_spline(*args) end
+    
+    # @overload draw_text(text, x, y)
+    #   Draws a text string at the specified point, using the current text font, and the current text foreground and background colours.
+    #   The coordinates refer to the top-left corner of the rectangle bounding the string. See {Wx::DC#get_text_extent} for how to get the dimensions of a text string, which can be used to position the text more precisely and {Wx::DC#draw_label} if you need to align the string differently.
+    #   Starting from wxWidgets 2.9.2 text parameter can be a multi-line string, i.e. contain new line characters, and will be rendered correctly.
+    #   The current logical function is ignored by this function.
+    #   @param text [String] 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [void]
+    # @overload draw_text(text, pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param text [String] 
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def draw_text(*args) end
+    
+    # @overload gradient_fill_concentric(rect, initialColour, destColour)
+    #   Fill the area specified by rect with a radial gradient, starting from initialColour at the centre of the circle and fading to destColour on the circle outside.
+    #   The circle is placed at the centre of rect.
+    #   Currently this function is very slow, don't use it for real-time drawing.
+    #   @param rect [Wx::Rect] 
+    #   @param initialColour [Wx::Colour,String,Symbol] 
+    #   @param destColour [Wx::Colour,String,Symbol] 
+    #   @return [void]
+    # @overload gradient_fill_concentric(rect, initialColour, destColour, circleCenter)
+    #   Fill the area specified by rect with a radial gradient, starting from initialColour at the centre of the circle and fading to destColour on the circle outside.
+    #   circleCenter are the relative coordinates of centre of the circle in the specified rect.
+    #   Currently this function is very slow, don't use it for real-time drawing.
+    #   @param rect [Wx::Rect] 
+    #   @param initialColour [Wx::Colour,String,Symbol] 
+    #   @param destColour [Wx::Colour,String,Symbol] 
+    #   @param circleCenter [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def gradient_fill_concentric(*args) end
+    
+    # Fill the area specified by rect with a linear gradient, starting from initialColour and eventually fading to destColour.
+    # The nDirection specifies the direction of the colour change, default is to use initialColour on the left part of the rectangle and destColour on the right one.
+    # @param rect [Wx::Rect] 
+    # @param initialColour [Wx::Colour,String,Symbol] 
+    # @param destColour [Wx::Colour,String,Symbol] 
+    # @param nDirection [Direction] 
+    # @return [void]
+    def gradient_fill_linear(rect, initialColour, destColour, nDirection=Wx::RIGHT) end
+    
+    # @overload flood_fill(x, y, colour, style=Wx::FLOOD_SURFACE)
+    #   Flood fills the device context starting from the given point, using the current brush colour, and using a style:
+    #   - {Wx::FloodFillStyle::FLOOD_SURFACE}: The flooding occurs until a colour other than the given colour is encountered.- {Wx::FloodFillStyle::FLOOD_BORDER}: The area to be flooded is bounded by the given colour.
+    #   
+    #   Currently this method is not implemented in {Wx::OSX} and does nothing there.
+    #   false if the operation failed.
+    #   
+    #   The present implementation for non-Windows platforms may fail to find colour borders if the pixels do not match the colour exactly. However the function will still return true.
+    #   
+    #   This method shouldn't be used with {Wx::PaintDC} under non-Windows platforms as it uses {Wx::DC#get_pixel} internally and this may give wrong results, notably in {Wx::GTK}. If you need to flood fill {Wx::PaintDC}, create a temporary {Wx::MemoryDC}, flood fill it and then blit it to, or draw as a bitmap on, {Wx::PaintDC}. See the example of doing this in the drawing sample and {Wx::BufferedPaintDC} class.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @param style [FloodFillStyle] 
+    #   @return [true,false]
+    # @overload flood_fill(pt, col, style=Wx::FLOOD_SURFACE)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param col [Wx::Colour,String,Symbol] 
+    #   @param style [FloodFillStyle] 
+    #   @return [true,false]
+    def flood_fill(*args) end
+    
+    # @overload cross_hair(x, y)
+    #   Displays a cross hair using the current pen.
+    #   This is a vertical and horizontal line the height and width of the window, centred on the given point.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [void]
+    # @overload cross_hair(pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    def cross_hair(*args) end
+    
+    # Destroys the current clipping region so that none of the DC is clipped.
+    # 
+    # @see Wx::DC#set_clipping_region 
+    # @return [void]
+    def destroy_clipping_region; end
+    
+    # @overload get_clipping_box(x, y)
+    #   Gets the rectangle surrounding the current clipping region.
+    #   If no clipping region is set this function returns the extent of the device context.
+    #   Clipping region is given in logical coordinates.
+    #   
+    #   true if there is a clipping region or false if there is no active clipping region (note that this return value is available only since wxWidgets 3.1.2, this function didn't return anything in the previous versions).
+    #   @param x [Integer]  If non-NULL, filled in with the logical horizontal coordinate of the top left corner of the clipping region if the function returns true or 0 otherwise.
+    #   @param y [Integer]  If non-NULL, filled in with the logical vertical coordinate of the top left corner of the clipping region if the function returns true or 0 otherwise.
+    #   @return [Array(true,false,Integer,Integer)]
+    # @overload get_clipping_box(rect)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param rect [Wx::Rect] 
+    #   @return [true,false]
+    def get_clipping_box(*args) end
+    alias_method :clipping_box, :get_clipping_box
+    
+    # @overload set_clipping_region(x, y, width, height)
+    #   Sets the clipping region for this device context to the intersection of the given region described by the parameters of this method and the previously set clipping region.
+    #   The clipping region is an area to which drawing is restricted. Possible uses for the clipping region are for clipping text or for speeding up window redraws when only a known area of the screen is damaged.
+    #   
+    #   - Clipping region should be given in logical coordinates.- Calling this function can only make the clipping region smaller, never larger.- You need to call {Wx::DC#destroy_clipping_region} first if you want to set the clipping region exactly to the region specified.- If resulting clipping region is empty, then all drawing on the DC is clipped out (all changes made by drawing operations are masked out).
+    #   @see Wx::DC#destroy_clipping_region
+    #   @see  Wx::Region 
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @param width [Integer] 
+    #   @param height [Integer] 
+    #   @return [void]
+    # @overload set_clipping_region(pt, sz)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @return [void]
+    # @overload set_clipping_region(rect)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param rect [Wx::Rect] 
+    #   @return [void]
+    def set_clipping_region(*args) end
+    alias_method :clipping_region=, :set_clipping_region
+    
+    # Sets the clipping region for this device context.
+    # Unlike {Wx::DC#set_clipping_region}, this function works with physical coordinates and not with the logical ones.
+    # @param region [Wx::Region] 
+    # @return [void]
+    def set_device_clipping_region(region) end
+    alias_method :device_clipping_region=, :set_device_clipping_region
+    
+    # Gets the character height of the currently set font.
+    # @return [Integer]
+    def get_char_height; end
+    alias_method :char_height, :get_char_height
+    
+    # Gets the average character width of the currently set font.
+    # @return [Integer]
+    def get_char_width; end
+    alias_method :char_width, :get_char_width
+    
+    # Returns the various font characteristics.
+    # This method allows retrieving some of the font characteristics not returned by {Wx::DC#get_text_extent}, notably internal leading and average character width.
+    # Currently this method returns correct results only under {Wx::MSW}, in the other ports the internal leading will always be 0 and the average character width will be computed as the width of the character 'x'.
+    # @return [Wx::FontMetrics]
+    def get_font_metrics; end
+    alias_method :font_metrics, :get_font_metrics
+    
+    # Gets the dimensions of the string using the currently selected font.
+    # string is the text string to measure, heightLine, if non NULL, is where to store the height of a single line.
+    # The text extent is set in the given w and h pointers.
+    # If the optional parameter font is specified and valid, then it is used for the text extent calculation, otherwise the currently selected font is used.
+    # If string is empty, its horizontal extent is 0 but, for convenience when using this function for allocating enough space for a possibly multi-line string, its vertical extent is the same as the height of an empty line of text. Please note that this behaviour differs from that of {Wx::DC#get_text_extent}.
+    # This function works with both single-line and multi-line strings.
+    # 
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as GetMultiLineTextExtent(string, font = undef) returning a 3-element list (width, height, line_height)
+    # @see Wx::Font
+    # @see  Wx::DC#set_font
+    # @see  Wx::DC#get_partial_text_extents
+    # @see  Wx::DC#get_text_extent 
+    # @param string [String] 
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [Array(Integer,Integer,Integer)]
+    def get_multi_line_text_extent(string, font=nil) end
+    alias_method :multi_line_text_extent, :get_multi_line_text_extent
+    
+    # Gets the dimensions of the string using the currently selected font.
+    # string is the text string to measure.
+    # The text extent as a {Wx::Size} object.
+    # 
+    # This function works with both single-line and multi-line strings.
+    # 
+    # <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
+    # @see Wx::Font
+    # @see  Wx::DC#set_font
+    # @see  Wx::DC#get_partial_text_extents
+    # @see  Wx::DC#get_text_extent 
+    # @param string [String] 
+    # @return [Wx::Size]
+    def get_multi_line_text_size(string) end
+    alias_method :multi_line_text_size, :get_multi_line_text_size
+    
+    # Gets the dimensions of the string using the currently selected font.
+    # string is the text string to measure, descent is the dimension from the baseline of the font to the bottom of the descender, and externalLeading is any extra vertical space added to the font by the font designer (usually is zero).
+    # The text extent is returned in w and h pointers or as a {Wx::Size} object depending on which version of this function is used.
+    # If the optional parameter font is specified and valid, then it is used for the text extent calculation. Otherwise the currently selected font is.
+    # If string is empty, its extent is 0 in both directions, as expected.
+    # This function only works with single-line strings.
+    # 
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as GetTextExtent(string, font = undef) returning a 4-element list (width, height, descent, externalLeading)
+    # @see Wx::Font
+    # @see  Wx::DC#set_font
+    # @see  Wx::DC#get_partial_text_extents
+    # @see  Wx::DC#get_multi_line_text_extent 
+    # @param string [String] 
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [Array(Integer,Integer,Integer,Integer)]
+    def get_text_extent(string, font=nil) end
+    alias_method :text_extent, :get_text_extent
+    
+    # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    # <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
+    # @param string [String] 
+    # @return [Wx::Size]
+    def get_text_size(string) end
+    alias_method :text_size, :get_text_size
+    
+    # Returns the current background mode: {Wx::BrushStyle::BRUSHSTYLE_SOLID} or {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT}.
+    # 
+    # @see Wx::DC#set_background_mode 
+    # @return [Integer]
+    def get_background_mode; end
+    alias_method :background_mode, :get_background_mode
+    
+    # Gets the current font.
+    # Notice that even although each device context object has some default font after creation, this method would return a {Wx::NULL_FONT} initially and only after calling {Wx::DC#set_font} a valid font is returned.
+    # @return [Wx::Font,Wx::FontInfo]
+    def get_font; end
+    alias_method :font, :get_font
+    
+    # Gets the current layout direction of the device context.
+    # On platforms where RTL layout is supported, the return value will either be {Wx::LayoutDirection::Layout_LeftToRight} or {Wx::LayoutDirection::Layout_RightToLeft}. If RTL layout is not supported, the return value will be {Wx::LayoutDirection::Layout_Default}.
+    # @see Wx::DC#set_layout_direction 
+    # @return [LayoutDirection]
+    def get_layout_direction; end
+    alias_method :layout_direction, :get_layout_direction
+    
+    # Gets the current text background colour.
+    # 
+    # @see Wx::DC#set_text_background 
+    # @return [Wx::Colour,String,Symbol]
+    def get_text_background; end
+    alias_method :text_background, :get_text_background
+    
+    # Gets the current text foreground colour.
+    # 
+    # @see Wx::DC#set_text_foreground 
+    # @return [Wx::Colour,String,Symbol]
+    def get_text_foreground; end
+    alias_method :text_foreground, :get_text_foreground
+    
+    # Change the current background mode.
+    # This setting determines whether text will be drawn with a background colour or not.
+    # Default is {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT}, i.e. text background is not drawn.
+    # @param mode [Integer]  one of {Wx::BrushStyle::BRUSHSTYLE_SOLID} and {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT}.
+    # @return [void]
+    def set_background_mode(mode) end
+    alias_method :background_mode=, :set_background_mode
+    
+    # Sets the current font for the DC.
+    # The font parameter should be valid, although in {Wx::MSW} port (only) the argument {Wx::NULL_FONT} is also accepted and resets the device context font to the default value used by the system (which is not generally useful).
+    # @see Wx::Font 
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_font(font) end
+    alias_method :font=, :set_font
+    
+    # Sets the current text background colour for the DC.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_text_background(colour) end
+    alias_method :text_background=, :set_text_background
+    
+    # Sets the current text foreground colour for the DC.
+    # 
+    # @see Wx::MemoryDC for the interpretation of colours when drawing into a monochrome bitmap. 
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_text_foreground(colour) end
+    alias_method :text_foreground=, :set_text_foreground
+    
+    # Sets the current layout direction for the device context.
+    # 
+    # @see Wx::DC#get_layout_direction 
+    # @param dir [LayoutDirection]  May be either {Wx::LayoutDirection::Layout_Default}, {Wx::LayoutDirection::Layout_LeftToRight} or {Wx::LayoutDirection::Layout_RightToLeft}.
+    # @return [void]
+    def set_layout_direction(dir) end
+    alias_method :layout_direction=, :set_layout_direction
+    
+    # Adds the specified point to the bounding box which can be retrieved with {Wx::DC#min_x}, {Wx::DC#max_x} and {Wx::DC#min_y}, {Wx::DC#max_y} functions.
+    # 
+    # @see Wx::DC#reset_bounding_box 
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @return [void]
+    def calc_bounding_box(x, y) end
+    
+    # Gets the maximum horizontal extent used in drawing commands so far.
+    # @return [Integer]
+    def max_x; end
+    
+    # Gets the maximum vertical extent used in drawing commands so far.
+    # @return [Integer]
+    def max_y; end
+    
+    # Gets the minimum horizontal extent used in drawing commands so far.
+    # @return [Integer]
+    def min_x; end
+    
+    # Gets the minimum vertical extent used in drawing commands so far.
+    # @return [Integer]
+    def min_y; end
+    
+    # Resets the bounding box: after a call to this function, the bounding box doesn't contain anything.
+    # 
+    # @see Wx::DC#calc_bounding_box 
+    # @return [void]
+    def reset_bounding_box; end
+    
+    # Starts a document (only relevant when outputting to a printer).
+    # message is a message to show while printing.
+    # @param message [String] 
+    # @return [true,false]
+    def start_doc(message) end
+    
+    # Ends a document (only relevant when outputting to a printer).
+    # @return [void]
+    def end_doc; end
+    
+    # Ends a document page (only relevant when outputting to a printer).
+    # @return [void]
+    def end_page; end
+    
+    # Copy from a source DC to this DC.
+    # With this method you can specify the destination coordinates and the size of area to copy which will be the same for both the source and target DCs. If you need to apply scaling while copying, use {Wx::DC#stretch_blit}.
+    # Notice that source DC coordinates xsrc and ysrc are interpreted using the current source DC coordinate system, i.e. the scale, origin position and axis directions are taken into account when transforming them to physical (pixel) coordinates.
+    # 
+    # There is partial support for {Wx::DC#blit} in {Wx::PRT::PostScriptDC}, under X.
+    # @see Wx::DC#stretch_blit
+    # @see  Wx::MemoryDC
+    # @see  Wx::Bitmap
+    # @see  Wx::Mask 
+    # @param xdest [Integer]  Destination device context x position.
+    # @param ydest [Integer]  Destination device context y position.
+    # @param width [Integer]  Width of source area to be copied.
+    # @param height [Integer]  Height of source area to be copied.
+    # @param source [Wx::DC]  Source device context.
+    # @param xsrc [Integer]  Source device context x position.
+    # @param ysrc [Integer]  Source device context y position.
+    # @param logicalFunc [RasterOperationMode]  Logical function to use, see {Wx::DC#set_logical_function}.
+    # @param useMask [true,false]  If true, Blit does a transparent blit using the mask that is associated with the bitmap selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used: 
+    #   - 
+    #   Creates a temporary bitmap and copies the destination area into it. 
+    #   - 
+    #   Copies the source area into the temporary bitmap using the specified logical function. 
+    #   - 
+    #   Sets the masked area in the temporary bitmap to BLACK by ANDing the mask bitmap with the temp bitmap with the foreground colour set to WHITE and the bg colour set to BLACK. 
+    #   - 
+    #   Sets the unmasked area in the destination area to BLACK by ANDing the mask bitmap with the destination area with the foreground colour set to BLACK and the background colour set to WHITE. 
+    #   - 
+    #   ORs the temporary bitmap with the destination area. 
+    #   - 
+    #   Deletes the temporary bitmap. 
+    #   
+    #   This sequence of operations ensures that the source's transparent area need not be black, and logical functions are supported. 
+    #   
+    #    <b>Note:</b> on Windows, blitting with masks can be speeded up considerably by compiling wxWidgets with the {Wx::Setup::USE_DC_CACHEING} option enabled. You can also influence whether MaskBlt or the explicit mask blitting code above is used, by using {Wx::SystemOptions} and setting the <code>no-maskblt</code> option to 1.
+    # @param xsrcMask [Integer]  Source x position on the mask. If both xsrcMask and ysrcMask are <code>-1</code>, xsrc and ysrc will be assumed for the mask source position. Currently only implemented on Windows.
+    # @param ysrcMask [Integer]  Source y position on the mask. If both xsrcMask and ysrcMask are <code>-1</code>, xsrc and ysrc will be assumed for the mask source position. Currently only implemented on Windows.
+    # @return [true,false]
+    def blit(xdest, ydest, width, height, source, xsrc, ysrc, logicalFunc=Wx::COPY, useMask=false, xsrcMask=Wx::DEFAULT_COORD, ysrcMask=Wx::DEFAULT_COORD) end
+    
+    # Copy from a source DC to this DC possibly changing the scale.
+    # Unlike {Wx::DC#blit}, this method allows specifying different source and destination region sizes, meaning that it can stretch or shrink it while copying. The same can be achieved by changing the scale of the source or target DC but calling this method is simpler and can also be more efficient if the platform provides a native implementation of it.
+    # The meaning of its other parameters is the same as with {Wx::DC#blit}, in particular all source coordinates are interpreted using the source DC coordinate system, i.e. are affected by its scale, origin translation and axis direction.
+    # 
+    # There is partial support for {Wx::DC#blit} in {Wx::PRT::PostScriptDC}, under X.
+    # See {Wx::MemoryDC} for typical usage.
+    # @see Wx::DC#blit
+    # @see  Wx::MemoryDC
+    # @see  Wx::Bitmap
+    # @see  Wx::Mask 
+    # @param xdest [Integer]  Destination device context x position.
+    # @param ydest [Integer]  Destination device context y position.
+    # @param dstWidth [Integer]  Width of destination area.
+    # @param dstHeight [Integer]  Height of destination area.
+    # @param source [Wx::DC]  Source device context.
+    # @param xsrc [Integer]  Source device context x position.
+    # @param ysrc [Integer]  Source device context y position.
+    # @param srcWidth [Integer]  Width of source area to be copied.
+    # @param srcHeight [Integer]  Height of source area to be copied.
+    # @param logicalFunc [RasterOperationMode]  Logical function to use, see {Wx::DC#set_logical_function}.
+    # @param useMask [true,false]  If true, Blit does a transparent blit using the mask that is associated with the bitmap selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used: 
+    #   - 
+    #   Creates a temporary bitmap and copies the destination area into it. 
+    #   - 
+    #   Copies the source area into the temporary bitmap using the specified logical function. 
+    #   - 
+    #   Sets the masked area in the temporary bitmap to BLACK by ANDing the mask bitmap with the temp bitmap with the foreground colour set to WHITE and the bg colour set to BLACK. 
+    #   - 
+    #   Sets the unmasked area in the destination area to BLACK by ANDing the mask bitmap with the destination area with the foreground colour set to BLACK and the background colour set to WHITE. 
+    #   - 
+    #   ORs the temporary bitmap with the destination area. 
+    #   - 
+    #   Deletes the temporary bitmap. 
+    #   
+    #   This sequence of operations ensures that the source's transparent area need not be black, and logical functions are supported. 
+    #   
+    #    <b>Note:</b> on Windows, blitting with masks can be speeded up considerably by compiling wxWidgets with the {Wx::Setup::USE_DC_CACHEING} option enabled. You can also influence whether MaskBlt or the explicit mask blitting code above is used, by using {Wx::SystemOptions} and setting the <code>no-maskblt</code> option to 1.
+    # @param xsrcMask [Integer]  Source x position on the mask. If both xsrcMask and ysrcMask are {Wx::DEFAULT_COORD}, xsrc and ysrc will be assumed for the mask source position. Currently only implemented on Windows.
+    # @param ysrcMask [Integer]  Source y position on the mask. If both xsrcMask and ysrcMask are {Wx::DEFAULT_COORD}, xsrc and ysrc will be assumed for the mask source position. Currently only implemented on Windows.
+    # @return [true,false]
+    def stretch_blit(xdest, ydest, dstWidth, dstHeight, source, xsrc, ysrc, srcWidth, srcHeight, logicalFunc=Wx::COPY, useMask=false, xsrcMask=Wx::DEFAULT_COORD, ysrcMask=Wx::DEFAULT_COORD) end
+    
+    # Gets the brush used for painting the background.
+    # 
+    # @see Wx::DC#set_background 
+    # @return [void]
+    def get_background; end
+    alias_method :background, :get_background
+    
+    # Gets the current brush.
+    # 
+    # @see Wx::DC#set_brush 
+    # @return [void]
+    def get_brush; end
+    alias_method :brush, :get_brush
+    
+    # Gets the current pen.
+    # 
+    # @see Wx::DC#set_pen 
+    # @return [void]
+    def get_pen; end
+    alias_method :pen, :get_pen
+    
+    # Sets the current background brush for the DC.
+    # @param brush [Wx::Brush] 
+    # @return [void]
+    def set_background(brush) end
+    alias_method :background=, :set_background
+    
+    # Sets the current brush for the DC.
+    # If the argument is {Wx::NULL_BRUSH} (or another invalid brush; see {Wx::Brush#is_ok}), the current brush is selected out of the device context (leaving {Wx::DC} without any valid brush), allowing the current brush to be destroyed safely.
+    # @see Wx::Brush
+    # @see  Wx::MemoryDC (for the interpretation of colours when drawing into a monochrome bitmap) 
+    # @param brush [Wx::Brush] 
+    # @return [void]
+    def set_brush(brush) end
+    alias_method :brush=, :set_brush
+    
+    # Sets the current pen for the DC.
+    # If the argument is {Wx::NULL_PEN} (or another invalid pen; see {Wx::Pen#is_ok}), the current pen is selected out of the device context (leaving {Wx::DC} without any valid pen), allowing the current pen to be destroyed safely.
+    # @see Wx::MemoryDC for the interpretation of colours when drawing into a monochrome bitmap. 
+    # @param pen [Wx::Pen] 
+    # @return [void]
+    def set_pen(pen) end
+    alias_method :pen=, :set_pen
+    
+    # Check if the use of transformation matrix is supported by the current system.
+    # This function returns true for MSW and GTK+ 3 platforms and since 3.1.1 also for {Wx::GCDC} in all ports.
+    # @return [true,false]
+    def can_use_transform_matrix; end
+    alias_method :can_use_transform_matrix?, :can_use_transform_matrix
+    
+    # Set the transformation matrix.
+    # If transformation matrix is supported on the current system, the specified matrix will be used to transform between {Wx::DC} and physical coordinates. Otherwise the function returns false and doesn't change the coordinate mapping.
+    # @param matrix [Wx::AffineMatrix2D] 
+    # @return [true,false]
+    def set_transform_matrix(matrix) end
+    alias_method :transform_matrix=, :set_transform_matrix
+    
+    # Return the transformation matrix used by this device context.
+    # By default the transformation matrix is the identity matrix.
+    # @return [Wx::AffineMatrix2D]
+    def get_transform_matrix; end
+    alias_method :transform_matrix, :get_transform_matrix
+    
+    # Revert the transformation matrix to identity matrix.
+    # @return [void]
+    def reset_transform_matrix; end
+    
+    # Does the DC support drawing bitmaps?
+    # @return [true,false]
+    def can_draw_bitmap; end
+    alias_method :can_draw_bitmap?, :can_draw_bitmap
+    
+    # Does the DC support calculating the size required to draw text?
+    # @return [true,false]
+    def can_get_text_extent; end
+    alias_method :can_get_text_extent?, :can_get_text_extent
+    
+    # Return the coordinates of the logical point (0, 0).
+    # 
+    # @see Wx::DC#set_logical_origin 
+    # @return [Wx::Point]
+    def get_logical_origin; end
+    alias_method :logical_origin, :get_logical_origin
+    
+    # Copy attributes from another DC.
+    # The copied attributes currently are:
+    # - Font- Text foreground and background colours- Background brush- Layout direction
+    # 
+    # Note that the scaling factor is not considered to be an attribute of {Wx::DC} and is not copied by this function.
+    # @param dc [Wx::DC]  A valid (i.e. its {Wx::DC#is_ok} must return true) source device context.
+    # @return [void]
+    def copy_attributes(dc) end
+    
+    # Returns the factor used for converting logical pixels to physical ones.
+    # Returns the same value as {Wx::Window#get_content_scale_factor} for the device contexts associated with a window and the same value as {Wx::Bitmap#get_scale_factor} for the associated bitmap for {Wx::MemoryDC}.
+    # @return [Float]
+    def get_content_scale_factor; end
+    alias_method :content_scale_factor, :get_content_scale_factor
+    
+    # Returns the depth (number of bits/pixel) of this DC.
+    # 
+    # @see display_depth 
+    # @return [Integer]
+    def get_depth; end
+    alias_method :depth, :get_depth
+    
+    # Returns the current device origin.
+    # 
+    # @see Wx::DC#set_device_origin 
+    # @return [Wx::Point]
+    def get_device_origin; end
+    alias_method :device_origin, :get_device_origin
+    
+    # Gets the current logical function.
+    # 
+    # @see Wx::DC#set_logical_function 
+    # @return [RasterOperationMode]
+    def get_logical_function; end
+    alias_method :logical_function, :get_logical_function
+    
+    # Gets the current mapping mode for the device context.
+    # 
+    # @see Wx::DC#set_map_mode 
+    # @return [MappingMode]
+    def get_map_mode; end
+    alias_method :map_mode, :get_map_mode
+    
+    # Gets in colour the colour at the specified location.
+    # This method isn't available for {Wx::PRT::PostScriptDC} or {Wx::MetafileDC} nor for any DC in {Wx::OSX} port and simply returns false there.
+    # Setting a pixel can be done using {Wx::DC#draw_point}.
+    # 
+    # This method shouldn't be used with {Wx::PaintDC} as accessing the DC while drawing can result in unexpected results, notably in {Wx::GTK}.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @param colour [Wx::Colour] 
+    # @return [true,false]
+    def get_pixel(x, y, colour) end
+    alias_method :pixel, :get_pixel
+    
+    # Returns the resolution of the device in pixels per inch.
+    # @return [Wx::Size]
+    def get_ppi; end
+    alias_method :ppi, :get_ppi
+    
+    # @overload from_dip(sz)
+    #   Convert DPI-independent pixel values to the value in pixels appropriate for the DC.
+    #   See {Wx::Window#from_dip(sz)} for more info about converting device independent pixel values.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @return [Wx::Size]
+    # @overload from_dip(pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [Wx::Point]
+    # @overload from_dip(d)
+    #   Convert DPI-independent value in pixels to the value in pixels appropriate for the DC.
+    #   This is the same as FromDIP(const {Wx::Size}& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
+    #   @param d [Integer] 
+    #   @return [Integer]
+    def from_dip(*args) end
+    
+    # @overload to_dip(sz)
+    #   Convert pixel values of the current DC to DPI-independent pixel values.
+    #   See {Wx::Window#to_dip(sz)} for more info about converting device independent pixel values.
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @return [Wx::Size]
+    # @overload to_dip(pt)
+    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [Wx::Point]
+    # @overload to_dip(d)
+    #   Convert pixel values of the current DC to DPI-independent pixel values.
+    #   This is the same as ToDIP(const {Wx::Size}& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
+    #   @param d [Integer] 
+    #   @return [Integer]
+    def to_dip(*args) end
+    
+    # Gets the horizontal and vertical extent of this device context in device units.
+    # It can be used to scale graphics to fit the page.
+    # For example, if maxX and maxY represent the maximum horizontal and vertical 'pixel' values used in your application, the following code will scale the graphic to fit on the printer page:
+    # 
+    #   wxCoord w, h;
+    #   dc.GetSize(&w, &h);
+    #   double scaleX = (double)(maxX / w);
+    #   double scaleY = (double)(maxY / h);
+    #   dc.SetUserScale(min(scaleX, scaleY),min(scaleX, scaleY));
+    # 
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} there are two methods instead of a single overloaded method:
+    # - {Wx::DC#get_size}: returns a Wx::Size object.- GetSizeWH(): returns a 2-element list (width, height).
+    # @return [Array(Integer,Integer)]
+    def get_dimensions; end
+    alias_method :dimensions, :get_dimensions
+    
+    # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    # @return [Wx::Size]
+    def get_size; end
+    alias_method :size, :get_size
+    
+    # Returns the horizontal and vertical resolution in millimetres.
+    # @return [Array(Integer,Integer)]
+    def get_dimensions_mm; end
+    alias_method :dimensions_mm, :get_dimensions_mm
+    
+    # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    # @return [Wx::Size]
+    def get_size_mm; end
+    alias_method :size_mm, :get_size_mm
+    
+    # Gets the current user scale factor.
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no arguments and return a two element array (x, y).
+    # @see Wx::DC#set_user_scale 
+    # @param x [double] 
+    # @param y [double] 
+    # @return [void]
+    def get_user_scale(x, y) end
+    alias_method :user_scale, :get_user_scale
+    
+    # Returns true if the DC is ok to use.
+    # @return [true,false]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Sets the x and y axis orientation (i.e. the direction from lowest to highest values on the axis).
+    # The default orientation is x axis from left to right and y axis from top down.
+    # @param xLeftRight [true,false]  True to set the x axis orientation to the natural left to right orientation, false to invert it.
+    # @param yBottomUp [true,false]  True to set the y axis orientation to the natural bottom up orientation, false to invert it.
+    # @return [void]
+    def set_axis_orientation(xLeftRight, yBottomUp) end
+    
+    # Sets the device origin (i.e. the origin in pixels after scaling has been applied).
+    # This function may be useful in Windows printing operations for placing a graphic on a page.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @return [void]
+    def set_device_origin(x, y) end
+    
+    # Sets the current logical function for the device context.
+    # This function is not fully supported in all ports, due to the limitations of the underlying drawing model. Notably, {Wx::RasterOperationMode::INVERT} which was commonly used for drawing rubber bands or other moving outlines in the past, is not, and will not, be supported by {Wx::GTK3} and {Wx::Mac}. The suggested alternative is to draw temporarily objects normally and refresh the (affected part of the) window to remove them later.
+    # 
+    # It determines how a source pixel (from a pen or brush colour, or source device context if using {Wx::DC#blit}) combines with a destination pixel in the current device context. Text drawing is not affected by this function.
+    # See {Wx::RasterOperationMode} enumeration values for more info.
+    # The default is {Wx::RasterOperationMode::COPY}, which simply draws with the current colour. The others combine the current colour and the background using a logical operation.
+    # @param function [RasterOperationMode] 
+    # @return [void]
+    def set_logical_function(function) end
+    alias_method :logical_function=, :set_logical_function
+    
+    # The mapping mode of the device context defines the unit of measurement used to convert logical units to device units.
+    # Note that in X, text drawing isn't handled consistently with the mapping mode; a font is always specified in point size. However, setting the user scale (see {Wx::DC#set_user_scale}) scales the text appropriately. In Windows, scalable TrueType fonts are always used; in X, results depend on availability of fonts, but usually a reasonable match is found.
+    # The coordinate origin is always at the top left of the screen/printer.
+    # Drawing to a Windows printer device context uses the current mapping mode, but mapping mode is currently ignored for PostScript output.
+    # @param mode [MappingMode] 
+    # @return [void]
+    def set_map_mode(mode) end
+    alias_method :map_mode=, :set_map_mode
+    
+    # If this is a window DC or memory DC, assigns the given palette to the window or bitmap associated with the DC.
+    # If the argument is {Wx::NULL_PALETTE}, the current palette is selected out of the device context, and the original palette restored.
+    # @see Wx::Palette 
+    # @param palette [Wx::Palette] 
+    # @return [void]
+    def set_palette(palette) end
+    alias_method :palette=, :set_palette
+    
+    # Sets the user scaling factor, useful for applications which require 'zooming'.
+    # @param xScale [Float] 
+    # @param yScale [Float] 
+    # @return [void]
+    def set_user_scale(xScale, yScale) end
+    
+    # If supported by the platform and the type of DC, fetch the contents of the DC, or a subset of it, as a bitmap.
+    # @param subrect [Wx::Rect] 
+    # @return [Wx::Bitmap]
+    def get_as_bitmap(subrect=nil) end
+    alias_method :as_bitmap, :get_as_bitmap
+    
+    # Set the scale to use for translating {Wx::DC} coordinates to the physical pixels.
+    # The effect of calling this function is similar to that of calling {Wx::DC#set_user_scale}.
+    # @param x [Float] 
+    # @param y [Float] 
+    # @return [void]
+    def set_logical_scale(x, y) end
+    
+    # Return the scale set by the last call to {Wx::DC#set_logical_scale}.
+    # @param x [double] 
+    # @param y [double] 
+    # @return [void]
+    def get_logical_scale(x, y) end
+    alias_method :logical_scale, :get_logical_scale
+    
+    # Change the offset used for translating {Wx::DC} coordinates.
+    # 
+    # @see Wx::DC#set_logical_origin
+    # @see  Wx::DC#set_device_origin 
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @return [void]
+    def set_logical_origin(x, y) end
+    
+    # If supported by the platform and the {Wx::DC} implementation, this method will return the {Wx::GraphicsContext} associated with the DC.
+    # Otherwise NULL is returned.
+    # @return [Wx::GraphicsContext]
+    def get_graphics_context; end
+    alias_method :graphics_context, :get_graphics_context
+    
+    # Associate a {Wx::GraphicsContext} with the DC.
+    # Ignored if not supported by the specific {Wx::DC} implementation. It is unlikely that this will need to be used in application code.
+    # @param ctx [Wx::GraphicsContext] 
+    # @return [void]
+    def set_graphics_context(ctx) end
+    alias_method :graphics_context=, :set_graphics_context
+    
+  end # DC
+  
+
+end