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 On X11, Clutter depends on the following extensions
21 • XComposite ≥ @XCOMPOSITE_REQ_VERSION@
24 • XFixes ≥ @XFIXES_REQ_VERSION@
28 If you are building the API reference you will also need:
30 • GTK-Doc ≥ @GTK_DOC_REQ_VERSION@
32 If you are building the additional documentation you will also need:
35 • jw (optional, for generating PDFs)
37 If you are building the Introspection data you will also need:
39 • GObject-Introspection ≥ @GI_REQ_VERSION@
41 GObject-Introspection is available from:
43 git://git.gnome.org/gobject-introspection
45 If you want support for profiling Clutter you will also need:
47 • UProf ≥ @UPROF_REQ_VERSION@
49 UProf is available from:
51 git://github.com/rib/UProf.git
54 -------------------------------------------------------------------------------
56 The official Clutter website is:
58 http://www.clutter-project.org/
60 The API references for the latest stable release are available at:
62 http://docs.clutter-project.org/docs/clutter/stable/
63 http://docs.clutter-project.org/docs/cogl/stable/
64 http://docs.clutter-project.org/docs/cally/stable/
66 The Clutter Cookbook is available at:
68 http://docs.clutter-project.org/docs/clutter-cookbook/@CLUTTER_API_VERSION@/
70 New releases of Clutter are available at:
72 http://source.clutter-project.org/sources/clutter/
73 http://download.gnome.org/sources/clutter/
75 The Clutter blog is available at:
77 http://www.clutter-project.org/blog/
79 To subscribe to the Clutter mailing lists and read the archives, use the
80 Mailman web interface available at:
82 http://lists.clutter-project.org/
84 New bug page on Bugzilla:
86 http://bugzilla.gnome.org/enter_bug.cgi?product=clutter
88 Clutter is licensed under the terms of the GNU Lesser General Public
89 License, version 2.1 or (at your option) later.
91 BUILDING AND INSTALLATION
92 -------------------------------------------------------------------------------
94 To build Clutter from a release tarball, the usual autotool triad should
101 To build Clutter from a Git clone, run the autogen.sh script instead
102 of the configure one. The autogen.sh script will run the configure script
103 for you, unless the NOCONFIGURE environment variable is set to a non-empty
106 See also the wiki page:
108 http://wiki.clutter-project.org/wiki/BuildingClutter
110 Clutter has additional command line options for the configure script:
112 --enable-debug=[no/minimum/yes/error]
113 Controls Clutter debugging level:
116 All GLib asserts, checks and support for runtime Clutter
117 debugging notes through CLUTTER_DEBUG. This is the default
118 value for developers snapshots.
121 Just GType cast checks and support for runtime Clutter
122 debugging notes through CLUTTER_DEBUG. This is the default
126 No GLib asserts or checks and no support for runtime Clutter
127 debugging notes. Only use in extreme performance and/or size
128 optimization cases, though it is strongly discouraged.
130 --enable-maintainer-flags=[no/yes/error]
131 Use strict compiler flags. This defaults to 'yes' for building from
132 Git to 'no' for tarball releases. If 'error' is used, then -Werror
133 will be enabled (if available).
136 use gtk-doc to build API documentation (default=no). Requires gtk-doc
137 present on the target system.
139 --enable-docs=[no/yes]
140 Build additional documentation. Requires xsltproc for DocBook
141 conversion, and optionally jw for PDF generation.
143 --enable-gcov=[no/yes]
144 Build Clutter with coverage report support, provided by gcov. This
145 feature only works with the GNU Compiler Suite and gcov installed.
147 --enable-profile=[no/yes]
148 Build Clutter with profiling instrumentation. Requires the GNU
149 C Compiler and the UProf library.
151 --enable-conform=[yes/no]
152 Build the Clutter conformance test suite.
154 --enable-deprecated=[yes/no]
155 Whether deprecated symbols should be available when compiling Clutter.
158 Disable linking with -Bsymbolic.
160 --enable-x11-backend=[yes/no/check]
161 Enable the X11 backend. (default=check)
163 --enable-win32-backend=[yes/no/check]
164 Enable the native Microsoft Windows backend. (default=check)
166 --enable-quartz-backend=[yes/no/check]
167 Enable the native Quartz backend. (default=check)
169 --enable-gdk-backend=[yes/no/check]
170 Enable the GDK backend. (default=check)
172 --enable-wayland-backend=[yes/no]
173 Enable the Wayland client backend. (default=no)
175 --enable-egl-backend=[yes/no]
176 Enable the EGL framebuffer backend. (default=no)
178 --with-tslib=[yes/no]
179 Use TSLib for the input events. (default=yes)
181 --with-evdev=[yes/no]
182 Use evdev for the input events. (default=yes)
185 Use libgdl for CEx100 platforms. (default=no)
187 See also the INSTALL file generated by autotools for further information.
190 -------------------------------------------------------------------------------
192 Clutter uses the common "Linux kernel" versioning system, where
193 even-numbered minor versions are stable and odd-numbered minor
194 versions are development snapshots.
196 Different major versions break both API and ABI but are parallel
197 installable. The same major version with differing minor version is
198 expected to be ABI compatible with other minor versions; differing
199 micro versions are meant just for bug fixing. On odd minor versions
200 the newly added API might still change.
202 The micro version indicates the origin of the release: even micro
203 numbers are only used for released archives; odd micro numbers are
204 only used on the Git repository.
207 -------------------------------------------------------------------------------
209 If you want to hack on and improve Clutter check the HACKING file for
210 general implementation guidelines, and the HACKING.backends for
211 backend-specific implementation issues.
213 The CODING_STYLE file contains the rules for writing code conformant to the
214 style guidelines used throughout Clutter. Remember: the coding style is
215 mandatory; patches not conforming to it will be rejected by default.
218 -------------------------------------------------------------------------------
220 Bugs should be reported to the Clutter Bugzilla at:
222 http://bugzilla.gnome.org/enter_bug.cgi?product=clutter
224 You will need a Bugzilla account.
226 In the report you should include:
228 • what system you're running Clutter on;
229 • which version of Clutter you are using;
230 • which version of GLib and OpenGL (or OpenGL ES) you are using;
231 • which video card and which drivers you are using, including output of
232 glxinfo and xdpyinfo (if applicable);
233 • how to reproduce the bug.
235 If you cannot reproduce the bug with one of the tests that come with Clutter
236 source code, you should include a small test case displaying the bad
239 If the bug exposes a crash, the exact text printed out and a stack trace
240 obtained using gdb are greatly appreciated.
243 -------------------------------------------------------------------------------
245 Patches should be submitted using Bugzilla. Patches fixing a bug should be
246 attached to the bug report; patches for new features or for fixing bugs not
247 yet reported should be attached to a newly opened bug.
249 Patches should always be in the unified diff format, using:
251 diff -Nuarp clutter.source clutter.patched > clutter-patch.diff
253 If diffing against the Git repository, you should use:
255 git diff > clutter-patch.diff
257 Or, better: commit locally and use `git format-patch` to generate a patch
258 containing authorship details, so that members of the Clutter development
259 team can credit your contribution properly.
261 Another useful tool for interacting with Git and Bugzilla is git-bz(1):
263 http://git.fishsoup.net/man/git-bz.html
265 Which is available here:
267 http://git.fishsoup.net/cgit/git-bz/
270 -------------------------------------------------------------------------------
272 Relevant information for developers with existing Clutter applications
273 wanting to port to newer releases (see NEWS for general information on new
276 Release Notes for Clutter 1.8
277 -------------------------------------------------------------------------------
279 • Cogl has been split out of tree. Clutter depends on Cogl, so users should
280 not notice anything. Developers using pkg-config will gain an extra Cogl
283 • The clutter_actor_get_gid() and clutter_get_actor_by_gid() functions have
284 been deprecated. They should not have been public in the first place.
286 • ClutterShader and its relative API have been deprecated. ClutterShaderEffect
287 and the effect API is the proper way to use GLSL shaders with ClutterActors.
288 It is possible to instantiate a ClutterShaderEffect directly.
290 • ClutterText's paint volume has been implemented using the ink rectangle of
291 the PangoLayout used to paint, to allow culling to work properly even in
292 the case of glyphs spilling outside the logical rectangle.
294 • Non fully opaque children of a non fully opaque actor will be composited
295 in an offscreen framebuffer object to preserve the correct overall opacity.
296 This changes the way non fully opaque actors are drawn, and might cause
297 some code relying on the old, unspecified behaviour to produce different
300 • ClutterBoxLayout layout algorithm has been changed to map the more mature
301 and more stable GtkBox one.
303 • The ClutterText:editable property was incorrectly defined in the GParamSpec
304 as being TRUE by default, but it was initialized to FALSE. To avoid breaking
305 existing code, the default value inside the GParamSpec (and inside the
306 documentation) has been changed to FALSE as well.
308 • The preferred way to draw inside a ClutterCairoTexture is connecting to
309 its ::draw signal, and calling the invalidate() method. The old pattern
310 of creating the Cairo context using the create() method is deprecated but
311 still working as intended.
313 • ClutterScore has been deprecated; the preferred way to chain up multiple
314 animations is to use the ClutterAnimator or ClutterState classes.
316 Release Notes for Clutter 1.6
317 -------------------------------------------------------------------------------
319 • The internal copy of JSON-GLib has been removed: Clutter now strictly
320 depends on the installed copy of this library. The --with-json configure
321 switch has been removed.
323 • The ClutterBehaviour class and its sub-classes have been deprecated; the
324 Clutter API reference contains a migration guide to port code based on
325 behaviours to the implicit animations framework.
327 • The ClutterTimeoutPool and clutter_frame_source_* API have been deprecated;
328 both API are not integrated in the Clutter main loop, and are not used
329 internally any longer, so they are of relative use.
331 • It it not necessary any more to provide implementations for the
332 ClutterActor::map() and ClutterActor::unmap() virtual functions, even
333 for composite actors not implementing the ClutterContainer interface.
335 • ClutterTimeline now guarantees that the ::new-frame signal will be
336 emitted at the beginning of the timeline, as well as guaranteeing that
337 the ::completed signal will be emitted at the end of the timeline.
339 • ClutterActor will check for the enabled property of ClutterActorMeta
340 instances (actions, constraints and effects), and will not invoke
341 ClutterActorMeta functions on disabled instances. This removes the
342 requirement for checking the property inside the ClutterActorMeta
345 • ClutterActorBox, ClutterGeometry and ClutterVertex install a progress
346 function for ClutterInterval, allowing the interpolation of properties
347 using them as storage types.
349 • ClutterColor's clutter_color_from_string() function accepts CSS3 color
352 • The previously unused "axes" field in the ClutterButtonEvent,
353 ClutterScrollEvent and ClutterMotionEvent structures is now used on
354 the X11-based backends with XInput support.
356 • ClutterListModel will honour the filter function when calling
357 clutter_model_get_iter_at_row().
359 • ClutterClickAction does not use a pointer grab any longer, and uses
360 a capture on the stage instead.
362 • On all platforms which allow it, ClutterStage will ask the windowing
363 system for an explicit key focus when showing the stage window. This
364 can be disabled using clutter_stage_set_accept_focus().
366 Release Notes for Cogl 1.6
367 -------------------------------------------------------------------------------
369 • Cogl may internally optimise cogl_read_pixels when only a single
370 pixel is drawn and the entire scene is comprised of solid colour
371 rectangles. Instead of actually rendering the rectangles it will
372 compute the single pixel value in software. This effectively means
373 that Clutter can do software picking without any API changes.
375 • Internally Cogl now has a GLSL backend as well as the ARBfp and
376 fixed function backends. By default, this backend has the lowest
377 priority but it can be explicitly enabled by setting the
378 COGL_DEBUG environment variable, e.g.:
380 export COGL_DEBUG=disable-fixed,disable-arbfp
382 for builds of Clutter with debug support enabled.
384 • Cogl will internally now cache generated ARBfp programs so that it
385 should be able to reuse a previous program even if it was generated
386 for an unrelated CoglMaterial. This makes using one-shot materials
387 less expensive than before although it is still not recommended.
389 Release Notes for Clutter 1.4
390 -------------------------------------------------------------------------------
392 • ClutterLayoutManager sub-classes overriding the set_container() virtual
393 function should chain up to the parent class's implementation.
395 • The ClutterTexture:filename property is now readable, as well as writable;
396 this allows querying the Texture for the filename storing the image data.
397 The value will be unset when using the set_from_*_data() family of
400 • If both the :sync-size and the :keep-aspect-ratio properties of a
401 ClutterTexture are set to TRUE, then the texture actor will update its
402 ClutterActor:request-mode property depending on the orientation of the
403 image data - height-for-width for landscape, and width-for-height for
404 portrait. Square image data will default to height-for-width, like all
405 actors. You can still explicitly override the :request-mode value, or
406 you can unset the :sync-size property to control the size yourself.
408 • All the key symbol macros have been renamed from CLUTTER_* to
409 CLUTTER_KEY_*. The old names are still available inside the
410 clutter-keysyms-compat.h header, which is included by clutter-keysyms.h
411 unless CLUTTER_DISABLE_DEPRECATED is defined.
413 • The internal copy of json-glib is now deprecated. Building Clutter will
414 default to the system copy and requires an explicit --with-json=internal
415 to override the check.
417 Release Notes for Clutter 1.2
418 -------------------------------------------------------------------------------
420 * ClutterStageManager is now publicly available and documented API.
422 * Clutter now depends on the system copy of JSON-GLib, and will fall
423 back to the internal copy only if JSON-GLib is not installed.
425 * ClutterActor:opacity is now defined using GParamSpecUint instead of
426 GParamSpecUchar; the same interval of [ 0, 255 ] applies, and GValue
427 has internal transformation functions for converting between G_TYPE_UINT
428 and G_TYPE_UCHAR, so this change should be fully transparent to the
431 * On X11 Clutter will emulate XKB's detectable key auto-repeat; this means
432 that when holding down a key, Clutter will emit multiple CLUTTER_KEY_PRESS
433 events and a single CLUTTER_KEY_RELEASE event instead of a list of
434 CLUTTER_KEY_PRESS and CLUTTER_KEY_RELEASE pairs.
436 * On X11 and Win32 the default Stage is created when
437 clutter_stage_get_default() is called for the first time, and not as
438 part of the stage initialization.
440 Cogl API changes for Clutter 1.2
441 -------------------------------------------------------------------------------
443 * cogl_viewport is now deprecated in favour of cogl_set_viewport which
444 accepts a viewport offset.
446 * cogl_clip_push() is now deprecated and new code should use
447 cogl_clip_push_rectangle() instead. The old API wasn't consistent with other
448 Cogl APIs that specify model space rectangles using (x0,y0)(x1,y1) pairs.
450 * cogl_clip_push_window_rect() is now deprecated and new code should use
451 cogl_clip_push_window_rectangle(). The old API shouldn't have been defined
452 to take floats and the abbreviation wasn't consistent with other Cogl API.
454 * cogl_clip_stack_save() and cogl_clip_stack_restore() are deprecated, as
455 the functionality is redundant now that offscreen draw buffers own their
456 clip state and switching to/from offscreen rendering will automatically
457 save and restore the clip state.
459 * cogl_material_copy() was added. It is advised that developers use
460 this instead of cogl_material_new() when creating a material that is in some
461 way derived from another. This will allow Cogl to track material
462 ancestries/similarities and reduce the cost of GPU state changes.
464 * cogl_push_draw_buffer, cogl_set_draw_buffer and cogl_pop_draw_buffer are now
465 deprecated and new code should use the cogl_framebuffer_* API instead.
466 Code that previously did:
467 cogl_push_draw_buffer ();
468 cogl_set_draw_buffer (COGL_OFFSCREEN_BUFFER, buffer);
470 cogl_pop_draw_buffer ();
471 can now be re-written as:
472 cogl_push_framebuffer (buffer);
474 cogl_pop_framebuffer ();
476 * All cogl_<type>_ref() and cogl_<type>_unref() functions have been
477 deprecated, and superceded by cogl_handle_ref() and cogl_handle_unref()
480 * The cogl_check_extension() function has been deprecated. This function
481 was never meant to be public, since it depends on calling glGetString()
482 before its invocation. Users of this function can be replaced by the
485 gl_ext = glGetString (GL_EXTENSIONS);
486 - has_ext = cogl_check_extension (ext_name, gl_ext);
487 + has_ext = strstr (gl_ext, ext_name) != NULL ? TRUE : FALSE;
489 Release Notes for Clutter 1.0
490 -------------------------------------------------------------------------------
492 * The clutter_actor_set_shader_param() function now takes a
493 GValue, which can be set using the clutter_value_set_shader()
494 family of functions. The floating point wrapper has been
495 rename clutter_actor_set_shader_param_float() to match the newly
496 added clutter_actor_set_shader_param_int().
498 * The Pango renderer API has been exposed as public API, after
499 a full rename from PangoClutter to CoglPango, to avoid namespace
500 collisions with upstream Pango. The Pango font map, renderer and
501 glyph cache can be used by third party code and depend only on
504 * Both Clutter and COGL only allow including <clutter/clutter.h>
505 and <cogl/cogl.h> directly, respectively. This allows avoiding
506 breaking API every time a type definition is moved across
507 headers, and improves the reliability of third party code against
508 internal refactorings.
510 * COGL has an internal Color type, used to store a color definition
511 that can be efficiently used with the least amount of conversions
512 by both the GL and GLES implementations. The COGL API has been
513 changed to drop the usage of ClutterColor in favour of CoglColor.
515 * The fixed point API implementation Clutter uses internally has been
516 moved from the Clutter namespace to the COGL one.
518 * ClutterLabel and ClutterEntry have been removed from the API, as
519 both have been superceded by the ClutterText actor.
521 * ClutterCloneTexture has been removed from the API; in its place,
522 there is a generic ClutterClone actor which allows to "clone"
523 any existing actors -- even composite ones -- without using
524 frame buffer objects (FBOs).
526 * The ClutterEffectTemplate and clutter_effect_* functions have been
527 superceded by ClutterAnimation and thus removed from the public API.
529 * The ClutterBehaviourBspline has been superceded by the usage of
530 ClutterPath inside ClutterBehaviourPath, and thus removed from the
533 * ClutterColor API has received a much needed review to increase its
534 consistency. This has led to the following changes:
536 - clutter_color_parse() has been renamed to clutter_color_from_string()
537 and the order of the arguments has been changed
539 - the factor argument of clutter_color_shade() has been swapped with
540 the return location for the new color
542 - the fixed point entry points have been removed
544 - clutter_color_from_hls() and clutter_color_to_hls() do not
545 normalize the values in the [ 0, 255 ] interval but use the
546 correct HLS intervals:
552 * The ClutterFixed symbols have been completely removed: fixed-point
553 public entry points now take a CoglFixed.
555 * The -x and -u API have been removed. All the pixel-based API now
556 takes a float to allow sub-pixel precision; this is true also for
557 properties. WARNING: functions with variadic arguments (like
558 g_object_set(), g_object_get() and clutter_actor_animate()) do not
559 behave very well when dealing with integers instead of expected
560 floating point values, and vice versa. On 32bit machines it will
561 most likely lead to a crash. So:
563 g_object_set (actor, "width", 100, NULL);
565 is incorrect, and should be changed in:
567 g_object_set (actor, "width", 100.0, NULL);
569 * Composite actors that do not implement the Container interface
570 should implement the following virtual functions:
572 - void map (ClutterActor*)
573 - void unmap (ClutterActor*)
575 and chain up to the parent's implementation after calling
576 clutter_actor_map() or clutter_actor_unmap() on their children.
578 * Actors implementing the Container interface that have private
579 children that are not meant to be added/removed through the
580 Container API should implement the:
582 - void foreach_with_internals (ClutterContainer*,
588 * Actors that perform direct transformations using the COGL API inside
589 their paint() implementation should override the apply_transform()
590 virtual function instead. Implementations of the apply_transform()
591 vfunc must chain up to the implementation of the parent class.
593 * The ClutterUnit type and the CLUTTER_UNITS_* conversion macros have
594 been removed: all Actors are now using sub-pixel precision directly
595 throughout the API. The new ClutterUnits type has been added as a
596 generic opaque storage for logical distance values.
598 * Timelines are now fully time-based: all the frame-related properties
599 and methods have been removed. ClutterTimeline::new-frame will provide
600 the elapsed milliseconds since the beginning of the Timeline, instead
601 of the current frame number. The clutter_timeline_new() constructor
602 takes the duration of the timeline in milliseconds, and thus it replaces
603 the clutter_timeline_new_for_duration() variant.
605 Cogl API changes for Clutter 1.0
606 -------------------------------------------------------------------------------
608 * All drawing functions now use a source material to determine how geometry is
609 filled. The source material is set via cogl_set_source. Or the convenience
610 functions cogl_set_source_color and cogl_set_source_texture.
612 "drawing functions" include: cogl_rectangle, cogl_texture_rectangle,
613 cogl_texture_multiple_rectangles, cogl_texture_polygon (though the
614 cogl_texture_* funcs have been renamed; see below for details),
615 cogl_path_fill/stroke and cogl_vertex_buffer_draw*.
617 cogl_texture_rectangle, cogl_texture_multiple_rectangles and
618 cogl_texture_polygon no longer take a texture handle; instead the current
619 source material is referenced. The functions have also been renamed to:
620 cogl_rectangle_with_texture_coords, cogl_rectangles_with_texture_coords
621 and cogl_polygon respectively.
623 Most code that previously did:
624 cogl_texture_rectangle (tex_handle, x, y,...);
625 needs to be changed to now do:
626 cogl_set_source_texture (tex_handle);
627 cogl_rectangle_with_texture_coords (x, y,....);
629 In the less likely case where you were blending your source texture with a
631 cogl_set_source_color4ub (r,g,b,a); /* (where r,g,b,a isn't just white) */
632 cogl_texture_rectangle (tex_handle, x, y,...);
633 you will need your own material to do that:
634 material = cogl_material_new ();
635 cogl_material_set_color4ub (r,g,b,a);
636 cogl_material_set_layer (material, 0, tex_handle));
637 cogl_set_source_material (material);
639 Code that uses the texture coordinates, 0, 0, 1, 1 don't need to use
640 cogl_rectangle_with_texture_coords since these are the coordinates that
641 cogl_rectangle will use.
643 For cogl_texture_polygon; as well as dropping the texture handle, the
644 n_vertices and vertices arguments were transposed for consistency. So
645 code previously written as:
646 cogl_texture_polygon (tex_handle, 3, verts, TRUE);
647 need to be written as:
648 cogl_set_source_texture (tex_handle);
649 cogl_polygon (verts, 3, TRUE);
651 * The arguments to cogl_rectangle, cogl_path_rectangle and
652 cogl_path_round_rectangle have been changed - for consistency - from
653 x, y, width, height, to x1, y1, x2, y2.
655 * A CoglMatrix type and utility API has been added; this is currently used to
656 support describing texture matrices.
658 * cogl_alpha_func has been removed, since this is now controlled using the
659 material API via cogl_material_set_alpha_test_function ()
661 * A Cogl Vertex Buffer API has been added that allows you to efficiently
662 manage arrays of vertex attributes in buffers that may be stored on
663 the GPU. These allow you to avoid the costs of repeatedy validating
664 vertex data and mapping it into the GPU.
666 * cogl_scale now supports scaling on the z axis
668 * cogl_clip_set* and cogl_clip_unset have been renamed to cogl_clip_push and
669 cogl_clip_pop respectively so they self document their stacking semantics.
671 * cogl_paint_init was renamed to cogl_clear and no longer disables lighting and
672 fogging. cogl_clear also now takes a mask of the auxiliary buffers you want
673 to clear so you can avoid redundant clears of buffers you aren't using.
675 * cogl_fog_set was renamed to cogl_set_fog and it now takes a mode argument
676 giving control over the fogging blend factor equation, so that the
677 density argument isn't just ignored. A cogl_disable_fog function was
680 * cogl_get_*_matrix were changed to use the CoglMatrix type instead of
681 GLfloat m[16] arrays.
683 * cogl_offscreen_blit_region, cogl_offscreen_blit were removed since they were
684 only implemnted for GL, not GLES, and it was assumed no one was using them.
686 * cogl_offscreen_new_multisample was removed since it only ever returned
687 COGL_INVALID_HANDLE so it wasn't usefull.
689 * The COGL_MASK_BUFFER type was removed, since there should be nicer ways of
690 exposing color mask if anyone wants it later. It was assumed that no one was
691 using this currently.
693 * COGLenum, COGLint and COGLuint which were simply typedefs for
694 GL{enum,int,uint} have been removed from the API and replaced with
695 specialised enum typedefs, int and unsigned int. These were causing
696 problems for generating bindings and also considered poor style.
698 * The cogl texture filter defines CGL_NEAREST and CGL_LINEAR etc are now
699 replaced by a namespaced typedef 'CoglTextureFilter' so they should be
700 replaced with COGL_TEXTURE_FILTER_NEAREST and COGL_TEXTURE_FILTER_LINEAR etc.
702 * The shader type defines CGL_VERTEX_SHADER and CGL_FRAGMENT_SHADER are handled
703 by a CoglShaderType typedef and should be replaced with
704 COGL_SHADER_TYPE_VERTEX and COGL_SHADER_TYPE_FRAGMENT.
706 * cogl_shader_get_parameteriv has been replaced by cogl_shader_get_type and
707 cogl_shader_is_compiled. More getters can be added later if desired.
709 * cogl_enable_depth_test has been renamed to cogl_set_depth_test_enabled and
710 a corresponding cogl_get_depth_test_enabled function has been added.
712 Release Notes for Clutter 0.8
713 -------------------------------------------------------------------------------
715 * The COGL GL wrapper API has been completely overhauled and now
716 contains many new features including new greatly improved texture
717 abstractions (slicing, mipmapping, deformations etc, greatly
718 simplifying ClutterTexture), image loading and abstraction, path
719 based primitive drawing, clipping, and improved FBO and shader
720 support. It is now also fully documented.
722 * GL Texture Rectangle ext is no longer used, the regular 2D NPOTS
723 extension is preffered instead but not required.
725 * Clutter now has basic suppport for multiple input devices assuming
726 the backend supports it (currently X11 based via XInput and Fruity
727 backends). New API supporting this includes
728 clutter_event_get_device_id, clutter_get_input_device_for_id,
729 clutter_grab_pointer_for_device & clutter_ungrab_pointer_for_device.
731 XInput support needs to be explicitly enabled at runtime by calling
732 clutter_x11_enable_xinput () before clutter_init. clutter_x11_has_xinput ()
733 can then be called after to check if XInput extension present and use-able.
735 * The functions that return the transformed position of an actor have
736 been renamed to be more explicit about it:
738 clutter_actor_get_abs_position - clutter_actor_get_transformed_position
739 clutter_actor_get_abs_size - clutter_actor_get_transformed_size
741 Their behaviour has not been changed.
743 * To increase portability, Clutter does not strictly depend on
744 GdkPixbuf anymore; this means that you will have to include
745 <gdk-pixbuf/gdk-pixbuf.h> yourself if you are operating with
746 GdkPixbuf objects and not including that header. The GdkPixbuf-based
747 API has been removed from Clutter core:
749 clutter_texture_new_from_pixbuf
750 clutter_texture_set_pixbuf
751 clutter_texture_get_pixbuf
753 are all deprecated functions. It is still possible to load a GdkPixbuf
754 into a ClutterTexture with this sample code:
756 clutter_texture_set_from_rgb_data (texture,
757 gdk_pixbuf_get_pixels (pixbuf),
758 gdk_pixbuf_get_has_alpha (pixbuf),
759 gdk_pixbuf_get_width (pixbuf),
760 gdk_pixbuf_get_height (pixbuf),
761 gdk_pixbuf_get_rowstride (pixbuf),
762 gdk_pixbuf_get_has_alpha (pixbuf) ? 4
767 ClutterTexture also now has a new filename property and
768 clutter_texture_new_from_file which is intended as an alternate to
769 common previous GdkPixbuf primary usage (i.e loading images from
772 To read texture data back into a pixbuf or system memory use a combination
773 of clutter_texture_get_cogl_texture & cogl_texture_get_data.
775 The clutter-gtk integration library has API for using GdkPixbuf with
776 ClutterTextures (among others).
778 ClutterTexture now supports a keep-aspect property which is set to FALSE
781 * clutter_texture_from_actor will now reparent source actors if they
782 are not parented. This behaviour may change in future releases.
783 There are known not yet fixed issues with source actors that set
784 depth or use clipping.
786 * The size negotiation API has been completely changed in order to allow
787 the creation of non-fixed layout managers. These functions have been
790 clutter_actor_request_coords()
791 clutter_actor_query_coords()
793 from the ClutterActor API, as well as their virtual functions inside
794 the ClutterActorClass. The size of an actor is now split into two
795 different concepts: the preferred size (width and height
796 separatedly) and the size that has been allocated by the container
797 to which that actor belongs. Clutter still defaults to the fixed
798 layout management (i.e ClutterGroup) of the actors, but supports
799 fluid layout managers written using the new API.
801 Composite actors (actors with 'private' children not implementing the
802 container interface) now need to implement an allocate method here pass
803 an allocation to any composite children.
805 * Clutter now depends on PangoCairo for the font rendering. The PangoClutter
806 API is still considered semi-private and no guarantees are made on its
809 * ClutterShader API has been slightly changed: the ClutterStage:bound
810 property, clutter_shader_bind() and clutter_shader_is_bound() have
811 been renamed to :compiled, clutter_shader_compile() and
812 clutter_shader_is_compiled(), respectively. The previously semi-private
813 clutter_shader_release_all() function is now not exported anymore.
815 * ClutterStage is not an abstract type anymore: it can be instantiated
816 using clutter_stage_new() and it can be properly subclassed. If the
817 backend supports multiple stages, every stage will be a new window,
818 whose lifetime will have to be managed by the developer. Clutter will
819 still create the default stage, and guarantees that every call to
820 clutter_stage_get_default() will return exactly the same pointer.
822 * Actors now have a new 'show-on-set-parent' property set to TRUE by
823 default. With this property set to TRUE, actors will automatically
824 have clutter_actor_show() called on them when a parent is set (i.e
825 added to a container).
827 * Clutter now features support for multiple stages assuming supported
828 by the backend. See test-multistage.c for example of usage. This
829 does not change the automatic creation of the default stage.
830 A single GL context is used across all stages meaning GL resources
833 * There is now an experimental native iPod Touch/iPhone UIKit backend
836 * There is now an experimental native Win32 WGL backend.
838 * COGL (and therefor Clutter) now optionally features initial support for
839 OpenGL ES 2.0. It features support for shaders.
841 * Some more focused timeline unit tests have been added and some tweaks to
842 timeline semantics were made; E.g. For a 10 frame timeline here are some
843 points about the semantics:
844 - When you create a timeline it starts with current_frame_num == 0
845 - After starting a timeline, the first timeout is for current_frame_num == 1
846 (Notably it isn't 0 since there is a delay before the first timeout signals
847 so re-asserting the starting frame (0) wouldn't make sense.)
848 - For a non looping timeline the last timeout would be for
849 current_frame_num == 10
850 - For a looping timeline the timeout for current_frame_num == 10 would be
851 followed by a timeout for current_frame_num == 1 and frame 0 is considered
853 - Asking for a timeline of N frames might better be described as asking for
854 a timeline of _length_ N.
856 * The behaviour of clutter_actor_get_opacity() has been slightly changed;
857 instead of returning the composited opacity of the entire parents chain
858 of an actor, clutter_actor_get_opacity() does what you mean, and returns
859 the opacity set with clutter_actor_set_opacity(). The composited
860 opacity value is now returned by clutter_actor_get_paint_opacity().
862 * Until 0.6, clutter_label_get_color() would have returned a ClutterColor
863 with the alpha component equal to the composited opacity of the label.
864 Now, clutter_label_get_color() returns a copy of the exact color set
865 with clutter_label_set_color().
867 * The ClutterEntry actor will automatically handle key events inside
868 a key-press-event handler. This deprecates the usage of
869 clutter_entry_handle_key_event() to update the contents of the
870 entry using the ClutterKeyEvent.
872 * The Clutter X11 and GLX backends feature support for wrapping external
873 X Drawables (such as windows as pixmaps) via the 'texture_from_pixmap' GLX
874 extension if available and fallback to slower XGetImage copies if not.
876 * ClutterContainer can have per child custom properties via ClutterChildMeta.
878 Release Notes for Clutter 0.6
879 -------------------------------------------------------------------------------
881 * Now that every actor has events, the class signal handlers have been
882 removed from ClutterStageClass and moved into ClutterActorClass.
884 * The CLUTTER_2BUTTON_PRESS and CLUTTER_3BUTTON_PRESS event types have been
885 removed in favour of the ClutterButtonEvent:click_count counter
887 * X11 related called for glx and eglx backends are now shared and moved into
888 a clutter_x11 prefix.
890 * Scaling with gravity functionality was replaced by more generic and
891 powerful anchor point.
893 * The ClutterLayout interface, the ClutterBox and its implementations have
894 been moved outside Clutter core.
896 * The Effects API has been simplified, and it only requires the final value
897 of the effect instead of both the start and end value.
899 * The per-axis rotation API has been deprecated in favour of a single
900 pair of accessors, clutter_actor_set_rotation() and
901 clutter_actor_get_rotation().
903 * Every actor sub-class that is overriding the ClutterActor::request_coords()
904 virtual function *must* chain up to the parent's implementation in order
905 to store the bounding box inside the ClutterActor private data.
907 * It is now impossible to call clutter_actor_destroy() on the stage. Backends
908 will have to unset the CLUTTER_ACTOR_IS_TOPLEVEL private flag to actually
911 * The default value of the ClutterLabel:wrap property has been changed from
914 * All the behaviours properties have been renamed to match the $PROPERTY-start
915 and $PROPERTY-end convention.
917 * The clutter_group_add() function has been "undeprecated" and reimplemented
918 as a commodity macro; a clutter_stage_add() commodity macro has also been
919 added. Both macros just safely wrap clutter_container_add_actor().
921 * The ClutterContainer::find_child_by_id() virtual function has been removed;
922 Clutter keeps track of every actor, so there's no need to recurse into
925 * The unused ClutterActor::set_depth() and ClutterActor::get_depth() virtual
926 functions have been removed.
928 * It is now possible to roundtrip the string created by
929 clutter_color_to_string() to clutter_color_parse().
931 * The amount of motion events is now being throttled using the default frame
932 rate setting as the base value to compute the default and maximum frequency
933 of motion events to be delivered to every actor.
935 * ClutterAngle usage has been removed from the public API: it is an internal
936 optimization, which can be used for faster angle computations; users of
937 ClutterAngle now take a fixed point number in form of a ClutterFixed.
939 * ClutterGravity usage when scaling has been superceded by the anchor point.
941 * The precision of the clutter_sqrti() algorithm has been improved for small
944 * ClutterBehaviourScale constructor, scale properties and accessors have
945 been changed to accomodate the scaling factors on both the X and Y axis,
946 matching the clutter_actor_set_scale() function. This also changed the
947 clutter_effect_scale() function, which now accepts the final scale
948 factor on both the X and Y axis. The gravity property has also been
949 removed, as it behaved incorrectly with regards to the anchor point. When
950 scaling an actor using a BehaviourScale, the anchor point should be set
951 before applying the behaviour (remember to adjust the positioning as
952 well by factoring in the anchor point).
954 * The clutter_do_event() is now public; it can be used to feed an event to
955 Clutter and let it generate the capture-bubble signal emissions; it should
956 not be used by applications.
958 * In the X11-based backends, the DestroyNotify event is not propagated to
959 Clutter core if the stage is using a foreign window.
961 * To avoid method name collisions between ClutterActor and ClutterEntry
962 in high-level languages, the clutter_entry_set_position() and
963 clutter_entry_get_position() functions have been renamed to
964 clutter_entry_set_cursor_position() and clutter_entry_get_cursor_position()
967 Release Notes for Clutter 0.4.0
968 -------------------------------------------------------------------------------
970 * clutter_actor_show_all does not recurse for groups at least (this is to
971 match the original group_show_all behaviour). This is like 0.3 but was
974 * ClutterBox API has changed: clutter_box_pack_start() and
975 clutter_box_pack_end() have been removed in favour of the clutter_box_pack()
978 * Both clutter_threads_enter() and clutter_threads_leave() have been
979 removed from the API, as they just created confusion and the wrong
980 idea that Clutter is either thread-safe or thread-aware. Full
981 thread-awareness is arriving in the next revision (see bug #429).
983 * The ClutterBehaviourRotate and ClutterBehaviourEllsipse APIs have been
986 Release Notes for Clutter 0.3.1
987 -------------------------------------------------------------------------------
989 * clutter_actor_apply_transform_to_point() parameters changed to use
992 * New 'Native API' backend expects EGL implementation to provide a
993 CreateNativeWindow() API call.
995 * Exisiting X11 based egl backend public API calls now prefixed eglx.
997 Release Notes for Clutter 0.3
998 -------------------------------------------------------------------------------
1000 * ClutterTexture changes:
1001 + clutter_texture_set_pixbuf() now takes a GError paremeter.
1002 + clutter_texture_upload_data has been split into two new and
1003 more functional versions; clutter_texture_set_from_rgb_data(),
1004 clutter_texture_set_from_yuv_data().
1006 * The GLX specific API has been moved to the GLX backend code and
1007 it's now under the ClutterGlx namespace.
1009 * The priority of the various users of the GLib main loop has been
1010 reviewed and changed were necessary. Every paint is queued with a
1011 priority of G_PRIORITY_DEFAULT + 10; timelines are allocated with
1012 a G_PRIORITY_DEFAULT + 30 priority; events are processed with a
1013 G_PRIORITY_DEFAULT priority. This ensures that events are processed
1014 before the paints take place.
1016 * The ClutterActor::allocate_coords() has been renamed to
1017 ClutterActor::query_coords(), in order to clarify its usage.
1019 * Actors overriding ClutterActor::request_coords() and
1020 ClutterActor::query_coords() must convert sizes obtained from the
1021 public API from pixels to ClutterUnits, using the conversion
1022 macros found in clutter-units.h. The conversion will be necessary
1023 until the public API will switch over to returning the generic
1026 * Users of Intel video cards should find that disabling sync-to-vblank
1027 is no longer necessary. In case Clutter applications take really
1028 long times for redrawing and appear stuck and unresponsive, the
1029 sync-to-vblank feature might still be the culprit; in that case, use
1030 "export CLUTTER_VBLANK=none" to disable it and file a bug reporting the
1031 video card model, the driver version and the X server version.
1033 * ClutterTimeline objects now share the same timeout pool (see the
1034 ClutterTimeoutPool API). This might cause problems with heavily
1035 threaded libraries without integration with the GLib main loop.
1036 If an application experiences bad behaviours during animations
1037 use "export CLUTTER_TIMELINE=no-pool" to disable the timeout pool.
1039 * clutter_color_parse() now handles color definitions with alpha. Alpha
1040 will default to fully Opaque rather than fully transparent if not specified.
1042 * The Clutter examples/ directory has been removed and replaced with a
1045 * The ClutterEvent API has been changed, and specific functions have been
1046 removed in favour of event-agnostic ones.
1048 * The ClutterStage::input-event signal has been removed. All the events now
1049 emit the ClutterStage::event and ClutterStage::event-after signals, for
1050 generic event handling.
1052 * Runtime options now dependant on backend.
1054 * ClutterGroup API to add, remove and list children has been deprecated in
1055 favour of ClutterContainer API. The ClutterGroup::add and
1056 ClutterGroup::remove signals have been deprecated:
1057 ClutterContainer::actor-added and ClutterContainer::actor-removed should