Class: Wx::BufferedPaintDC

Inherits:
BufferedDC show all
Defined in:
lib/wx/doc/gen/memory_dc.rb,
lib/wx/doc/memory_dc.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

This is a subclass of BufferedDC which can be used inside of an EVT_PAINT() event handler to achieve double-buffered drawing.

Just use this class instead of PaintDC and make sure Window#set_background_style is called with Wx::BackgroundStyle::BG_STYLE_PAINT somewhere in the class initialization code, and that’s all you have to do to (mostly) avoid flicker. The only thing to watch out for is that if you are using this class together with Scrolled, you probably do not want to call Wx::Scrolled#prepare_dc on it as it already does this internally for the real underlying PaintDC.

Category: Device Contexts

See Also:

Class Method Summary collapse

Methods inherited from BufferedDC

#get_style, #init, #set_style, #un_mask

Methods inherited from MemoryDC

#get_selected_bitmap, #select_object, #select_object_as_source

Methods inherited from DC

#blit, #calc_bounding_box, #can_draw_bitmap, #can_get_text_extent, #can_use_transform_matrix, #clear, #copy_attributes, #cross_hair, #destroy_clipping_region, #device_to_logical, #device_to_logical_rel, #device_to_logical_x, #device_to_logical_x_rel, #device_to_logical_y, #device_to_logical_y_rel, #draw_arc, #draw_bitmap, #draw_check_mark, #draw_circle, #draw_ellipse, #draw_elliptic_arc, #draw_icon, #draw_label, #draw_line, #draw_lines, #draw_point, #draw_poly_polygon, #draw_polygon, #draw_rectangle, #draw_rotated_text, #draw_rounded_rectangle, #draw_spline, #draw_text, #end_doc, #end_page, #flood_fill, #from_dip, #get_as_bitmap, #get_background, #get_background_mode, #get_brush, #get_char_height, #get_char_width, #get_clipping_box, #get_content_scale_factor, #get_depth, #get_device_origin, #get_dimensions, #get_dimensions_mm, #get_font, #get_font_metrics, #get_graphics_context, #get_layout_direction, #get_logical_function, #get_logical_origin, #get_logical_scale, #get_map_mode, #get_multi_line_text_extent, #get_multi_line_text_size, #get_pen, #get_pixel, #get_ppi, #get_size, #get_size_mm, #get_text_background, #get_text_extent, #get_text_foreground, #get_text_size, #get_transform_matrix, #get_user_scale, #gradient_fill_concentric, #gradient_fill_linear, #is_ok, #logical_to_device, #logical_to_device_rel, #logical_to_device_x, #logical_to_device_x_rel, #logical_to_device_y, #logical_to_device_y_rel, #max_x, #max_y, #min_x, #min_y, #reset_bounding_box, #reset_transform_matrix, #set_axis_orientation, #set_background, #set_background_mode, #set_brush, #set_clipping_region, #set_device_clipping_region, #set_device_origin, #set_font, #set_graphics_context, #set_layout_direction, #set_logical_function, #set_logical_origin, #set_logical_scale, #set_map_mode, #set_palette, #set_pen, #set_text_background, #set_text_foreground, #set_transform_matrix, #set_user_scale, #start_doc, #start_page, #stretch_blit, #to_dip, #with_background_mode, #with_brush, #with_font, #with_pen, #with_text_background, #with_text_foreground

Methods inherited from Object

#clone, #dup, #initialize, #is_same_as, #un_share

Constructor Details

This class inherits a constructor from Wx::Object

Class Method Details

.self.draw_on(win, style = Wx::BUFFER_CLIENT_AREA) {|dc| ... } ⇒ Object .self.draw_on(win, buffer = Wx::NULL_BITMAP, style = Wx::BUFFER_CLIENT_AREA) {|dc| ... } ⇒ Object

Creates a Buffered DC and passes that to the given block to draw on. Destroys the DC after the block returns. As with Wx::BufferedDC, you may either provide the bitmap to be used for buffering or let this object create one internally (in the latter case, the size of the client part of the window is used).

Pass W::xBUFFER_CLIENT_AREA for the style parameter to indicate that just the client area of the window is buffered, or Wx::BUFFER_VIRTUAL_AREA to indicate that the buffer bitmap covers the virtual area.

Overloads:

  • .self.draw_on(win, style = Wx::BUFFER_CLIENT_AREA) {|dc| ... } ⇒ Object

    Parameters:

    • win (Wx::Window) —

      The underlying window; everything drawn to this object will be flushed to this window when this object is destroyed.

    • style (Integer) (defaults to: Wx::BUFFER_CLIENT_AREA) —

      Wx::BUFFER_CLIENT_AREA to indicate that just the client area of the window is buffered, or Wx::BUFFER_VIRTUAL_AREA to indicate that the buffer bitmap covers the virtual area.

    Yield Parameters:

  • .self.draw_on(win, buffer = Wx::NULL_BITMAP, style = Wx::BUFFER_CLIENT_AREA) {|dc| ... } ⇒ Object

    Parameters:

    • win (Wx::Window) —

      The underlying window; everything drawn to this object will be flushed to this window when this object is destroyed.

    • buffer (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

      Explicitly provided bitmap to be used for buffering: this is the most efficient solution as the bitmap doesn’t have to be recreated each time but it also requires more memory as the bitmap is never freed. The bitmap should have appropriate size, anything drawn outside of its bounds is clipped.

    • style (Integer) (defaults to: Wx::BUFFER_CLIENT_AREA) —

      Wx::BUFFER_CLIENT_AREA to indicate that just the client area of the window is buffered, or Wx::BUFFER_VIRTUAL_AREA to indicate that the buffer bitmap covers the virtual area.

    Yield Parameters:



65
 
# File 'lib/wx/doc/memory_dc.rb', line 65

def self.draw_on(*arg) end