1 README for Clutter @CLUTTER_VERSION@
2 ===============================================================================
4 Clutter is an open source software library for creating fast, compelling,
5 portable, and dynamic graphical user interfaces.
8 -------------------------------------------------------------------------------
10 Clutter currently requires:
12 • GLib ≥ @GLIB_REQ_VERSION@
13 • Cogl ≥ @COGL_REQ_VERSION@
14 • JSON-GLib ≥ @JSON_GLIB_REQ_VERSION@
15 • Atk ≥ @ATK_REQ_VERSION@
16 • Cairo ≥ @CAIRO_REQ_VERSION@
17 • PangoCairo ≥ @PANGO_REQ_VERSION@
19 Clutter also has optional dependencies:
21 • GDK-Pixbuf ≥ @GDK_PIXBUF_REQ_VERSION@
23 On X11, Clutter depends on the following extensions
25 • XComposite ≥ @XCOMPOSITE_REQ_VERSION@
28 • XFixes ≥ @XFIXES_REQ_VERSION@
32 When running the OpenGL flavor, Clutter requires at least version 1.3
33 or 1.2 with the multitexturing extension. However to build Clutter
34 you will need the latest GL headers which can be obtained from:
36 http://www.khronos.org
38 If you are building the API reference you will also need:
40 • GTK-Doc ≥ @GTK_DOC_REQ_VERSION@
42 If you are building the additional documentation you will also need:
45 • jw (optional, for generating PDFs)
47 If you are building the Introspection data you will also need:
49 • GObject-Introspection ≥ @GI_REQ_VERSION@
51 GObject-Introspection is available from:
53 git://git.gnome.org/gobject-introspection
55 If you want support for profiling Clutter you will also need:
57 • UProf ≥ @UPROF_REQ_VERSION@
59 UProf is available from:
61 git://github.com/rib/UProf.git
64 -------------------------------------------------------------------------------
66 The official Clutter website is:
68 http://www.clutter-project.org/
70 The API references for the latest stable release are available at:
72 http://docs.clutter-project.org/docs/clutter/stable/
73 http://docs.clutter-project.org/docs/cogl/stable/
74 http://docs.clutter-project.org/docs/cally/stable/
76 The Clutter Cookbook is available at:
78 http://docs.clutter-project.org/docs/clutter-cookbook/@CLUTTER_API_VERSION@/
80 New releases of Clutter are available at:
82 http://source.clutter-project.org/sources/clutter/
84 The Clutter blog is available at:
86 http://www.clutter-project.org/blog/
88 To subscribe to the Clutter mailing lists and read the archives, use the
89 Mailman web interface available at:
91 http://lists.clutter-project.org/
93 New bug page on Bugzilla:
95 http://bugzilla.gnome.org/enter_bug.cgi?product=clutter
97 Clutter is licensed under the terms of the GNU Lesser General Public
98 License, version 2.1 or (at your option) later.
100 BUILDING AND INSTALLATION
101 -------------------------------------------------------------------------------
103 To build Clutter from a release tarball, the usual autotool triad should
110 To build Clutter from a Git clone, run the autogen.sh script instead
111 of the configure one. The autogen.sh script will run the configure script
112 for you, unless the NOCONFIGURE environment variable is set to a non-empty
115 See also the wiki page:
117 http://wiki.clutter-project.org/wiki/BuildingClutter
119 Clutter has additional command line options for the configure script:
121 --enable-debug=[no/minimum/yes]
122 Controls Clutter debugging level:
125 All GLib asserts, checks and support for runtime Clutter
126 debugging notes through CLUTTER_DEBUG. This is the default
127 value for developers snapshots.
130 Just GType cast checks and support for runtime Clutter
131 debugging notes through CLUTTER_DEBUG. This is the default
135 No GLib asserts or checks and no support for runtime Clutter
136 debugging notes. Only use in extreme performance and/or size
137 optimization cases, though it is strongly discouraged.
139 --enable-maintainer-flags=[no/yes/error]
140 Use strict compiler flags. This defaults to 'yes' for building from
141 Git to 'no' for tarball releases. If 'error' is used, then -Werror
142 will be enabled (if available).
145 use gtk-doc to build API documentation (default=no). Requires gtk-doc
146 present on the target system.
148 --enable-docs=[no/yes]
149 Build additional documentation. Requires xsltproc for DocBook
150 conversion, and optionally jw for PDF generation.
152 --enable-gcov=[no/yes]
153 Build Clutter with coverage report support, provided by gcov. This
154 feature only works with the GNU Compiler Suite and gcov installed.
156 --enable-profile=[no/yes]
157 Build Clutter with profiling instrumentation. Requires the GNU
158 C Compiler and the UProf library.
160 --enable-conform=[yes/no]
161 Build the Clutter conformance test suite.
164 Disable linking with -Bsymbolic.
167 Select the Clutter backend: (default=glx)
170 Fully featured GLX backend.
173 EGL/Open GL backend for X11.
176 EGL/Open GL backend for Wayland. (EXPERIMENTAL)
179 EGL/Open GL|ES backend for X11.
182 EGL/Open GL|ES backend on 'native windowing system' - i.e
183 raw framebuffer. Expects the EGL implementation to provide
184 a createNativeWindow() call.
187 EGL/Open GL|ES backend on Intel CE3100 and CE4100 platforms.
191 OS X backend. (EXPERIMENTAL)
194 Microsoft Windows(tm) WGL backend.
196 See also the INSTALL file generated by autotools for further information.
199 -------------------------------------------------------------------------------
201 Clutter uses the common "Linux kernel" versioning system, where
202 even-numbered minor versions are stable and odd-numbered minor
203 versions are development snapshots.
205 Different major versions break both API and ABI but are parallel
206 installable. The same major version with differing minor version is
207 expected to be ABI compatible with other minor versions; differing
208 micro versions are meant just for bug fixing. On odd minor versions
209 the newly added API might still change.
211 The micro version indicates the origin of the release: even micro
212 numbers are only used for released archives; odd micro numbers are
213 only used on the Git repository.
216 -------------------------------------------------------------------------------
218 If you want to hack on and improve Clutter check the HACKING file for
219 general implementation guidelines, and the HACKING.backends for
220 backend-specific implementation issues.
222 The CODING_STYLE file contains the rules for writing code conformant to the
223 style guidelines used throughout Clutter. Remember: the coding style is
224 mandatory; patches not conforming to it will be rejected by default.
227 -------------------------------------------------------------------------------
229 Bugs should be reported to the Clutter Bugzilla at:
231 http://bugzilla.gnome.org/enter_bug.cgi?product=clutter
233 You will need a Bugzilla account.
235 In the report you should include:
237 • what system you're running Clutter on;
238 • which version of Clutter you are using;
239 • which version of GLib and OpenGL (or OpenGL ES) you are using;
240 • which video card and which drivers you are using, including output of
241 glxinfo and xdpyinfo (if applicable);
242 • how to reproduce the bug.
244 If you cannot reproduce the bug with one of the tests that come with Clutter
245 source code, you should include a small test case displaying the bad
248 If the bug exposes a crash, the exact text printed out and a stack trace
249 obtained using gdb are greatly appreciated.
252 -------------------------------------------------------------------------------
254 Patches should be submitted using Bugzilla. Patches fixing a bug should be
255 attached to the bug report; patches for new features or for fixing bugs not
256 yet reported should be attached to a newly opened bug.
258 Patches should always be in the unified diff format, using:
260 diff -Nuarp clutter.source clutter.patched > clutter-patch.diff
262 If diffing against the Git repository, you should use:
264 git diff > clutter-patch.diff
266 Or, better: commit locally and use `git format-patch` to generate a patch
267 containing authorship details, so that members of the Clutter development
268 team can credit your contribution properly.
270 Another useful tool for interacting with Git and Bugzilla is git-bz(1):
272 http://git.fishsoup.net/man/git-bz.html
274 Which is available here:
276 http://git.fishsoup.net/cgit/git-bz/
279 -------------------------------------------------------------------------------
281 Relevant information for developers with existing Clutter applications
282 wanting to port to newer releases (see NEWS for general information on new
285 Release Notes for Clutter 1.6
286 -------------------------------------------------------------------------------
288 • The internal copy of JSON-GLib has been removed: Clutter now strictly
289 depends on the installed copy of this library. The --with-json configure
290 switch has been removed.
292 • The ClutterBehaviour class and its sub-classes have been deprecated; the
293 Clutter API reference contains a migration guide to port code based on
294 behaviours to the implicit animations framework.
296 • The ClutterTimeoutPool and clutter_frame_source_* API have been deprecated;
297 both API are not integrated in the Clutter main loop, and are not used
298 internally any longer, so they are of relative use.
300 • It it not necessary any more to provide implementations for the
301 ClutterActor::map() and ClutterActor::unmap() virtual functions, even
302 for composite actors not implementing the ClutterContainer interface.
304 • ClutterTimeline now guarantees that the ::new-frame signal will be
305 emitted at the beginning of the timeline, as well as guaranteeing that
306 the ::completed signal will be emitted at the end of the timeline.
308 • ClutterActor will check for the enabled property of ClutterActorMeta
309 instances (actions, constraints and effects), and will not invoke
310 ClutterActorMeta functions on disabled instances. This removes the
311 requirement for checking the property inside the ClutterActorMeta
314 • ClutterActorBox, ClutterGeometry and ClutterVertex install a progress
315 function for ClutterInterval, allowing the interpolation of properties
316 using them as storage types.
318 • ClutterColor's clutter_color_from_string() function accepts CSS3 color
321 • The previously unused "axes" field in the ClutterButtonEvent,
322 ClutterScrollEvent and ClutterMotionEvent structures is now used on
323 the X11-based backends with XInput support.
325 • ClutterListModel will honour the filter function when calling
326 clutter_model_get_iter_at_row().
328 • ClutterClickAction does not use a pointer grab any longer, and uses
329 a capture on the stage instead.
331 • On all platforms which allow it, ClutterStage will ask the windowing
332 system for an explicit key focus when showing the stage window. This
333 can be disabled using clutter_stage_set_accept_focus().
335 Release Notes for Cogl 1.6
336 -------------------------------------------------------------------------------
338 • Cogl may internally optimise cogl_read_pixels when only a single
339 pixel is drawn and the entire scene is comprised of solid colour
340 rectangles. Instead of actually rendering the rectangles it will
341 compute the single pixel value in software. This effectively means
342 that Clutter can do software picking without any API changes.
344 • Internally Cogl now has a GLSL backend as well as the ARBfp and
345 fixed function backends. By default, this backend has the lowest
346 priority but it can be explicitly enabled by setting the
347 COGL_DEBUG environment variable, e.g.:
349 export COGL_DEBUG=disable-fixed,disable-arbfp
351 for builds of Clutter with debug support enabled.
353 • Cogl will internally now cache generated ARBfp programs so that it
354 should be able to reuse a previous program even if it was generated
355 for an unrelated CoglMaterial. This makes using one-shot materials
356 less expensive than before although it is still not recommended.
358 Release Notes for Clutter 1.4
359 -------------------------------------------------------------------------------
361 • ClutterLayoutManager sub-classes overriding the set_container() virtual
362 function should chain up to the parent class's implementation.
364 • The ClutterTexture:filename property is now readable, as well as writable;
365 this allows querying the Texture for the filename storing the image data.
366 The value will be unset when using the set_from_*_data() family of
369 • If both the :sync-size and the :keep-aspect-ratio properties of a
370 ClutterTexture are set to TRUE, then the texture actor will update its
371 ClutterActor:request-mode property depending on the orientation of the
372 image data - height-for-width for landscape, and width-for-height for
373 portrait. Square image data will default to height-for-width, like all
374 actors. You can still explicitly override the :request-mode value, or
375 you can unset the :sync-size property to control the size yourself.
377 • All the key symbol macros have been renamed from CLUTTER_* to
378 CLUTTER_KEY_*. The old names are still available inside the
379 clutter-keysyms-compat.h header, which is included by clutter-keysyms.h
380 unless CLUTTER_DISABLE_DEPRECATED is defined.
382 • The internal copy of json-glib is now deprecated. Building Clutter will
383 default to the system copy and requires an explicit --with-json=internal
384 to override the check.
386 Release Notes for Clutter 1.2
387 -------------------------------------------------------------------------------
389 * ClutterStageManager is now publicly available and documented API.
391 * Clutter now depends on the system copy of JSON-GLib, and will fall
392 back to the internal copy only if JSON-GLib is not installed.
394 * ClutterActor:opacity is now defined using GParamSpecUint instead of
395 GParamSpecUchar; the same interval of [ 0, 255 ] applies, and GValue
396 has internal transformation functions for converting between G_TYPE_UINT
397 and G_TYPE_UCHAR, so this change should be fully transparent to the
400 * On X11 Clutter will emulate XKB's detectable key auto-repeat; this means
401 that when holding down a key, Clutter will emit multiple CLUTTER_KEY_PRESS
402 events and a single CLUTTER_KEY_RELEASE event instead of a list of
403 CLUTTER_KEY_PRESS and CLUTTER_KEY_RELEASE pairs.
405 * On X11 and Win32 the default Stage is created when
406 clutter_stage_get_default() is called for the first time, and not as
407 part of the stage initialization.
409 Cogl API changes for Clutter 1.2
410 -------------------------------------------------------------------------------
412 * cogl_viewport is now deprecated in favour of cogl_set_viewport which
413 accepts a viewport offset.
415 * cogl_clip_push() is now deprecated and new code should use
416 cogl_clip_push_rectangle() instead. The old API wasn't consistent with other
417 Cogl APIs that specify model space rectangles using (x0,y0)(x1,y1) pairs.
419 * cogl_clip_push_window_rect() is now deprecated and new code should use
420 cogl_clip_push_window_rectangle(). The old API shouldn't have been defined
421 to take floats and the abbreviation wasn't consistent with other Cogl API.
423 * cogl_clip_stack_save() and cogl_clip_stack_restore() are deprecated, as
424 the functionality is redundant now that offscreen draw buffers own their
425 clip state and switching to/from offscreen rendering will automatically
426 save and restore the clip state.
428 * cogl_material_copy() was added. It is advised that developers use
429 this instead of cogl_material_new() when creating a material that is in some
430 way derived from another. This will allow Cogl to track material
431 ancestries/similarities and reduce the cost of GPU state changes.
433 * cogl_push_draw_buffer, cogl_set_draw_buffer and cogl_pop_draw_buffer are now
434 deprecated and new code should use the cogl_framebuffer_* API instead.
435 Code that previously did:
436 cogl_push_draw_buffer ();
437 cogl_set_draw_buffer (COGL_OFFSCREEN_BUFFER, buffer);
439 cogl_pop_draw_buffer ();
440 can now be re-written as:
441 cogl_push_framebuffer (buffer);
443 cogl_pop_framebuffer ();
445 * All cogl_<type>_ref() and cogl_<type>_unref() functions have been
446 deprecated, and superceded by cogl_handle_ref() and cogl_handle_unref()
449 * The cogl_check_extension() function has been deprecated. This function
450 was never meant to be public, since it depends on calling glGetString()
451 before its invocation. Users of this function can be replaced by the
454 gl_ext = glGetString (GL_EXTENSIONS);
455 - has_ext = cogl_check_extension (ext_name, gl_ext);
456 + has_ext = strstr (gl_ext, ext_name) != NULL ? TRUE : FALSE;
458 Release Notes for Clutter 1.0
459 -------------------------------------------------------------------------------
461 * The clutter_actor_set_shader_param() function now takes a
462 GValue, which can be set using the clutter_value_set_shader()
463 family of functions. The floating point wrapper has been
464 rename clutter_actor_set_shader_param_float() to match the newly
465 added clutter_actor_set_shader_param_int().
467 * The Pango renderer API has been exposed as public API, after
468 a full rename from PangoClutter to CoglPango, to avoid namespace
469 collisions with upstream Pango. The Pango font map, renderer and
470 glyph cache can be used by third party code and depend only on
473 * Both Clutter and COGL only allow including <clutter/clutter.h>
474 and <cogl/cogl.h> directly, respectively. This allows avoiding
475 breaking API every time a type definition is moved across
476 headers, and improves the reliability of third party code against
477 internal refactorings.
479 * COGL has an internal Color type, used to store a color definition
480 that can be efficiently used with the least amount of conversions
481 by both the GL and GLES implementations. The COGL API has been
482 changed to drop the usage of ClutterColor in favour of CoglColor.
484 * The fixed point API implementation Clutter uses internally has been
485 moved from the Clutter namespace to the COGL one.
487 * ClutterLabel and ClutterEntry have been removed from the API, as
488 both have been superceded by the ClutterText actor.
490 * ClutterCloneTexture has been removed from the API; in its place,
491 there is a generic ClutterClone actor which allows to "clone"
492 any existing actors -- even composite ones -- without using
493 frame buffer objects (FBOs).
495 * The ClutterEffectTemplate and clutter_effect_* functions have been
496 superceded by ClutterAnimation and thus removed from the public API.
498 * The ClutterBehaviourBspline has been superceded by the usage of
499 ClutterPath inside ClutterBehaviourPath, and thus removed from the
502 * ClutterColor API has received a much needed review to increase its
503 consistency. This has led to the following changes:
505 - clutter_color_parse() has been renamed to clutter_color_from_string()
506 and the order of the arguments has been changed
508 - the factor argument of clutter_color_shade() has been swapped with
509 the return location for the new color
511 - the fixed point entry points have been removed
513 - clutter_color_from_hls() and clutter_color_to_hls() do not
514 normalize the values in the [ 0, 255 ] interval but use the
515 correct HLS intervals:
521 * The ClutterFixed symbols have been completely removed: fixed-point
522 public entry points now take a CoglFixed.
524 * The -x and -u API have been removed. All the pixel-based API now
525 takes a float to allow sub-pixel precision; this is true also for
526 properties. WARNING: functions with variadic arguments (like
527 g_object_set(), g_object_get() and clutter_actor_animate()) do not
528 behave very well when dealing with integers instead of expected
529 floating point values, and vice versa. On 32bit machines it will
530 most likely lead to a crash. So:
532 g_object_set (actor, "width", 100, NULL);
534 is incorrect, and should be changed in:
536 g_object_set (actor, "width", 100.0, NULL);
538 * Composite actors that do not implement the Container interface
539 should implement the following virtual functions:
541 - void map (ClutterActor*)
542 - void unmap (ClutterActor*)
544 and chain up to the parent's implementation after calling
545 clutter_actor_map() or clutter_actor_unmap() on their children.
547 * Actors implementing the Container interface that have private
548 children that are not meant to be added/removed through the
549 Container API should implement the:
551 - void foreach_with_internals (ClutterContainer*,
557 * Actors that perform direct transformations using the COGL API inside
558 their paint() implementation should override the apply_transform()
559 virtual function instead. Implementations of the apply_transform()
560 vfunc must chain up to the implementation of the parent class.
562 * The ClutterUnit type and the CLUTTER_UNITS_* conversion macros have
563 been removed: all Actors are now using sub-pixel precision directly
564 throughout the API. The new ClutterUnits type has been added as a
565 generic opaque storage for logical distance values.
567 * Timelines are now fully time-based: all the frame-related properties
568 and methods have been removed. ClutterTimeline::new-frame will provide
569 the elapsed milliseconds since the beginning of the Timeline, instead
570 of the current frame number. The clutter_timeline_new() constructor
571 takes the duration of the timeline in milliseconds, and thus it replaces
572 the clutter_timeline_new_for_duration() variant.
574 Cogl API changes for Clutter 1.0
575 -------------------------------------------------------------------------------
577 * All drawing functions now use a source material to determine how geometry is
578 filled. The source material is set via cogl_set_source. Or the convenience
579 functions cogl_set_source_color and cogl_set_source_texture.
581 "drawing functions" include: cogl_rectangle, cogl_texture_rectangle,
582 cogl_texture_multiple_rectangles, cogl_texture_polygon (though the
583 cogl_texture_* funcs have been renamed; see below for details),
584 cogl_path_fill/stroke and cogl_vertex_buffer_draw*.
586 cogl_texture_rectangle, cogl_texture_multiple_rectangles and
587 cogl_texture_polygon no longer take a texture handle; instead the current
588 source material is referenced. The functions have also been renamed to:
589 cogl_rectangle_with_texture_coords, cogl_rectangles_with_texture_coords
590 and cogl_polygon respectively.
592 Most code that previously did:
593 cogl_texture_rectangle (tex_handle, x, y,...);
594 needs to be changed to now do:
595 cogl_set_source_texture (tex_handle);
596 cogl_rectangle_with_texture_coords (x, y,....);
598 In the less likely case where you were blending your source texture with a
600 cogl_set_source_color4ub (r,g,b,a); /* (where r,g,b,a isn't just white) */
601 cogl_texture_rectangle (tex_handle, x, y,...);
602 you will need your own material to do that:
603 material = cogl_material_new ();
604 cogl_material_set_color4ub (r,g,b,a);
605 cogl_material_set_layer (material, 0, tex_handle));
606 cogl_set_source_material (material);
608 Code that uses the texture coordinates, 0, 0, 1, 1 don't need to use
609 cogl_rectangle_with_texture_coords since these are the coordinates that
610 cogl_rectangle will use.
612 For cogl_texture_polygon; as well as dropping the texture handle, the
613 n_vertices and vertices arguments were transposed for consistency. So
614 code previously written as:
615 cogl_texture_polygon (tex_handle, 3, verts, TRUE);
616 need to be written as:
617 cogl_set_source_texture (tex_handle);
618 cogl_polygon (verts, 3, TRUE);
620 * The arguments to cogl_rectangle, cogl_path_rectangle and
621 cogl_path_round_rectangle have been changed - for consistency - from
622 x, y, width, height, to x1, y1, x2, y2.
624 * A CoglMatrix type and utility API has been added; this is currently used to
625 support describing texture matrices.
627 * cogl_alpha_func has been removed, since this is now controlled using the
628 material API via cogl_material_set_alpha_test_function ()
630 * A Cogl Vertex Buffer API has been added that allows you to efficiently
631 manage arrays of vertex attributes in buffers that may be stored on
632 the GPU. These allow you to avoid the costs of repeatedy validating
633 vertex data and mapping it into the GPU.
635 * cogl_scale now supports scaling on the z axis
637 * cogl_clip_set* and cogl_clip_unset have been renamed to cogl_clip_push and
638 cogl_clip_pop respectively so they self document their stacking semantics.
640 * cogl_paint_init was renamed to cogl_clear and no longer disables lighting and
641 fogging. cogl_clear also now takes a mask of the auxiliary buffers you want
642 to clear so you can avoid redundant clears of buffers you aren't using.
644 * cogl_fog_set was renamed to cogl_set_fog and it now takes a mode argument
645 giving control over the fogging blend factor equation, so that the
646 density argument isn't just ignored. A cogl_disable_fog function was
649 * cogl_get_*_matrix were changed to use the CoglMatrix type instead of
650 GLfloat m[16] arrays.
652 * cogl_offscreen_blit_region, cogl_offscreen_blit were removed since they were
653 only implemnted for GL, not GLES, and it was assumed no one was using them.
655 * cogl_offscreen_new_multisample was removed since it only ever returned
656 COGL_INVALID_HANDLE so it wasn't usefull.
658 * The COGL_MASK_BUFFER type was removed, since there should be nicer ways of
659 exposing color mask if anyone wants it later. It was assumed that no one was
660 using this currently.
662 * COGLenum, COGLint and COGLuint which were simply typedefs for
663 GL{enum,int,uint} have been removed from the API and replaced with
664 specialised enum typedefs, int and unsigned int. These were causing
665 problems for generating bindings and also considered poor style.
667 * The cogl texture filter defines CGL_NEAREST and CGL_LINEAR etc are now
668 replaced by a namespaced typedef 'CoglTextureFilter' so they should be
669 replaced with COGL_TEXTURE_FILTER_NEAREST and COGL_TEXTURE_FILTER_LINEAR etc.
671 * The shader type defines CGL_VERTEX_SHADER and CGL_FRAGMENT_SHADER are handled
672 by a CoglShaderType typedef and should be replaced with
673 COGL_SHADER_TYPE_VERTEX and COGL_SHADER_TYPE_FRAGMENT.
675 * cogl_shader_get_parameteriv has been replaced by cogl_shader_get_type and
676 cogl_shader_is_compiled. More getters can be added later if desired.
678 * cogl_enable_depth_test has been renamed to cogl_set_depth_test_enabled and
679 a corresponding cogl_get_depth_test_enabled function has been added.
681 Release Notes for Clutter 0.8
682 -------------------------------------------------------------------------------
684 * The COGL GL wrapper API has been completely overhauled and now
685 contains many new features including new greatly improved texture
686 abstractions (slicing, mipmapping, deformations etc, greatly
687 simplifying ClutterTexture), image loading and abstraction, path
688 based primitive drawing, clipping, and improved FBO and shader
689 support. It is now also fully documented.
691 * GL Texture Rectangle ext is no longer used, the regular 2D NPOTS
692 extension is preffered instead but not required.
694 * Clutter now has basic suppport for multiple input devices assuming
695 the backend supports it (currently X11 based via XInput and Fruity
696 backends). New API supporting this includes
697 clutter_event_get_device_id, clutter_get_input_device_for_id,
698 clutter_grab_pointer_for_device & clutter_ungrab_pointer_for_device.
700 XInput support needs to be explicitly enabled at runtime by calling
701 clutter_x11_enable_xinput () before clutter_init. clutter_x11_has_xinput ()
702 can then be called after to check if XInput extension present and use-able.
704 * The functions that return the transformed position of an actor have
705 been renamed to be more explicit about it:
707 clutter_actor_get_abs_position - clutter_actor_get_transformed_position
708 clutter_actor_get_abs_size - clutter_actor_get_transformed_size
710 Their behaviour has not been changed.
712 * To increase portability, Clutter does not strictly depend on
713 GdkPixbuf anymore; this means that you will have to include
714 <gdk-pixbuf/gdk-pixbuf.h> yourself if you are operating with
715 GdkPixbuf objects and not including that header. The GdkPixbuf-based
716 API has been removed from Clutter core:
718 clutter_texture_new_from_pixbuf
719 clutter_texture_set_pixbuf
720 clutter_texture_get_pixbuf
722 are all deprecated functions. It is still possible to load a GdkPixbuf
723 into a ClutterTexture with this sample code:
725 clutter_texture_set_from_rgb_data (texture,
726 gdk_pixbuf_get_pixels (pixbuf),
727 gdk_pixbuf_get_has_alpha (pixbuf),
728 gdk_pixbuf_get_width (pixbuf),
729 gdk_pixbuf_get_height (pixbuf),
730 gdk_pixbuf_get_rowstride (pixbuf),
731 gdk_pixbuf_get_has_alpha (pixbuf) ? 4
736 ClutterTexture also now has a new filename property and
737 clutter_texture_new_from_file which is intended as an alternate to
738 common previous GdkPixbuf primary usage (i.e loading images from
741 To read texture data back into a pixbuf or system memory use a combination
742 of clutter_texture_get_cogl_texture & cogl_texture_get_data.
744 The clutter-gtk integration library has API for using GdkPixbuf with
745 ClutterTextures (among others).
747 ClutterTexture now supports a keep-aspect property which is set to FALSE
750 * clutter_texture_from_actor will now reparent source actors if they
751 are not parented. This behaviour may change in future releases.
752 There are known not yet fixed issues with source actors that set
753 depth or use clipping.
755 * The size negotiation API has been completely changed in order to allow
756 the creation of non-fixed layout managers. These functions have been
759 clutter_actor_request_coords()
760 clutter_actor_query_coords()
762 from the ClutterActor API, as well as their virtual functions inside
763 the ClutterActorClass. The size of an actor is now split into two
764 different concepts: the preferred size (width and height
765 separatedly) and the size that has been allocated by the container
766 to which that actor belongs. Clutter still defaults to the fixed
767 layout management (i.e ClutterGroup) of the actors, but supports
768 fluid layout managers written using the new API.
770 Composite actors (actors with 'private' children not implementing the
771 container interface) now need to implement an allocate method here pass
772 an allocation to any composite children.
774 * Clutter now depends on PangoCairo for the font rendering. The PangoClutter
775 API is still considered semi-private and no guarantees are made on its
778 * ClutterShader API has been slightly changed: the ClutterStage:bound
779 property, clutter_shader_bind() and clutter_shader_is_bound() have
780 been renamed to :compiled, clutter_shader_compile() and
781 clutter_shader_is_compiled(), respectively. The previously semi-private
782 clutter_shader_release_all() function is now not exported anymore.
784 * ClutterStage is not an abstract type anymore: it can be instantiated
785 using clutter_stage_new() and it can be properly subclassed. If the
786 backend supports multiple stages, every stage will be a new window,
787 whose lifetime will have to be managed by the developer. Clutter will
788 still create the default stage, and guarantees that every call to
789 clutter_stage_get_default() will return exactly the same pointer.
791 * Actors now have a new 'show-on-set-parent' property set to TRUE by
792 default. With this property set to TRUE, actors will automatically
793 have clutter_actor_show() called on them when a parent is set (i.e
794 added to a container).
796 * Clutter now features support for multiple stages assuming supported
797 by the backend. See test-multistage.c for example of usage. This
798 does not change the automatic creation of the default stage.
799 A single GL context is used across all stages meaning GL resources
802 * There is now an experimental native iPod Touch/iPhone UIKit backend
805 * There is now an experimental native Win32 WGL backend.
807 * COGL (and therefor Clutter) now optionally features initial support for
808 OpenGL ES 2.0. It features support for shaders.
810 * Some more focused timeline unit tests have been added and some tweaks to
811 timeline semantics were made; E.g. For a 10 frame timeline here are some
812 points about the semantics:
813 - When you create a timeline it starts with current_frame_num == 0
814 - After starting a timeline, the first timeout is for current_frame_num == 1
815 (Notably it isn't 0 since there is a delay before the first timeout signals
816 so re-asserting the starting frame (0) wouldn't make sense.)
817 - For a non looping timeline the last timeout would be for
818 current_frame_num == 10
819 - For a looping timeline the timeout for current_frame_num == 10 would be
820 followed by a timeout for current_frame_num == 1 and frame 0 is considered
822 - Asking for a timeline of N frames might better be described as asking for
823 a timeline of _length_ N.
825 * The behaviour of clutter_actor_get_opacity() has been slightly changed;
826 instead of returning the composited opacity of the entire parents chain
827 of an actor, clutter_actor_get_opacity() does what you mean, and returns
828 the opacity set with clutter_actor_set_opacity(). The composited
829 opacity value is now returned by clutter_actor_get_paint_opacity().
831 * Until 0.6, clutter_label_get_color() would have returned a ClutterColor
832 with the alpha component equal to the composited opacity of the label.
833 Now, clutter_label_get_color() returns a copy of the exact color set
834 with clutter_label_set_color().
836 * The ClutterEntry actor will automatically handle key events inside
837 a key-press-event handler. This deprecates the usage of
838 clutter_entry_handle_key_event() to update the contents of the
839 entry using the ClutterKeyEvent.
841 * The Clutter X11 and GLX backends feature support for wrapping external
842 X Drawables (such as windows as pixmaps) via the 'texture_from_pixmap' GLX
843 extension if available and fallback to slower XGetImage copies if not.
845 * ClutterContainer can have per child custom properties via ClutterChildMeta.
847 Release Notes for Clutter 0.6
848 -------------------------------------------------------------------------------
850 * Now that every actor has events, the class signal handlers have been
851 removed from ClutterStageClass and moved into ClutterActorClass.
853 * The CLUTTER_2BUTTON_PRESS and CLUTTER_3BUTTON_PRESS event types have been
854 removed in favour of the ClutterButtonEvent:click_count counter
856 * X11 related called for glx and eglx backends are now shared and moved into
857 a clutter_x11 prefix.
859 * Scaling with gravity functionality was replaced by more generic and
860 powerful anchor point.
862 * The ClutterLayout interface, the ClutterBox and its implementations have
863 been moved outside Clutter core.
865 * The Effects API has been simplified, and it only requires the final value
866 of the effect instead of both the start and end value.
868 * The per-axis rotation API has been deprecated in favour of a single
869 pair of accessors, clutter_actor_set_rotation() and
870 clutter_actor_get_rotation().
872 * Every actor sub-class that is overriding the ClutterActor::request_coords()
873 virtual function *must* chain up to the parent's implementation in order
874 to store the bounding box inside the ClutterActor private data.
876 * It is now impossible to call clutter_actor_destroy() on the stage. Backends
877 will have to unset the CLUTTER_ACTOR_IS_TOPLEVEL private flag to actually
880 * The default value of the ClutterLabel:wrap property has been changed from
883 * All the behaviours properties have been renamed to match the $PROPERTY-start
884 and $PROPERTY-end convention.
886 * The clutter_group_add() function has been "undeprecated" and reimplemented
887 as a commodity macro; a clutter_stage_add() commodity macro has also been
888 added. Both macros just safely wrap clutter_container_add_actor().
890 * The ClutterContainer::find_child_by_id() virtual function has been removed;
891 Clutter keeps track of every actor, so there's no need to recurse into
894 * The unused ClutterActor::set_depth() and ClutterActor::get_depth() virtual
895 functions have been removed.
897 * It is now possible to roundtrip the string created by
898 clutter_color_to_string() to clutter_color_parse().
900 * The amount of motion events is now being throttled using the default frame
901 rate setting as the base value to compute the default and maximum frequency
902 of motion events to be delivered to every actor.
904 * ClutterAngle usage has been removed from the public API: it is an internal
905 optimization, which can be used for faster angle computations; users of
906 ClutterAngle now take a fixed point number in form of a ClutterFixed.
908 * ClutterGravity usage when scaling has been superceded by the anchor point.
910 * The precision of the clutter_sqrti() algorithm has been improved for small
913 * ClutterBehaviourScale constructor, scale properties and accessors have
914 been changed to accomodate the scaling factors on both the X and Y axis,
915 matching the clutter_actor_set_scale() function. This also changed the
916 clutter_effect_scale() function, which now accepts the final scale
917 factor on both the X and Y axis. The gravity property has also been
918 removed, as it behaved incorrectly with regards to the anchor point. When
919 scaling an actor using a BehaviourScale, the anchor point should be set
920 before applying the behaviour (remember to adjust the positioning as
921 well by factoring in the anchor point).
923 * The clutter_do_event() is now public; it can be used to feed an event to
924 Clutter and let it generate the capture-bubble signal emissions; it should
925 not be used by applications.
927 * In the X11-based backends, the DestroyNotify event is not propagated to
928 Clutter core if the stage is using a foreign window.
930 * To avoid method name collisions between ClutterActor and ClutterEntry
931 in high-level languages, the clutter_entry_set_position() and
932 clutter_entry_get_position() functions have been renamed to
933 clutter_entry_set_cursor_position() and clutter_entry_get_cursor_position()
936 Release Notes for Clutter 0.4.0
937 -------------------------------------------------------------------------------
939 * clutter_actor_show_all does not recurse for groups at least (this is to
940 match the original group_show_all behaviour). This is like 0.3 but was
943 * ClutterBox API has changed: clutter_box_pack_start() and
944 clutter_box_pack_end() have been removed in favour of the clutter_box_pack()
947 * Both clutter_threads_enter() and clutter_threads_leave() have been
948 removed from the API, as they just created confusion and the wrong
949 idea that Clutter is either thread-safe or thread-aware. Full
950 thread-awareness is arriving in the next revision (see bug #429).
952 * The ClutterBehaviourRotate and ClutterBehaviourEllsipse APIs have been
955 Release Notes for Clutter 0.3.1
956 -------------------------------------------------------------------------------
958 * clutter_actor_apply_transform_to_point() parameters changed to use
961 * New 'Native API' backend expects EGL implementation to provide a
962 CreateNativeWindow() API call.
964 * Exisiting X11 based egl backend public API calls now prefixed eglx.
966 Release Notes for Clutter 0.3
967 -------------------------------------------------------------------------------
969 * ClutterTexture changes:
970 + clutter_texture_set_pixbuf() now takes a GError paremeter.
971 + clutter_texture_upload_data has been split into two new and
972 more functional versions; clutter_texture_set_from_rgb_data(),
973 clutter_texture_set_from_yuv_data().
975 * The GLX specific API has been moved to the GLX backend code and
976 it's now under the ClutterGlx namespace.
978 * The priority of the various users of the GLib main loop has been
979 reviewed and changed were necessary. Every paint is queued with a
980 priority of G_PRIORITY_DEFAULT + 10; timelines are allocated with
981 a G_PRIORITY_DEFAULT + 30 priority; events are processed with a
982 G_PRIORITY_DEFAULT priority. This ensures that events are processed
983 before the paints take place.
985 * The ClutterActor::allocate_coords() has been renamed to
986 ClutterActor::query_coords(), in order to clarify its usage.
988 * Actors overriding ClutterActor::request_coords() and
989 ClutterActor::query_coords() must convert sizes obtained from the
990 public API from pixels to ClutterUnits, using the conversion
991 macros found in clutter-units.h. The conversion will be necessary
992 until the public API will switch over to returning the generic
995 * Users of Intel video cards should find that disabling sync-to-vblank
996 is no longer necessary. In case Clutter applications take really
997 long times for redrawing and appear stuck and unresponsive, the
998 sync-to-vblank feature might still be the culprit; in that case, use
999 "export CLUTTER_VBLANK=none" to disable it and file a bug reporting the
1000 video card model, the driver version and the X server version.
1002 * ClutterTimeline objects now share the same timeout pool (see the
1003 ClutterTimeoutPool API). This might cause problems with heavily
1004 threaded libraries without integration with the GLib main loop.
1005 If an application experiences bad behaviours during animations
1006 use "export CLUTTER_TIMELINE=no-pool" to disable the timeout pool.
1008 * clutter_color_parse() now handles color definitions with alpha. Alpha
1009 will default to fully Opaque rather than fully transparent if not specified.
1011 * The Clutter examples/ directory has been removed and replaced with a
1014 * The ClutterEvent API has been changed, and specific functions have been
1015 removed in favour of event-agnostic ones.
1017 * The ClutterStage::input-event signal has been removed. All the events now
1018 emit the ClutterStage::event and ClutterStage::event-after signals, for
1019 generic event handling.
1021 * Runtime options now dependant on backend.
1023 * ClutterGroup API to add, remove and list children has been deprecated in
1024 favour of ClutterContainer API. The ClutterGroup::add and
1025 ClutterGroup::remove signals have been deprecated:
1026 ClutterContainer::actor-added and ClutterContainer::actor-removed should