cairo-Patterns             package:RGtk2             R Documentation

_c_a_i_r_o__p_a_t_t_e_r_n__t

_D_e_s_c_r_i_p_t_i_o_n:

     Sources for drawing

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     '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)'

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     'CairoPattern' is the paint with which cairo draws. The primary
     use of patterns is as the source for all cairo drawing operations,
     although they can also be used as masks, that is, as the brush
     too.

     A cairo pattern is created by using one of the many constructors,
     of the form cairo_pattern_create__type_() or implicitly through
     cairo_set_source__type_() functions.

_S_t_r_u_c_t_u_r_e_s:


     '_C_a_i_r_o_P_a_t_t_e_r_n' 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
          various 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()'.  


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     '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.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_C_a_i_r_o_E_x_t_e_n_d' 'CairoExtend' is used to describe how the area
          outside of a pattern will be drawn.

          New entries may be added in future versions.  

          '_n_o_n_e' pixels outside of the source pattern are fully
               transparent

          '_r_e_p_e_a_t' the pattern is tiled by repeating

          '_r_e_f_l_e_c_t' the pattern is tiled by reflecting at the edges
               (not implemented for surface patterns currently)


     '_C_a_i_r_o_F_i_l_t_e_r' 'CairoFilter' is used to indicate what filtering
          should be applied when reading pixel values from patterns.
          See 'cairoPatternSetSource()' for indicating the desired
          filter to be used with a particular pattern.  

          '_f_a_s_t' A high-performance filter, with quality similar to
               'CAIRO_FILTER_NEAREST'

          '_g_o_o_d' A reasonable-performance filter, with quality similar
               to 'CAIRO_FILTER_BILINEAR'

          '_b_e_s_t' The highest-quality available, performance may not be
               suitable for interactive use.

          '_n_e_a_r_e_s_t' Nearest-neighbor filtering

          '_b_i_l_i_n_e_a_r' Linear interpolation in two dimensions

          '_g_a_u_s_s_i_a_n' This filter value is currently unimplemented, and
               should not be used in current code.


     '_C_a_i_r_o_P_a_t_t_e_r_n_T_y_p_e' '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 'CairoPattern' 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

          '_s_o_l_i_d' The pattern is a solid (uniform) color. It may be
               opaque or translucent.

          '_s_u_r_f_a_c_e' The pattern is a based on a surface (an image).

          '_l_i_n_e_a_r' The pattern is a linear gradient.

          '_r_a_d_i_a_l' The pattern is a radial gradient.


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

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

