Skip to content
  • Jasper St. Pierre's avatar
    gdkwindow: Remove the internal cairo_surface used for out-of-band painting · d48adf9c
    Jasper St. Pierre authored
    Traditionally, the way painting was done in GTK+ was with the
    "expose-event" handler, where you'd use GDK methods to do drawing on
    your surface. In GTK+ 2.24, we added cairo support with gdk_cairo_create,
    so you could paint your graphics with cairo.
    
    Since then, we've added client-side windows, double buffering, the paint
    clock, and various other enhancements, and the modern way to do drawing
    is to connect to the "draw" signal on GtkWidget, which hands you a
    cairo_t. To do double-buffering, the cairo_t we hand you is actually on
    a secret surface, not the actual backing store of the window, and when
    the draw handler completes we blit it into the main backing store
    atomically.
    
    The code to do this is with the APIs gdk_window_begin_paint_region,
    which creates the temporary surface, and gdk_window_end_paint which
    blits it back into the backing store. GTK+'s implementation of the
    "draw" signal uses these APIs.
    
    We've always sort-of supported people calling gdk_cairo_create
    "outside" of a begin_paint / end_paint like old times, but then you're
    not getting the benefit of double-buffering, and it's harder for GDK to
    optimize.
    
    Additionally, newer backends like Mir and Wayland can't actually support
    this model, since they're based on double-buffering and swapping buffers
    at various points in time. If we hand you a random cairo_t, we have no
    idea when is a good time to swap.
    
    Remove support for this.
    
    This is technically a GDK API break: a warning is added in cases where
    gdk_cairo_create is called outside of a paint cycle, and the returned
    surface is a dummy that won't ever be composited back onto the main
    surface. Testing with complex applications like Ardour didn't produce
    any warnings.
    d48adf9c