Method GTK2.Widget()->get_snapshot()

Method get_snapshot

GTK2.GdkPixmap get_snapshot(GTK2.GdkRectangle clip_rect)

Description

Create a GDK2.Pixmap of the contents of the widget and its children

Works even if the widget is obscured. The depth and visual of the resulting pixmap is dependent on the widget being snapshot and likely differs from those of a target widget displaying the pixmap. The function GDK2.Pixbuf->get_from_drawable() can be used to convert the pixmap to a visual independent representation.

The snapshot are used by this function is the widget's allocation plus any extra space occupied by additional windows belonging to this widget (such as the arrows of a spin button). Thus, the resulting snapshot pixmap is possibly larger than the allocation.

If clip_rect is non-null, the resulting pixmap is shrunken to match the specified clip_rect. The (x,y) coordinates of clip_rect are interpreted widget relative. If width or height of clip_rect are 0 or negative, the width or height of the resulting pixmap will be shurnken by the respective amount. For instance, a clip_rect (+5,+5,-10,-10) will chop off 5 pixels at each side of the snapshot pixmap. If non-null, clip_rect will contain the exact widget-relative snapshot coordinates upon return. A clip_rect of (-1,-1,0,0) can be used to preserve the auto-grown snapshot area and use clip_rect as a pure output parameter.

The return pixmap can be 0, if the resulting clip_area was empty.