cairo-Patterns {RGtk2}R Documentation

Patterns

Description

Gradients and filtered sources

Methods and Functions

cairoPatternAddColorStopRgb(pattern, offset, red, green, blue)
cairoPatternAddColorStopRgba(pattern, offset, red, green, blue, alpha)
cairoPatternGetColorStopCount(pattern)
cairoPatternGetColorStopRgba(pattern, index)
cairoPatternCreateRgb(red, green, blue)
cairoPatternCreateRgba(red, green, blue, alpha)
cairoPatternGetRgba(pattern)
cairoPatternCreateForSurface(surface)
cairoPatternGetSurface(pattern)
cairoPatternCreateLinear(x0, y0, x1, y1)
cairoPatternGetLinearPoints(pattern)
cairoPatternCreateRadial(cx0, cy0, radius0, cx1, cy1, radius1)
cairoPatternGetRadialCircles(pattern)
cairoPatternStatus(pattern)
cairoPatternSetExtend(pattern, extend)
cairoPatternGetExtend(pattern)
cairoPatternSetFilter(pattern, filter)
cairoPatternGetFilter(pattern)
cairoPatternSetMatrix(pattern, matrix)
cairoPatternGetMatrix(pattern, matrix)
cairoPatternGetType(pattern)
cairoPatternSetUserData(pattern, key, user.data)
cairoPatternGetUserData(pattern, key)
cairoPattern(red, green, blue, alpha, surface, x0, y0, x1, y1, cx0, cy0, radius0, cx1, cy1, radius1)

Structures

CairoPattern
A CairoPattern represents a source when drawing onto a surface. There are different subtypes of CairoPattern, for different types of sources; for example, cairoPatternCreateRgb creates a pattern for a solid opaque color.

Other than various cairo_pattern_create_type functions, some of the pattern types can be implicitly created using vairous cairo_set_source_type functions; for example cairoSetSourceRgb.

The type of a pattern can be queried with cairoPatternGetType.

Memory management of CairoPattern is done with cairoPatternReference() and cairoPatternDestroy().

Convenient Construction

cairoPattern is the result of collapsing the constructors of cairo_pattern_t (cairoPatternCreateRgb, cairoPatternCreateRgba, cairoPatternCreateForSurface, cairoPatternCreateLinear, cairoPatternCreateRadial) and accepts a subset of its arguments matching the required arguments of one of its delegate constructors.

Enums and Flags

CairoExtend
CairoExtend is used to describe how the area outside of a pattern will be drawn.

New entries may be added in future versions.

none
pixels outside of the source pattern are fully transparent
repeat
the pattern is tiled by repeating
reflect
the pattern is tiled by reflecting at the edges (not implemented for surface patterns currently)

CairoFilter
undocumented

fast
undocumented
good
undocumented
best
undocumented
nearest
undocumented
bilinear
undocumented
gaussian
undocumented

CairoPatternType
CairoPatternType is used to describe the type of a given pattern.

The type of a pattern is determined by the function used to create it. The cairoPatternCreateRgb and cairoPatternCreateRgba functions create SOLID patterns. The remaining cairo_pattern_create functions map to pattern types in obvious ways.

The pattern type can be queried with cairoPatternGetType

Most cairo_pattern functions can be called with a pattern of any type, (though trying to change the extend or filter for a solid pattern will have no effect). A notable exception is cairoPatternAddColorStopRgb and cairoPatternAddColorStopRgba which must only be called with gradient patterns (either LINEAR or RADIAL). Otherwise the pattern will be shutdown and put into an error state.

New entries may be added in future versions.

Since 1.2

solid
The pattern is a solid (uniform) color. It may be opaque or translucent.
surface
The pattern is a based on a surface (an image).
linear
The pattern is a linear gradient.
radial
The pattern is a radial gradient.

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://www.cairographics.org/manual/cairo-Patterns.html


[Package RGtk2 version 2.12.5-3 Index]