cairoPushGroup: cairoPushGroup

In RGtk2: R Bindings for Gtk 2.8.0 and Above

Description

Temporarily redirects drawing to an intermediate surface known as a group. The redirection lasts until the group is completed by a call to cairoPopGroup or cairoPopGroupToSource. These calls provide the result of any drawing to the group as a pattern, (either as an explicit object, or set as the source pattern).

Usage

cairoPushGroup(cr)

Arguments

cr	[Cairo] a cairo context

Details

This group functionality can be convenient for performing intermediate compositing. One common use of a group is to render objects as opaque within the group, (so that they occlude each other), and then blend the result with translucence onto the destination.

Groups can be nested arbitrarily deep by making balanced calls to cairoPushGroup/cairoPopGroup. Each call pushes/pops the new target group onto/from a stack.

The cairoPushGroup function calls cairoSave so that any changes to the graphics state will not be visible outside the group, (the pop_group functions call cairoRestore).

By default the intermediate group will have a content type of CAIRO_CONTENT_COLOR_ALPHA. Other content types can be chosen for the group by using cairoPushGroupWithContent instead.

As an example, here is how one might fill and stroke a path with translucence, but without any portion of the fill being visible under the stroke:

cr$pushGroup()
cr$setSource(fill_pattern)
cr$fillPreserve()
cr$setSource(stroke_pattern)
cr$stroke()
cr$popGroupToSource()
cr$paintWithAlpha(alpha)

Since 1.2

Author(s)

Derived by RGtkGen from GTK+ documentation

RGtk2 documentation built on Oct. 14, 2021, 5:08 p.m.