26f4467392
The default stage was a neat concept when we started Clutter out, somewhere in the Jurassic era; a singleton instance that gets created at initialization time, and remains the same for the entire duration of the process. Worked well enough when Clutter was a small library meant to be used to write fullscreen media browsers, but since the introduction of multiple stages, and Clutter being used to create all sorts of applications, the default stage is just a vestigial remainder of that past, like an appendix; something that complicates the layout of the code and introduces weird behaviour, so that you notice its existence only when something goes wrong. Some platforms we do support, though, only have one framebuffer, so it makes sense for them to have only one stage. At this point, the only sane thing to do is to go through the same code paths on all platforms, and that code path is the stage instance creation and initialization — i.e. clutter_stage_new() (or g_object_new() with CLUTTER_TYPE_STAGE). For platforms that support multiple stages, nothing has changed: the stage created by clutter_stage_get_default() will be set as the default one; if nobody calls it, the default stage is never created, and it just lives on as a meaningless check. For platforms that only support one stage, clutter_stage_new() and clutter_stage_get_default() will behave exactly the same the first time they are called: both will create a stage, and set it as the default. Calling clutter_stage_new() a second time is treated as a programmer error, and will result in Clutter aborting. This is a behavioural change because the existing behaviour or creating a new ClutterStage instance with the same ClutterStageWindow private implementation is, simply put, utterly braindamaged and I should have *never* had written it, and I apologize for it. In my defence, I didn't know any better at the time. This is the first step towards the complete deprecation of clutter_stage_get_default() and clutter_stage_is_default(), which will come later. |
||
|---|---|---|
| build | ||
| clutter | ||
| doc | ||
| po | ||
| tests | ||
| .gitignore | ||
| autogen.sh | ||
| ChangeLog.pre-git-import | ||
| clutter.doap | ||
| configure.ac | ||
| COPYING | ||
| Makefile.am | ||
| NEWS | ||
| README.in | ||
| README.md | ||
Clutter
What is Clutter?
Clutter is an open source software library for creating fast, compelling, portable, and dynamic graphical user interfaces.
Requirements
Clutter currently requires:
On X11, Clutter depends on the following extensions:
- XComposite
- XDamage
- XExt
- XFixes
- XInput (1.x or 2.x)
- XKB
If you are building the API reference you will also need:
If you are building the additional documentation you will also need:
- xsltproc
- jw (optional, for generating PDFs)
If you are building the Introspection data you will also need:
If you want support for profiling Clutter you will also need:
Resources
The official Clutter website is:
http://www.clutter-project.org/
The API references for the latest stable release are available at:
http://docs.clutter-project.org/docs/clutter/stable/
http://docs.clutter-project.org/docs/cogl/stable/
http://docs.clutter-project.org/docs/cally/stable/
The Clutter Cookbook is available at:
http://docs.clutter-project.org/docs/clutter-cookbook/
New releases of Clutter are available at:
http://source.clutter-project.org/sources/clutter/
The Clutter blog is available at:
http://www.clutter-project.org/blog/
To subscribe to the Clutter mailing lists and read the archives, use the Mailman web interface available at:
http://lists.clutter-project.org/
New bug page on Bugzilla:
http://bugzilla.gnome.org/enter_bug.cgi?product=clutter
Clutter is licensed under the terms of the GNU Lesser General Public
License, version 2.1 or (at your option) later: see the COPYING file
for more information.
Building and Installation
To build Clutter from a release tarball, the usual autotool triad should be followed:
- ./configure
- make
- make install
To build Clutter from a Git clone, run the autogen.sh script instead
of the configure one. The autogen.sh script will run the configure script
for you, unless the NOCONFIGURE environment variable is set to a non-empty
value.
See also the BuildingClutter page on the wiki.
Versioning
Clutter uses the common "Linux kernel" versioning system, where even-numbered minor versions are stable and odd-numbered minor versions are development snapshots.
Different major versions break both API and ABI but are parallel installable. The same major version with differing minor version is expected to be ABI compatible with other minor versions; differing micro versions are meant just for bug fixing. On odd minor versions the newly added API might still change.
The micro version indicates the origin of the release: even micro numbers are only used for released archives; odd micro numbers are only used on the Git repository.
Contributing
If you want to hack on and improve Clutter check the HACKING file for
general implementation guidelines, and the HACKING.backends for
backend-specific implementation issues.
The CODING_STYLE file contains the rules for writing code conformant to
the style guidelines used throughout Clutter. Remember: the coding style
is mandatory; patches not conforming to it will be rejected by default.
The usual workflow for contributions should be:
- Fork the repository
- Create a branch (
git checkout -b my_work) - Commit your changes (
git commit -am "Added my awesome feature") - Push to the branch (
git push origin my_work) - Create an Bug with a link to your branch
- Sit back, relax and wait for feedback and eventual merge
Bugs
Bugs should be reported to the Clutter Bugzilla at:
http://bugzilla.gnome.org/enter_bug.cgi?product=clutter
You will need a Bugzilla account.
In the report you should include:
- what system you're running Clutter on;
- which version of Clutter you are using;
- which version of GLib and OpenGL (or OpenGL ES) you are using;
- which video card and which drivers you are using, including output of glxinfo and xdpyinfo (if applicable);
- how to reproduce the bug.
If you cannot reproduce the bug with one of the tests that come with Clutter source code, you should include a small test case displaying the bad behaviour.
If the bug exposes a crash, the exact text printed out and a stack trace obtained using gdb are greatly appreciated.