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 GLib >= 2.10, GdkPixbuf and OpenGL >= 1.2.
  17 Its also recommended you have some kind of working hardware OpenGL on
  18 your target system.
  19
  20 Clutter is LGPL licensed.
  21
  22 The official website is:        http://www.clutter-project.org
  23
  24 INSTALLATION
  25 ====
  26 See the INSTALL file
  27
  28 RELEASE NOTES
  29 ====
  30
  31 Release Notes for Clutter 0.4
  32 -----------------------------
  33
  34 * The GLX specific API has been moved to the GLX backend code and
  35   it's now under the ClutterGlx namespace.
  36
  37 * The priority of the various users of the GLib main loop has been
  38   reviewed and changed were necessary. Every paint is queued with a
  39   priority of G_PRIORITY_DEFAULT + 10; timelines are allocated with
  40   a G_PRIORITY_DEFAULT + 30 priority; events are processed with a
  41   G_PRIORITY_DEFAUTL priority. This ensures that events are processed
  42   before the paints take place.
  43
  44 * The ClutterActor::allocate_coords() has been renamed to
  45   ClutterActor::query_coords(), in order to clarify its usage.
  46
  47 * Actors overriding ClutterActor::request_coords() and
  48   ClutterActor::query_coords() must convert sizes obtained from the
  49   public API from pixels to ClutterUnits, using the conversion
  50   macros found in clutter-units.h. The conversion will be necessary
  51   until the public API will switch over to returning the generic
  52   units too.
  53
  54 * Users of Intel video cards should find that disabling sync-to-vblank
  55   is no longer necessary. In case Clutter applications take really
  56   long times for redrawing and appear stuck and unresponsive, the
  57   sync-to-vblank feature might still be the culprit; in that case, use
  58   CLUTTER_VBLANK=none to disable it and file a bug reporting the video
  59   card model, the driver version and the X server version.
  60
  61 HACKING
  62 ====
  63 If you want to hack on and improve clutter check the TODO file.
  64
  65 BUGS
  66 ====
  67
  68 Bugs should be reported to the OpenedHand Bugzilla at:
  69
  70   http://bugzilla.o-hand.com
  71
  72 Under the product "Clutter".
  73
  74 In the report you should include:
  75 * what system you're running Clutter on;
  76 * which version of GLib, GdkPixbuf and OpenGL you are using;
  77 * which video card and which drivers you are using;
  78 * how to reproduce the bug.
  79
  80 If you cannot reproduce the bug with one of the tests that come with Clutter
  81 source code, you should include a small test case displaying the bad
  82 behaviour.
  83
  84 If the bug exposes a crash, the exact text printed out and a stack trace
  85 obtained using gdb are greatly appreciated.
  86
  87 PATCHES
  88 ====
  89
  90 Patches should be submitted using Bugzilla. Patches fixing a bug should be
  91 attached to the bug report; patches for new features or for fixing bugs not
  92 yet reported should be attached to a newly opened bug. Patches should always
  93 be in the unified diff format.