Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkgc.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Graphics Contexts
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A shared pool of GdkGC objects
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 These functions provide access to a shared pool of #GdkGC objects.
  10 When a new #GdkGC is needed, gtk_gc_get() is called with the required depth,
  11 colormap and #GdkGCValues. If a #GdkGC with the required properties already
  12 exists then that is returned. If not, a new #GdkGC is created.
  13 When the #GdkGC is no longer needed, gtk_gc_release() should be called.
  14 </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18
  19 </para>
  20
  21 <!-- ##### SECTION Stability_Level ##### -->
  22
  23
  24 <!-- ##### FUNCTION gtk_gc_get ##### -->
  25 <para>
  26 Gets a #GdkGC with the given depth, colormap and #GdkGCValues.
  27 If a #GdkGC with the given properties already exists then it is returned,
  28 otherwise a new #GdkGC is created.
  29 The returned #GdkGC should be released with gtk_gc_release() when it is no
  30 longer needed.
  31 </para>
  32
  33 @depth: the depth of the #GdkGC to create.
  34 @colormap: the #GdkColormap (FIXME: I don't know why this is needed).
  35 @values: a #GdkGCValues struct containing settings for the #GdkGC.
  36 @values_mask: a set of flags indicating which of the fields in @values has
  37 been set.
  38 @Returns: a #GdkGC.
  39
  40
  41 <!-- ##### FUNCTION gtk_gc_release ##### -->
  42 <para>
  43 Releases a #GdkGC allocated using gtk_gc_get().
  44 </para>
  45
  46 @gc: a #GdkGC.
  47
  48