README.in

   1 Clutter README.
   2 ===============
   3
   4 This is Clutter @CLUTTER_VERSION@. Clutter aims to give a nice easy
   5 GObject based API for creating fast, mainly 2D single window stylalised
   6 applications such as media box UI's, presentaions, kiosk style apps etc.
   7 It uses OpenGL for rendering.
   8
   9 Its not meant to be a full featured GUI toolkit for regular desktop
  10 apps nor provide a general interface to *all* OpenGL functionality.
  11
  12 It currently uses fairly low end GL functionality with an aim to still
  13 work well on open source graphics drivers as well as possibly making
  14 an eventual GL ES port feasable.
  15
  16 Clutter currently requires:
  17
  18   * GLib >= 2.10.0
  19   * GdkPixbuf
  20   * OpenGL >= 1.2
  21
  22 Its also recommended you have some kind of working hardware OpenGL on
  23 your target system.
  24
  25 Clutter is LGPL licensed.
  26
  27 The official website is:        http://www.clutter-project.org
  28 The official mailing list is:   http://lists.o-hand.com/clutter/
  29 New bug page on Bugzilla:       http://bugzilla.o-hand.com/enter_bug.cgi?product=Clutter
  30
  31 INSTALLATION
  32 ====
  33 See the INSTALL file
  34
  35 RELEASE NOTES
  36 ====
  37
  38 Release Notes for Clutter 0.4
  39 -----------------------------
  40
  41 * The GLX specific API has been moved to the GLX backend code and
  42   it's now under the ClutterGlx namespace.
  43
  44 * The priority of the various users of the GLib main loop has been
  45   reviewed and changed were necessary. Every paint is queued with a
  46   priority of G_PRIORITY_DEFAULT + 10; timelines are allocated with
  47   a G_PRIORITY_DEFAULT + 30 priority; events are processed with a
  48   G_PRIORITY_DEFAUTL priority. This ensures that events are processed
  49   before the paints take place.
  50
  51 * The ClutterActor::allocate_coords() has been renamed to
  52   ClutterActor::query_coords(), in order to clarify its usage.
  53
  54 * Actors overriding ClutterActor::request_coords() and
  55   ClutterActor::query_coords() must convert sizes obtained from the
  56   public API from pixels to ClutterUnits, using the conversion
  57   macros found in clutter-units.h. The conversion will be necessary
  58   until the public API will switch over to returning the generic
  59   units too.
  60
  61 * Users of Intel video cards should find that disabling sync-to-vblank
  62   is no longer necessary. In case Clutter applications take really
  63   long times for redrawing and appear stuck and unresponsive, the
  64   sync-to-vblank feature might still be the culprit; in that case, use
  65   "export CLUTTER_VBLANK=none" to disable it and file a bug reporting the
  66   video card model, the driver version and the X server version.
  67
  68 * ClutterTimeline objects now share the same timeout pool (see the
  69   ClutterTimeoutPool API). This might cause problems with heavily
  70   threaded libraries without integration with the GLib main loop.
  71   If an application experiences bad behaviours during animations
  72   use "export CLUTTER_TIMELINE=no-pool" to disable the timeout pool.
  73
  74 HACKING
  75 ====
  76 If you want to hack on and improve clutter check the TODO file.
  77
  78 BUGS
  79 ====
  80 Bugs should be reported to the OpenedHand Bugzilla at:
  81
  82   http://bugzilla.o-hand.com/enter_bug.cgi?product=Clutter
  83
  84 You will need an account.
  85
  86 In the report you should include:
  87 * what system you're running Clutter on;
  88 * which version of GLib, GdkPixbuf and OpenGL you are using;
  89 * which video card and which drivers you are using;
  90 * how to reproduce the bug.
  91
  92 If you cannot reproduce the bug with one of the tests that come with Clutter
  93 source code, you should include a small test case displaying the bad
  94 behaviour.
  95
  96 If the bug exposes a crash, the exact text printed out and a stack trace
  97 obtained using gdb are greatly appreciated.
  98
  99 PATCHES
 100 ====
 101 Patches should be submitted using Bugzilla. Patches fixing a bug should be
 102 attached to the bug report; patches for new features or for fixing bugs not
 103 yet reported should be attached to a newly opened bug. Patches should always
 104 be in the unified diff format.