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