cairo-cairo-surface-t         package:RGtk2         R Documentation

_c_a_i_r_o__s_u_r_f_a_c_e__t

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

     Base class for surfaces

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

     'cairoSurfaceCreateSimilar(other, content, width, height)'
      'cairoSurfaceReference(surface)'
      'cairoSurfaceDestroy(surface)'
      'cairoSurfaceStatus(surface)'
      'cairoSurfaceFinish(surface)'
      'cairoSurfaceFlush(surface)'
      'cairoSurfaceGetFontOptions(surface)'
      'cairoSurfaceGetContent(surface)'
      'cairoSurfaceMarkDirty(surface)'
      'cairoSurfaceMarkDirtyRectangle(surface, x, y, width, height)'
      'cairoSurfaceSetDeviceOffset(surface, x.offset, y.offset)'
      'cairoSurfaceGetDeviceOffset(surface)'
      'cairoSurfaceSetFallbackResolution(surface, x.pixels.per.inch,
     y.pixels.per.inch)'
      'cairoSurfaceGetType(surface)'
      'cairoSurfaceSetUserData(surface, key, user.data)'
      'cairoSurfaceGetUserData(surface, key)'
      'cairoSurfaceCopyPage(surface)'
      'cairoSurfaceShowPage(surface)'
      'cairoSurface(width, height, format, other, content, data,
     stride, filename, con)'

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

     'CairoSurface' is the abstract type representing all different
     drawing targets that cairo can render to.  The actual drawings are
     performed using a cairo context.

     A cairo surface is created by using backend-specific constructors,
     typically of the form cairo__backend_'surfaceCreate()'.

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


     '_C_a_i_r_o_S_u_r_f_a_c_e' A 'CairoSurface' represents an image, either as the
          destination of a drawing operation or as source when drawing
          onto another surface.  To draw to a 'CairoSurface', create a
          cairo context with the surface as the target, using
          'cairoCreate'.

          There are different subtypes of 'CairoSurface' for different
          drawing backends; for example, 'cairoImageSurfaceCreate'
          creates a bitmap image in memory. The type of a surface can
          be queried with 'cairoSurfaceGetType'.

          Memory management of 'CairoSurface' is done with
          'cairoSurfaceReference' and 'cairoSurfaceDestroy'.  


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

     'cairoSurface' is the result of collapsing the constructors of
     'cairo_surface_t' ('cairoSurfaceCreateSimilar',
     'cairoImageSurfaceCreate', 'cairoImageSurfaceCreateForData',
     'cairoImageSurfaceCreateFromPng',
     'cairoImageSurfaceCreateFromPngStream') 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_C_o_n_t_e_n_t' 'CairoContent' is used to describe the content that
          a surface will contain, whether color information, alpha
          information (translucence vs. opacity), or both.

          Note: The large values here are designed to keep
          'CairoContent' values distinct from 'CairoFormat' values so
          that the implementation can detect the error if users confuse
          the two types.  

          '_c_o_l_o_r' The surface will hold color content only.

          '_a_l_p_h_a' The surface will hold alpha content only.

          '_c_o_l_o_r-_a_l_p_h_a' The surface will hold color and alpha content.


     '_C_a_i_r_o_S_u_r_f_a_c_e_T_y_p_e' 'CairoSurfaceType' is used to describe the type
          of a given surface. The surface types are also known as
          "backends" or "surface backends" within cairo.

          The type of a surface is determined by the function used to
          create it, which will generally be of the form
          cairo__type_'surfaceCreate()', (though see
          'cairoSurfaceCreateSimilar' as well).

          The surface type can be queried with 'cairoSurfaceGetType'

          The various 'CairoSurface' functions can be used with
          surfaces of any type, but some backends also provide
          type-specific functions that must only be called with a
          surface of the appropriate type. These functions have names
          that begin with cairo__type__surface such as
          'cairoImageSurfaceGetWidth'.

          The behavior of calling a type-specific function with a
          surface of the wrong type is undefined.

          New entries may be added in future versions.  

          Since  1.2

          '_i_m_a_g_e' The surface is of type image

          '_p_d_f' The surface is of type pdf

          '_p_s' The surface is of type ps

          '_x_l_i_b' The surface is of type xlib

          '_x_c_b' The surface is of type xcb

          '_g_l_i_t_z' The surface is of type glitz

          '_q_u_a_r_t_z' The surface is of type quartz

          '_w_i_n_3_2' The surface is of type win32

          '_b_e_o_s' The surface is of type beos

          '_d_i_r_e_c_t_f_b' The surface is of type directfb

          '_s_v_g' The surface is of type svg


_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-cairo-surface-t.html>

