From e30df678ae579ed31cb34f957f251379eea792fc Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 7 Jun 2007 15:28:59 +0000 Subject: [PATCH] 2007-06-07 Emmanuele Bassi * clutter/*: Move documentation from the templates into the source code. --- ChangeLog | 5 + clutter/clutter-event.c | 7 + clutter/clutter-feature.c | 2 +- clutter/clutter-fixed.c | 34 + clutter/clutter-fixed.h | 32 +- doc/reference/ChangeLog | 9 +- doc/reference/clutter-sections.txt | 10 +- doc/reference/tmpl/clutter-actor.sgml | 686 ------------------ doc/reference/tmpl/clutter-alpha.sgml | 295 -------- doc/reference/tmpl/clutter-backend.sgml | 96 --- .../tmpl/clutter-behaviour-bspline.sgml | 140 ---- .../tmpl/clutter-behaviour-ellipse.sgml | 194 ----- .../tmpl/clutter-behaviour-opacity.sgml | 54 -- .../tmpl/clutter-behaviour-path.sgml | 152 ---- .../tmpl/clutter-behaviour-rotate.sgml | 152 ---- .../tmpl/clutter-behaviour-scale.sgml | 117 --- doc/reference/tmpl/clutter-behaviour.sgml | 143 ---- doc/reference/tmpl/clutter-clone-texture.sgml | 68 -- doc/reference/tmpl/clutter-color.sgml | 173 ----- doc/reference/tmpl/clutter-entry.sgml | 324 --------- doc/reference/tmpl/clutter-event.sgml | 311 -------- doc/reference/tmpl/clutter-feature.sgml | 46 -- doc/reference/tmpl/clutter-fixed.sgml | 325 --------- doc/reference/tmpl/clutter-glx.sgml | 86 --- doc/reference/tmpl/clutter-group.sgml | 158 ---- doc/reference/tmpl/clutter-keysyms.sgml | 19 - doc/reference/tmpl/clutter-label.sgml | 276 ------- doc/reference/tmpl/clutter-main.sgml | 128 ---- doc/reference/tmpl/clutter-marshal.sgml | 19 - doc/reference/tmpl/clutter-media.sgml | 203 ------ doc/reference/tmpl/clutter-rectangle.sgml | 127 ---- doc/reference/tmpl/clutter-stage.sgml | 268 ------- doc/reference/tmpl/clutter-texture.sgml | 209 ------ doc/reference/tmpl/clutter-timeline.sgml | 249 ------- doc/reference/tmpl/clutter-units.sgml | 118 --- doc/reference/tmpl/clutter-util.sgml | 28 - doc/reference/tmpl/clutter-version.sgml | 80 -- 37 files changed, 78 insertions(+), 5265 deletions(-) delete mode 100644 doc/reference/tmpl/clutter-actor.sgml delete mode 100644 doc/reference/tmpl/clutter-alpha.sgml delete mode 100644 doc/reference/tmpl/clutter-backend.sgml delete mode 100644 doc/reference/tmpl/clutter-behaviour-bspline.sgml delete mode 100644 doc/reference/tmpl/clutter-behaviour-ellipse.sgml delete mode 100644 doc/reference/tmpl/clutter-behaviour-opacity.sgml delete mode 100644 doc/reference/tmpl/clutter-behaviour-path.sgml delete mode 100644 doc/reference/tmpl/clutter-behaviour-rotate.sgml delete mode 100644 doc/reference/tmpl/clutter-behaviour-scale.sgml delete mode 100644 doc/reference/tmpl/clutter-behaviour.sgml delete mode 100644 doc/reference/tmpl/clutter-clone-texture.sgml delete mode 100644 doc/reference/tmpl/clutter-color.sgml delete mode 100644 doc/reference/tmpl/clutter-entry.sgml delete mode 100644 doc/reference/tmpl/clutter-event.sgml delete mode 100644 doc/reference/tmpl/clutter-feature.sgml delete mode 100644 doc/reference/tmpl/clutter-fixed.sgml delete mode 100644 doc/reference/tmpl/clutter-glx.sgml delete mode 100644 doc/reference/tmpl/clutter-group.sgml delete mode 100644 doc/reference/tmpl/clutter-keysyms.sgml delete mode 100644 doc/reference/tmpl/clutter-label.sgml delete mode 100644 doc/reference/tmpl/clutter-main.sgml delete mode 100644 doc/reference/tmpl/clutter-marshal.sgml delete mode 100644 doc/reference/tmpl/clutter-media.sgml delete mode 100644 doc/reference/tmpl/clutter-rectangle.sgml delete mode 100644 doc/reference/tmpl/clutter-stage.sgml delete mode 100644 doc/reference/tmpl/clutter-texture.sgml delete mode 100644 doc/reference/tmpl/clutter-timeline.sgml delete mode 100644 doc/reference/tmpl/clutter-units.sgml delete mode 100644 doc/reference/tmpl/clutter-util.sgml delete mode 100644 doc/reference/tmpl/clutter-version.sgml diff --git a/ChangeLog b/ChangeLog index 9be27d347..9bcac352e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2007-06-07 Emmanuele Bassi + + * clutter/*: Move documentation from the templates into the + source code. + 2007-06-07 Emmanuele Bassi * clutter/clutter-container.[ch]: Add a generic actor container diff --git a/clutter/clutter-event.c b/clutter/clutter-event.c index 1a47482d7..f57992726 100644 --- a/clutter/clutter-event.c +++ b/clutter/clutter-event.c @@ -32,6 +32,13 @@ #include "clutter-private.h" #include "clutter-debug.h" +/** + * SECTION:clutter-event + * @short_description: User and window system events + * + * Windowing events handled by Clutter. + */ + /* multiple button click detection */ static guint32 button_click_time[2] = {0, 0}; static guint32 button_number[2] = {0, -1}; diff --git a/clutter/clutter-feature.c b/clutter/clutter-feature.c index 387ea18c7..75e83b6f6 100644 --- a/clutter/clutter-feature.c +++ b/clutter/clutter-feature.c @@ -25,7 +25,7 @@ /** * SECTION:clutter-feature - * @short_description: functions to query available GL features ay runtime + * @short_description: Query GL features at runtime * * Functions to query available GL features ay runtime */ diff --git a/clutter/clutter-fixed.c b/clutter/clutter-fixed.c index 622545458..884088d0f 100644 --- a/clutter/clutter-fixed.c +++ b/clutter/clutter-fixed.c @@ -23,8 +23,42 @@ * Boston, MA 02111-1307, USA. */ +#include "config.h" + #include +/** + * SECTION:clutter-fixed + * @short_description: Fixed Point API + * + * Clutter has a fixed point API targeted at platforms without a floating + * point unit, such as embedded devices. This API should be preferred to + * the floating point one as it does not trigger the slow path of software + * emulation, relying on integer math for fixed-to-floating and + * floating-to-fixed conversion. + * + * Basic rules of Fixed Point arithmethic: + * + * + * + * Two fixed point numbers can be directly added and + * subtracted. + * + * + * To add other numerical type to a fixed point number it has to + * be first converted to fixed point. + * + * + * A fixed point number can be directly multiplied or divided by + * an integer. + * + * + * Two fixed point numbers can only be multiplied and divided by the + * provided #CLUTTER_FIXED_MUL and #CLUTTER_FIXED_DIV macros. + * + * + */ + /* pre-computed sin table for 1st quadrant * * Currently contains 257 entries. diff --git a/clutter/clutter-fixed.h b/clutter/clutter-fixed.h index a41707a81..70fb6cced 100644 --- a/clutter/clutter-fixed.h +++ b/clutter/clutter-fixed.h @@ -46,12 +46,10 @@ typedef gint32 ClutterFixed; */ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */ -#define CLUTTER_ANGLE_FROM_DEG(x) CLUTTER_FLOAT_TO_INT((x*1024.0)/360.0) - -#define CLUTTER_ANGLE_FROM_DEGF(x) CLUTTER_FLOAT_TO_INT(((float)x*1024.0f)/360.0f) -#define CLUTTER_ANGLE_TO_DEGF(x) (((float)x * 360.0)/ 1024.0) - -#define CLUTTER_ANGLE_FROM_DEGX(x) CFX_INT(((x/360)*1024) + CFX_HALF) +#define CLUTTER_ANGLE_FROM_DEG(x) (CLUTTER_FLOAT_TO_INT ((x * 1024.0) / 360.0)) +#define CLUTTER_ANGLE_FROM_DEGF(x) (CLUTTER_FLOAT_TO_INT (((float)x * 1024.0f) / 360.0f)) +#define CLUTTER_ANGLE_TO_DEGF(x) (((float)x * 360.0)/ 1024.0) +#define CLUTTER_ANGLE_FROM_DEGX(x) (CFX_INT(((x/360)*1024) + CFX_HALF)) #define CFX_Q 16 /* Decimal part size in bits */ #define CFX_ONE (1 << CFX_Q) /* 1 */ @@ -127,26 +125,24 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */ #define CLUTTER_FIXED_TO_FLOAT(x) ((float) ((int)(x) / 65536.0)) #define CLUTTER_FIXED_TO_DOUBLE(x) ((double) ((int)(x) / 65536.0)) -#define CLUTTER_FLOAT_TO_FIXED(x) _clutter_double_to_fixed((x)) -#define CLUTTER_FLOAT_TO_INT(x) _clutter_double_to_int((x)) - -#define CLUTTER_INT_TO_FIXED(x) ((x) << CFX_Q) +#define CLUTTER_FLOAT_TO_FIXED(x) (_clutter_double_to_fixed ((x))) +#define CLUTTER_FLOAT_TO_INT(x) (_clutter_double_to_int ((x))) +#define CLUTTER_INT_TO_FIXED(x) ((x) << CFX_Q) #define CLUTTER_FIXED_INT(x) ((x) >> CFX_Q) #define CLUTTER_FIXED_FRACTION(x) ((x) & ((1 << CFX_Q) - 1)) - #define CLUTTER_FIXED_FLOOR(x) (((x) >= 0) ? ((x) >> CFX_Q) \ : ~((~(x)) >> CFX_Q)) -#define CLUTTER_FIXED_CEIL(x) CLUTTER_FIXED_FLOOR(x + 0xffff) +#define CLUTTER_FIXED_CEIL(x) (CLUTTER_FIXED_FLOOR (x + 0xffff)) #define CLUTTER_FIXED_MUL(x,y) ((x) >> 8) * ((y) >> 8) #define CLUTTER_FIXED_DIV(x,y) ((((x) << 8)/(y)) << 8) /* some handy short aliases to avoid exessively long lines */ -#define CFX_INT CLUTTER_FIXED_INT -#define CFX_MUL CLUTTER_FIXED_MUL -#define CFX_DIV CLUTTER_FIXED_DIV +#define CFX_INT CLUTTER_FIXED_INT +#define CFX_MUL CLUTTER_FIXED_MUL +#define CFX_DIV CLUTTER_FIXED_DIV /* Fixed point math routines */ extern inline @@ -171,7 +167,7 @@ ClutterFixed clutter_tani (ClutterAngle angle); * * Since: 0.2 */ -#define clutter_cosx(angle) clutter_fixed_sin((angle) + CFX_PI_2) +#define clutter_cosx(angle) (clutter_fixed_sin((angle) + CFX_PI_2)) /** * clutter_cosi: @@ -188,7 +184,7 @@ ClutterFixed clutter_tani (ClutterAngle angle); * * Since: 0.2 */ -#define clutter_cosi(angle) clutter_sini((angle) + 256) +#define clutter_cosi(angle) (clutter_sini ((angle) + 256)) ClutterFixed clutter_sqrtx (ClutterFixed x); gint clutter_sqrti (gint x); @@ -206,4 +202,4 @@ gint _clutter_double_to_int (double value); G_END_DECLS -#endif +#endif /* _HAVE_CLUTTER_FIXED_H */ diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog index 632e0ba36..c71768901 100644 --- a/doc/reference/ChangeLog +++ b/doc/reference/ChangeLog @@ -1,4 +1,11 @@ -2007-05-31 Emmanuele Bassi +2007-06-07 Emmanuele Bassi + + * tmpl/*.sgml: Remove from revision control the templates: + everything is now documented from within the source code. + + * clutter-sections.txt: Add missing titles. + +2007-06-07 Emmanuele Bassi * clutter.types: * clutter-sections.txt: diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt index 902243443..cda00c0d7 100644 --- a/doc/reference/clutter-sections.txt +++ b/doc/reference/clutter-sections.txt @@ -26,7 +26,7 @@ clutter_media_get_type
clutter-units -clutter-units +Unit conversion CLUTTER_UNITS_FROM_DEVICE CLUTTER_UNITS_FROM_FIXED CLUTTER_UNITS_FROM_FLOAT @@ -644,11 +644,13 @@ clutter_backend_get_type
clutter-util +Utilities clutter_util_next_p2
clutter-feature +GL Features ClutterFeatureFlags clutter_feature_available clutter_feature_get_all @@ -657,6 +659,7 @@ clutter_feature_wait_for_vblank
clutter-fixed +Fixed Point Support ClutterFixed CFX_Q CFX_ONE @@ -697,6 +700,7 @@ clutter_sqrtx
clutter-color +Colors ClutterColor clutter_color_copy clutter_color_free @@ -721,6 +725,7 @@ clutter_color_get_type
clutter-event +Events CLUTTER_CURRENT_TIME CLUTTER_PRIORITY_EVENTS ClutterFilterFunc @@ -760,6 +765,7 @@ clutter_event_get_type
clutter-main +General CLUTTER_INIT_ERROR ClutterInitError clutter_init @@ -780,6 +786,7 @@ clutter_init_error_quark
clutter-glx +GLX Specific Support clutter_glx_get_default_display clutter_glx_get_default_screen clutter_glx_get_root_window @@ -792,6 +799,7 @@ clutter_glx_untrap_x_errors
clutter-version +Versioning Macros CLUTTER_MAJOR_VERSION CLUTTER_MINOR_VERSION CLUTTER_MICRO_VERSION diff --git a/doc/reference/tmpl/clutter-actor.sgml b/doc/reference/tmpl/clutter-actor.sgml deleted file mode 100644 index bcdcc43be..000000000 --- a/doc/reference/tmpl/clutter-actor.sgml +++ /dev/null @@ -1,686 +0,0 @@ - -ClutterActor - - - - - - - - - - - - - - - - - - - -Sets a flag from #ClutterActorFlags to an actor - - -@e: a #ClutterActor -@f: the flag to set - - - - -Unsets a flag from #ClutterActorFlags to an actor - - -@e: a #ClutterActor -@f: the flag to unset - - - - -Evaluates to %TRUE if an actor is mapped. - - -@e: a #ClutterActor - - - - -Evaluates to %TRUE if an actor has been realized. - - -@e: a #ClutterActor - - - - -Evaluates to %TRUE if an actor is visible. - - -@e: a #ClutterActor - - - - -Coordinates (top-left to bottom-right) of a box surrounding an actor; in -cluttter units. - - -@x1: X coordinate of the top left corner of the box -@y1: Y coordinate of the top left corner of the box -@x2: X coordinate of the bottom right corner of the box -@y2: Y coordinate of the bottom right corner of the box - - - -Flags used by an actor. - - -@CLUTTER_ACTOR_MAPPED: the actor is mapped -@CLUTTER_ACTOR_REALIZED: the actor is realised - - - -Positional and dimensional coordinates of an actor. - - -@x: X coordinate of the top left corner of an actor -@y: Y coordinate of the top left corner of an actor -@width: width of an actor -@height: height of an actor - - - -Casts a generic callback function into a #ClutterCallback - - -@f: a function pointer - - - - -Generic callback function. - - -@actor: a #ClutterActor -@data: optional data to be passed to the function - - - - -Basic element of the Clutter canvas. Every object present on the stage must -be an actor. You can scale, move and rotate an actor; you can group actors -inside #ClutterGroups or let them follow a #ClutterBehaviour. - - -@parent_instance: parent class -@flags: flags set for the actor - - - - - - -@clutteractor: the object which received the signal. - - - - - - -@clutteractor: the object which received the signal. - - - - - - -@clutteractor: the object which received the signal. -@arg1: - - - - - - -@clutteractor: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Base class for #ClutterActor - - -@parent_class: parent class -@show: -@show_all: -@hide: -@hide_all: -@realize: -@unrealize: -@paint: -@request_coords: -@allocate_coords: -@set_depth: -@get_depth: -@parent_set: -@destroy: -@pick: -@_clutter_actor_1: -@_clutter_actor_2: -@_clutter_actor_3: -@_clutter_actor_4: -@_clutter_actor_5: -@_clutter_actor_6: - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: -@box: - - - - - - - -@self: -@box: - - - - - - - -@self: -@geometry: - - - - - - - -@self: -@geometry: - - - - - - - -@self: -@x1: -@y1: -@x2: -@y2: - - - - - - - -@self: -@width: -@height: - - - - - - - -@self: -@width: -@height: - - - - - - - -@self: -@x: -@y: - - - - - - - -@self: -@x: -@y: - - - - - - - -@self: -@width: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@height: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@dx: -@dy: - - - - - - - -@self: -@angle: -@y: -@z: - - - - - - - -@self: -@angle: -@x: -@z: - - - - - - - -@self: -@angle: -@x: -@y: - - - - - - - -@self: -@opacity: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@name: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@xoff: -@yoff: -@width: -@height: - - - - - - - -@self: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@parent: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@new_parent: - - - - - - - -@self: - - - - - - - -@self: -@below: - - - - - - - -@self: -@above: - - - - - - - -@self: - - - - - - - -@self: - - - - - - - -@self: -@depth: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@scale_x: -@scale_y: - - - - - - - -@self: -@scale_x: -@scale_y: - - - - - - - -@self: -@scale_x: -@scale_y: - - - - - - - -@self: -@scale_x: -@scale_y: - - - - - - - -@self: -@width: -@height: - - diff --git a/doc/reference/tmpl/clutter-alpha.sgml b/doc/reference/tmpl/clutter-alpha.sgml deleted file mode 100644 index 4b4b0fd39..000000000 --- a/doc/reference/tmpl/clutter-alpha.sgml +++ /dev/null @@ -1,295 +0,0 @@ - -ClutterAlpha - - - - - - - - - - - -#ClutterBehaviour, #ClutterTimeline - - - - - - - -The #ClutterAlpha structure contains only private data and should not be -accessed directly. - - - - - - - - - - - - - - - -Class structure for #ClutterApha. - - -@parent_class: -@_clutter_alpha_1: -@_clutter_alpha_2: -@_clutter_alpha_3: -@_clutter_alpha_4: -@_clutter_alpha_5: - - - - - - -@Returns: - - - - - - - -@timeline: -@func: -@data: -@destroy: -@Returns: - - - - - - - -@alpha: -@Returns: - - - - -Maximum value of the alpha function. You should use this value to -scale the computed alpha value. - - - - - - -The alpha function is a function of time. You should provide a function -transforming the current position in the timeline. - - -@alpha: a #ClutterAlpha -@user_data: optional user defined data passed to the function -@Returns: a value between 0 and CLUTTER_ALPHA_MAX_ALPHA - - - - - - - -@alpha: -@func: -@data: -@destroy: - - - - - - - -@alpha: -@timeline: - - - - - - - -@alpha: -@Returns: - - - - -Symbolic name for passing clutter_ramp_inc_func(). - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - -Symbolic name for passing clutter_ramp_dec_func(). - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - -Symbolic name for passing clutter_ramp_func(). - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - -Symbolic name for passing clutter_sine_func(). - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - - - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - - - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - - - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - -Symbolic name for passing clutter_square_func(). - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - -Symbolic name for passing clutter_exp_inc_func(). - - - - - - - - - -@alpha: -@dummy: -@Returns: - - - - -Symbolic name for passing clutter_exp_dec_func(). - - - - - - - - - -@alpha: -@dummy: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-backend.sgml b/doc/reference/tmpl/clutter-backend.sgml deleted file mode 100644 index c08e9b2bf..000000000 --- a/doc/reference/tmpl/clutter-backend.sgml +++ /dev/null @@ -1,96 +0,0 @@ - -ClutterBackend - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - -@backend: -@Returns: - - - - - - - -@backend: -@Returns: - - - - - - - -@backend: -@event: - - - - - - - -@backend: -@Returns: - - - - - - - -@backend: -@msec: - - - - - - - -@backend: -@Returns: - - - - - - - -@backend: -@distance: - - diff --git a/doc/reference/tmpl/clutter-behaviour-bspline.sgml b/doc/reference/tmpl/clutter-behaviour-bspline.sgml deleted file mode 100644 index 55a3dc55e..000000000 --- a/doc/reference/tmpl/clutter-behaviour-bspline.sgml +++ /dev/null @@ -1,140 +0,0 @@ - -ClutterBehaviourBspline - - - - - - - - - - - - - - - - - - - -The ClutterBehaviourBspline structure contains -only private data, and should not be accessed directly. - - - - - - - - -@clutterbehaviourbspline: the object which received the signal. -@arg1: - - - -Class structure for #ClutterBehaviouBspline. - - -@parent_class: -@knot_reached: -@_clutter_bspline_1: -@_clutter_bspline_2: -@_clutter_bspline_3: -@_clutter_bspline_4: - - - - - - -@alpha: -@knots: -@n_knots: -@Returns: - - - - - - - -@bs: -@knot: - - - - - - - -@bs: -@first_knot: -@Varargs: - - - - - - - -@bs: -@offset: - - - - - - - -@bs1: -@bs2: - - - - - - - -@bs: -@offset: -@Returns: - - - - - - - -@bs: - - - - - - - -@bs: -@offset: -@knot: - - - - - - - -@bs: -@knot: - - - - - - - -@bs: -@knot: - - diff --git a/doc/reference/tmpl/clutter-behaviour-ellipse.sgml b/doc/reference/tmpl/clutter-behaviour-ellipse.sgml deleted file mode 100644 index 8d9bf7729..000000000 --- a/doc/reference/tmpl/clutter-behaviour-ellipse.sgml +++ /dev/null @@ -1,194 +0,0 @@ - -ClutterBehaviourEllipse - - - - - - - - - - - - - - - - - - - -The ClutterBehaviourEllipse structure contains -only private data, and should not be accessed directly. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Class structure for #ClutterBehaviourEllipse. - - -@parent_class: -@knot_reached: -@_clutter_ellipse_1: -@_clutter_ellipse_2: -@_clutter_ellipse_3: -@_clutter_ellipse_4: - - - - - - -@alpha: -@x: -@y: -@width: -@height: -@begin: -@end: -@tilt: -@Returns: - - - - - - - -@self: -@x: -@y: - - - - - - - -@self: -@x: -@y: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@angle_begin: - - - - - - - -@self: -@angle_end: - - - - - - - -@self: -@angle_tilt: - - - - - - - -@self: -@height: - - - - - - - -@self: -@width: - - diff --git a/doc/reference/tmpl/clutter-behaviour-opacity.sgml b/doc/reference/tmpl/clutter-behaviour-opacity.sgml deleted file mode 100644 index ee1299ae4..000000000 --- a/doc/reference/tmpl/clutter-behaviour-opacity.sgml +++ /dev/null @@ -1,54 +0,0 @@ - -ClutterBehaviourOpacity - - - - - - - - - - - - - - - - - - - -The ClutterBehaviourOpacity struct has only -private data and should not be accessed directly. - - - - - - - - - - - - - - - -Class structure for #ClutterBehaviourOpacity. - - -@parent_class: - - - - - - -@alpha: -@opacity_start: -@opacity_end: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-behaviour-path.sgml b/doc/reference/tmpl/clutter-behaviour-path.sgml deleted file mode 100644 index a691df95e..000000000 --- a/doc/reference/tmpl/clutter-behaviour-path.sgml +++ /dev/null @@ -1,152 +0,0 @@ - -ClutterBehaviourPath - - - - - - - - - - - - - - - - - - - -A single node of the path followed by a #ClutterBehaviourPath. - - -@x: X coordinate of the node -@y: Y coordinate of the node - - - - - - -@knot: -@Returns: - - - - - - - -@knot: - - - - - - - -@knot_a: -@knot_b: -@Returns: - - - - -The ClutterBehaviourPath structure contains -only private data, and should not be accessed directly. - - - - - - - - -@clutterbehaviourpath: the object which received the signal. -@arg1: - - - - - - - - -Class structure for #ClutterBehaviourPath. - - -@parent_class: -@knot_reached: -@_clutter_path_1: -@_clutter_path_2: -@_clutter_path_3: -@_clutter_path_4: - - - - - - -@alpha: -@knots: -@n_knots: -@Returns: - - - - - - - -@pathb: -@Returns: - - - - - - - -@pathb: -@knot: - - - - - - - -@pathb: -@first_knot: -@Varargs: - - - - - - - -@pathb: -@offset: -@knot: - - - - - - - -@pathb: -@offset: - - - - - - - -@pathb: - - diff --git a/doc/reference/tmpl/clutter-behaviour-rotate.sgml b/doc/reference/tmpl/clutter-behaviour-rotate.sgml deleted file mode 100644 index 26adb65cf..000000000 --- a/doc/reference/tmpl/clutter-behaviour-rotate.sgml +++ /dev/null @@ -1,152 +0,0 @@ - -ClutterBehaviourRotate - - - - - - - - - - - - - - - - - - - - - - -@CLUTTER_X_AXIS: -@CLUTTER_Y_AXIS: -@CLUTTER_Z_AXIS: - - - - - - -@CLUTTER_ROTATE_CW: -@CLUTTER_ROTATE_CCW: - - - -The ClutterBehaviourRotate structure contains -only private data, and should not be accessed directly. - - - - - - - - - - - - - - - - - - - - - - - - - -Class structure for #ClutterBehaviourRotate. - - -@parent_class: - - - - - - -@alpha: -@axis: -@direction: -@angle_begin: -@angle_end: -@Returns: - - - - - - - -@alpha: -@axis: -@direction: -@angle_begin: -@angle_end: -@Returns: - - - - - - - -@rotate: -@axis: - - - - - - - -@rotate: -@direction: - - - - - - - -@rotate: -@Returns: - - - - - - - -@rotate: -@angle_begin: -@angle_end: - - - - - - - -@rotate: -@angle_begin: -@angle_end: - - - - - - - -@rotate: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-behaviour-scale.sgml b/doc/reference/tmpl/clutter-behaviour-scale.sgml deleted file mode 100644 index 6ca61cfe7..000000000 --- a/doc/reference/tmpl/clutter-behaviour-scale.sgml +++ /dev/null @@ -1,117 +0,0 @@ - -ClutterBehaviourScale - - - - - - - - - - - - - - - - - - - -Defines the reference point of the scaling. - - -@CLUTTER_GRAVITY_NONE: -@CLUTTER_GRAVITY_NORTH: -@CLUTTER_GRAVITY_NORTH_EAST: -@CLUTTER_GRAVITY_EAST: -@CLUTTER_GRAVITY_SOUTH_EAST: -@CLUTTER_GRAVITY_SOUTH: -@CLUTTER_GRAVITY_SOUTH_WEST: -@CLUTTER_GRAVITY_WEST: -@CLUTTER_GRAVITY_NORTH_WEST: -@CLUTTER_GRAVITY_CENTER: the actor should scale from the center - - - -The ClutterBehaviourScale structure contains only -private data and should not be accessed directly. - - - - - - - - - - - - - - - - - - - - -Class structure for #ClutterBehaviourScale. - - -@parent_class: - - - - - - -@alpha: -@scale_begin: -@scale_end: -@gravity: -@Returns: - - - - - - - -@alpha: -@scale_begin: -@scale_end: -@gravity: -@Returns: - - - - - - - -@scale: -@scale_begin: -@scale_end: - - - - - - - -@scale: -@scale_begin: -@scale_end: - - - - - - - -@scale: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-behaviour.sgml b/doc/reference/tmpl/clutter-behaviour.sgml deleted file mode 100644 index 18f0c76af..000000000 --- a/doc/reference/tmpl/clutter-behaviour.sgml +++ /dev/null @@ -1,143 +0,0 @@ - -ClutterBehaviour - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Class structure. - - -@parent_class: parent class -@alpha_notify: Override this virtual function when creating a new behaviour. - The alpha notify virtual function is called each time the alpha value - computed by the #ClutterAlpha object changes; in this virtual function - you should update the properties driven by your behaviour for all the - actors to which the behaviour applies. -@_clutter_behaviour1: -@_clutter_behaviour2: -@_clutter_behaviour3: -@_clutter_behaviour4: -@_clutter_behaviour5: -@_clutter_behaviour6: - - - - - - -@behave: -@actor: - - - - - - - -@behave: -@actor: - - - - - - - -@behave: -@actor: -@Returns: - - - - -The function used to iterate on every #ClutterActor to which a behaviour -applies. - - -@behaviour: a #ClutterBehaviour -@actor: a #ClutterActor -@data: optional user data passed to this function - - - - - - - -@behave: -@func: -@data: - - - - - - - -@behave: -@Returns: - - - - - - - -@behave: -@Returns: - - - - - - - -@behave: -@index: -@Returns: - - - - - - - -@behave: -@Returns: - - - - - - - -@behave: -@alpha: - - diff --git a/doc/reference/tmpl/clutter-clone-texture.sgml b/doc/reference/tmpl/clutter-clone-texture.sgml deleted file mode 100644 index e50d3ba91..000000000 --- a/doc/reference/tmpl/clutter-clone-texture.sgml +++ /dev/null @@ -1,68 +0,0 @@ - -ClutterCloneTexture - - - - - - - - - - - - - - - - - - - -#ClutterCloneTexture has no publicly available members. - - - - - - - - - - - - - -@parent_class: -@_clutter_clone_1: -@_clutter_clone_2: -@_clutter_clone_3: -@_clutter_clone_4: - - - - - - -@texture: -@Returns: - - - - - - - -@clone: -@Returns: - - - - - - - -@clone: -@texture: - - diff --git a/doc/reference/tmpl/clutter-color.sgml b/doc/reference/tmpl/clutter-color.sgml deleted file mode 100644 index 70ad0f84c..000000000 --- a/doc/reference/tmpl/clutter-color.sgml +++ /dev/null @@ -1,173 +0,0 @@ - -clutter-color - - - - - - - - - - - - - - - - - - - - - - -@red: -@green: -@blue: -@alpha: - - - - - - -@color: -@Returns: - - - - - - - -@color: - - - - - - - -@color: -@dest: -@Returns: - - - - - - - -@dest: -@hue: -@luminance: -@saturation: - - - - - - - -@dest: -@pixel: - - - - - - - -@src1: -@src2: -@dest: - - - - - - - -@src1: -@src2: -@dest: - - - - - - - -@a: -@b: -@Returns: - - - - - - - -@src: -@dest: - - - - - - - -@src: -@dest: - - - - - - - -@src: -@dest: -@shade: - - - - - - - -@src: -@dest: -@shade: - - - - - - - -@src: -@hue: -@luminance: -@saturation: - - - - - - - -@src: -@Returns: - - - - - - - -@color: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-entry.sgml b/doc/reference/tmpl/clutter-entry.sgml deleted file mode 100644 index 110cdc6ee..000000000 --- a/doc/reference/tmpl/clutter-entry.sgml +++ /dev/null @@ -1,324 +0,0 @@ - -ClutterEntry - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@clutterentry: the object which received the signal. -@arg1: - - - - - - -@clutterentry: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - -@font_name: -@text: -@Returns: - - - - - - - -@font_name: -@text: -@color: -@Returns: - - - - - - - -@entry: -@text: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@font_name: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@color: - - - - - - - -@entry: -@color: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@alignment: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@position: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@kev: - - - - - - - -@entry: -@wc: - - - - - - - -@entry: -@len: - - - - - - - -@entry: -@text: -@position: - - - - - - - -@entry: -@start_pos: -@end_pos: - - - - - - - -@entry: -@visible: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@visible: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@wc: - - - - - - - -@entry: -@Returns: - - - - - - - -@entry: -@max: - - diff --git a/doc/reference/tmpl/clutter-event.sgml b/doc/reference/tmpl/clutter-event.sgml deleted file mode 100644 index 19c7e1d6c..000000000 --- a/doc/reference/tmpl/clutter-event.sgml +++ /dev/null @@ -1,311 +0,0 @@ - -clutter-event - - -User and window system event functionality - - - -Windowing events handled by Clutter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@event: -@data: -@Returns: - - - - - - - -@CLUTTER_FILTER_CONTINUE: -@CLUTTER_FILTER_TRANSLATE: -@CLUTTER_FILTER_REMOVE: - - - - - - -@CLUTTER_SCROLL_UP: -@CLUTTER_SCROLL_DOWN: -@CLUTTER_SCROLL_LEFT: -@CLUTTER_SCROLL_RIGHT: - - - - - - -@CLUTTER_STAGE_STATE_FULLSCREEN: -@CLUTTER_STAGE_STATE_MAXIMIZED: -@CLUTTER_STAGE_STATE_MINIMIZED: -@CLUTTER_STAGE_STATE_OFFSCREEN: - - - - - - -@CLUTTER_NOTHING: -@CLUTTER_KEY_PRESS: -@CLUTTER_KEY_RELEASE: -@CLUTTER_MOTION: -@CLUTTER_BUTTON_PRESS: -@CLUTTER_2BUTTON_PRESS: -@CLUTTER_3BUTTON_PRESS: -@CLUTTER_BUTTON_RELEASE: -@CLUTTER_SCROLL: -@CLUTTER_STAGE_STATE: -@CLUTTER_DESTROY_NOTIFY: -@CLUTTER_CLIENT_MESSAGE: -@CLUTTER_DELETE: - - - - - - - - - - - - -@type: - - - - - - -@type: -@time: -@x: -@y: -@modifier_state: -@button: -@axes: -@device: - - - - - - -@type: -@time: -@modifier_state: -@keyval: -@hardware_keycode: - - - - - - -@type: -@time: -@x: -@y: -@modifier_state: -@axes: -@device: - - - - - - -@type: -@time: -@x: -@y: -@direction: -@modifier_state: -@axes: -@device: - - - - - - -@type: -@changed_mask: -@new_state: - - - - - - - - - - - - -@type: -@Returns: - - - - - - - -@event: -@Returns: - - - - - - - -@event: - - - - - - - -@event: -@Returns: - - - - - - - -@event: -@x: -@y: - - - - - - - -@event: -@Returns: - - - - - - - -@event: -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@event: - - - - - - - -@Returns: - - - - - - - -@buttev: -@Returns: - - - - - - - -@keyev: -@Returns: - - - - - - - -@keyev: -@Returns: - - - - - - - -@keyev: -@Returns: - - - - - - - -@keyval: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-feature.sgml b/doc/reference/tmpl/clutter-feature.sgml deleted file mode 100644 index 3f2ee9cd7..000000000 --- a/doc/reference/tmpl/clutter-feature.sgml +++ /dev/null @@ -1,46 +0,0 @@ - -clutter-feature - - - - - - - - - - - - - - - - - - - - - - -@CLUTTER_FEATURE_TEXTURE_RECTANGLE: -@CLUTTER_FEATURE_SYNC_TO_VBLANK: -@CLUTTER_FEATURE_TEXTURE_YUV: -@CLUTTER_FEATURE_TEXTURE_READ_PIXELS: - - - - - - -@feature: -@Returns: - - - - - - - -@Returns: - - diff --git a/doc/reference/tmpl/clutter-fixed.sgml b/doc/reference/tmpl/clutter-fixed.sgml deleted file mode 100644 index 30cd43944..000000000 --- a/doc/reference/tmpl/clutter-fixed.sgml +++ /dev/null @@ -1,325 +0,0 @@ - -clutter-fixed - - -Fixed point API - - - -Clutter has a fixed point API targeted at platforms without a floating -point unit, such as embedded devices. This API should be preferred to -the floating point one as it does not trigger the slow path of software -emulation, relying on integer math for fixed-to-floating and -floating-to-fixed conversion. - - -
-Basic Rules of Fixed Point Arithmetic - - - -Two fixed point numbers can be directly added and subtracted. - - - - -To add other numerical type to a fixed point number it has to be first -converted to fixed point. - - - - -A fixed point number can be directly multiplied or divided by an integer. - - - - -Two fixed point numbers can only be multiplied and divided by the provided -#CLUTTER_FIXED_MUL (aka #CFX_MUL) and #CLUTTER_FIXED_DIV (aka #CFX_DIV) macros. - - - -
- - - - - - - - - - - - - - - - - -Number of bits used to store fractional part of #ClutterFixed. - - - - - - -#ClutterFixed representation of 1. - - - - - - -Maximum number representable by #ClutterFixed. - - - - - - -Minumum number representable by #ClutterFixed. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Alias for #CLUTTER_FIXED_DIV. - - - - - - -Alias for #CLUTTER_FIXED_INT. - - - - - - -Alias for #CLUTTER_FIXED_MUL. - - - - - - -Macro for converting #ClutterFixed to single precission floating point. - - -@x: #ClutterFixed - - - - -Macro for converting #ClutterFixed to double precission floating point. - - -@x: #ClutterFixed - - - - -Macro for converting floating point numbers to #ClutterFixed. - - -@x: double or float - - - - -Macro for converting floating point numbers to intergers; this conversion -is significantly faster that casting floats to int. - - -@x: float - - - - -Macro for converting integers to #ClutterFixed. - - -@x: int - - - - -Macro to obtain integer part of #ClutterFixed. - - -@x: #ClutterFixed - - - - -Macro to obtain the fraction of #ClutterFixed. - - -@x: #ClutterFixed - - - - -Macro to obtain greatest integer smaller than given #ClutterFixed. - - -@x: #ClutterFixed - - - - -Macro to obtain smallest integer greater than given #ClutterFixed. - - -@x: #ClutterFixed - - - - -Macro for multiplication of two #ClutterFixed numbers. - - -@x: #ClutterFixed -@y: #ClutterFixed - - - - -Macro for difvision of two #ClutterFixed numbers. - - -@x: #ClutterFixed -@y: #ClutterFixed - - - - - - - -@angle: - - - - - - - -@angle: - - - - - - - -@angle: -@Returns: - - - - - - - -@angle: -@Returns: - - - - - - - -@x: -@Returns: - - - - - - - -@x: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-glx.sgml b/doc/reference/tmpl/clutter-glx.sgml deleted file mode 100644 index ebe25d581..000000000 --- a/doc/reference/tmpl/clutter-glx.sgml +++ /dev/null @@ -1,86 +0,0 @@ - -clutter-glx - - - - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@stage: -@Returns: - - - - - - - -@stage: -@Returns: - - - - - - - -@stage: -@xwindow: -@Returns: - - - - - - - - - - - - - - -@Returns: - - diff --git a/doc/reference/tmpl/clutter-group.sgml b/doc/reference/tmpl/clutter-group.sgml deleted file mode 100644 index 8d4f1042a..000000000 --- a/doc/reference/tmpl/clutter-group.sgml +++ /dev/null @@ -1,158 +0,0 @@ - -ClutterGroup - - - - - - - - - - - - - - - - - - - -#ClutterGroup has no publicly available members. - - - - - -The #ClutterActor @arg1 was added to the group. - - -@cluttergroup: the object which received the signal. -@arg1: a #ClutterActor. - - - -The #ClutterActor @arg1 was removed from the group. - - -@cluttergroup: the object which received the signal. -@arg1: a #ClutterActor. - - - - - - - - - - - - -@Returns: - - - - - - - -@self: -@Returns: - - - - - - - -@self: -@index: -@Returns: - - - - - - - -@group: -@actor: - - - - - - - -@group: -@first_actor: -@var_args: - - - - - - - -@group: -@first_actor: -@Varargs: - - - - - - - -@group: -@actor: - - - - - - - -@group: - - - - - - - -@self: -@id: -@Returns: - - - - - - - -@self: -@actor: -@sibling: - - - - - - - -@self: -@actor: -@sibling: - - - - - - - -@self: - - diff --git a/doc/reference/tmpl/clutter-keysyms.sgml b/doc/reference/tmpl/clutter-keysyms.sgml deleted file mode 100644 index 40db7d97c..000000000 --- a/doc/reference/tmpl/clutter-keysyms.sgml +++ /dev/null @@ -1,19 +0,0 @@ - -clutter-keysyms - - - - - - - - - - - - - - - - - diff --git a/doc/reference/tmpl/clutter-label.sgml b/doc/reference/tmpl/clutter-label.sgml deleted file mode 100644 index 23a7bce4e..000000000 --- a/doc/reference/tmpl/clutter-label.sgml +++ /dev/null @@ -1,276 +0,0 @@ - -ClutterLabel - - - - - - - - - - - - - - - - - - - -#ClutterLabel has no publicly available members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - -@font_name: -@text: -@Returns: - - - - - - - -@font_name: -@text: -@color: -@Returns: - - - - - - - -@label: -@text: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@font_name: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@color: - - - - - - - -@label: -@color: - - - - - - - -@label: -@mode: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@wrap: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@wrap_mode: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@attrs: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@setting: - - - - - - - -@label: -@Returns: - - - - - - - -@label: -@alignment: - - - - - - - -@label: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-main.sgml b/doc/reference/tmpl/clutter-main.sgml deleted file mode 100644 index 26865ff14..000000000 --- a/doc/reference/tmpl/clutter-main.sgml +++ /dev/null @@ -1,128 +0,0 @@ - -clutter-main - - - - - - - - - - - - - - - - - - - -GError domain for the #ClutterInitError enum. - - - - - - -Error codes for the Clutter initialisation process. - - -@CLUTTER_INIT_SUCCESS: Clutter was successfully initialised -@CLUTTER_INIT_ERROR_UNKOWN: Unknown error while initialising Clutter -@CLUTTER_INIT_ERROR_THREADS: Unable to initialise threading -@CLUTTER_INIT_ERROR_BACKEND: -@CLUTTER_INIT_ERROR_INTERNAL: Internal Clutter error - - - - - - -@argc: -@argv: -@Returns: - - - - - - - -@argc: -@argv: -@parameter_string: -@entries: -@translation_domain: -@error: -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - -@Returns: - - - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/reference/tmpl/clutter-marshal.sgml b/doc/reference/tmpl/clutter-marshal.sgml deleted file mode 100644 index 5bc8daf4d..000000000 --- a/doc/reference/tmpl/clutter-marshal.sgml +++ /dev/null @@ -1,19 +0,0 @@ - -clutter-marshal - - - - - - - - - - - - - - - - - diff --git a/doc/reference/tmpl/clutter-media.sgml b/doc/reference/tmpl/clutter-media.sgml deleted file mode 100644 index 3d85887af..000000000 --- a/doc/reference/tmpl/clutter-media.sgml +++ /dev/null @@ -1,203 +0,0 @@ - -clutter-media - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@cluttermedia: the object which received the signal. - - - - - - -@cluttermedia: the object which received the signal. -@arg1: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@base_iface: -@set_uri: -@get_uri: -@set_playing: -@get_playing: -@set_position: -@get_position: -@set_volume: -@get_volume: -@can_seek: -@get_buffer_percent: -@get_duration: -@eos: -@error: - - - - - - -@media: -@uri: - - - - - - - -@media: -@Returns: - - - - - - - -@media: -@playing: - - - - - - - -@media: -@Returns: - - - - - - - -@media: -@position: - - - - - - - -@media: -@Returns: - - - - - - - -@media: -@volume: - - - - - - - -@media: -@Returns: - - - - - - - -@media: -@Returns: - - - - - - - -@media: -@Returns: - - - - - - - -@media: -@Returns: - - - - - - - -@media: -@filename: - - diff --git a/doc/reference/tmpl/clutter-rectangle.sgml b/doc/reference/tmpl/clutter-rectangle.sgml deleted file mode 100644 index 9a829abbb..000000000 --- a/doc/reference/tmpl/clutter-rectangle.sgml +++ /dev/null @@ -1,127 +0,0 @@ - -ClutterRectangle - - - - - - - - - - - - - - - - - - - -#ClutterRectangle has no publicly available members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent_class: -@_clutter_rectangle1: -@_clutter_rectangle2: -@_clutter_rectangle3: -@_clutter_rectangle4: - - - - - - -@Returns: - - - - - - - -@color: -@Returns: - - - - - - - -@rectangle: -@color: - - - - - - - -@rectangle: -@color: - - - - - - - -@rectangle: -@color: - - - - - - - -@rectangle: -@color: - - - - - - - -@rectangle: -@Returns: - - - - - - - -@rectangle: -@width: - - diff --git a/doc/reference/tmpl/clutter-stage.sgml b/doc/reference/tmpl/clutter-stage.sgml deleted file mode 100644 index 92e12302a..000000000 --- a/doc/reference/tmpl/clutter-stage.sgml +++ /dev/null @@ -1,268 +0,0 @@ - -ClutterStage - - - - - - - - - - - - - - - - - - - -Macro evaluating to the width of the #ClutterStage - - - - - - -Macro evaluating to the height of the #ClutterStage - - - - - - - - - -@fovy: -@aspect: -@z_near: -@z_far: - - - - - - -@perspective: -@Returns: - - - - - - - -@perspective: - - - - -#ClutterStage has no publicly available members. - - - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - -@clutterstage: the object which received the signal. -@arg1: - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent_class: -@set_fullscreen: -@set_cursor_visible: -@set_offscreen: -@draw_to_pixbuf: -@event: -@event_after: -@button_press_event: -@button_release_event: -@scroll_event: -@key_press_event: -@key_release_event: -@motion_event: -@stage_state_event: -@_clutter_stage1: -@_clutter_stage2: -@_clutter_stage3: -@_clutter_stage4: -@_clutter_stage5: -@_clutter_stage6: - - - - - - -@Returns: - - - - - - - -@stage: -@color: - - - - - - - -@stage: -@color: - - - - - - - -@stage: - - - - - - - -@stage: - - - - - - - -@stage: - - - - - - - -@stage: - - - - - - - -@stage: -@x: -@y: -@Returns: - - - - - - - -@stage: -@x: -@y: -@width: -@height: -@Returns: - - - - - - - -@stage: -@event: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-texture.sgml b/doc/reference/tmpl/clutter-texture.sgml deleted file mode 100644 index 1d39ea901..000000000 --- a/doc/reference/tmpl/clutter-texture.sgml +++ /dev/null @@ -1,209 +0,0 @@ - -ClutterTexture - - - - - - - - - - - - - - - - - - - -#ClutterTexture has no publicly available members. - - - - - - - - -@cluttertexture: the object which received the signal. - - - - - - -@cluttertexture: the object which received the signal. -@arg1: -@arg2: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent_class: -@size_change: -@pixbuf_change: -@_clutter_texture1: -@_clutter_texture2: -@_clutter_texture3: -@_clutter_texture4: -@_clutter_texture5: -@_clutter_texture6: - - - - - - -@pixbuf: -@Returns: - - - - - - - -@Returns: - - - - - - - -@texture: -@pixbuf: -@error: -@Returns: - - - - - - - -@texture: -@Returns: - - - - - - - -@texture: -@width: -@height: - - - - - - - -@texture: -@index: - - - - - - - -@texture: -@n_x_tiles: -@n_y_tiles: - - - - - - - -@texture: -@x_index: -@pos: -@size: -@waste: - - - - - - - -@texture: -@y_index: -@pos: -@size: -@waste: - - - - - - - -@texture: -@Returns: - - - - - - - -@texture: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-timeline.sgml b/doc/reference/tmpl/clutter-timeline.sgml deleted file mode 100644 index 39c6d9021..000000000 --- a/doc/reference/tmpl/clutter-timeline.sgml +++ /dev/null @@ -1,249 +0,0 @@ - -ClutterTimeline - - - - - - - - - - - - - - - - - - - -#ClutterTimeline has no publicly available members. - - - - - -The #ClutterTimeline has completed running. - - -@cluttertimeline: the object which received the signal. - - - - - - -@cluttertimeline: the object which received the signal. -@arg1: the frame number. - - - -The #ClutterTimeline has been paused. - - -@cluttertimeline: the object which received the signal. - - - -The #ClutterTimeline has been started. - - -@cluttertimeline: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - -@parent_class: -@started: -@completed: -@paused: -@new_frame: -@_clutter_timeline_1: -@_clutter_timeline_2: -@_clutter_timeline_3: -@_clutter_timeline_4: -@_clutter_timeline_5: - - - - - - -@n_frames: -@fps: -@Returns: - - - - - - - -@timeline: -@Returns: - - - - - - - -@timeline: -@fps: - - - - - - - -@timeline: -@Returns: - - - - - - - -@timeline: - - - - - - - -@timeline: - - - - - - - -@timeline: - - - - - - - -@timeline: -@loop: - - - - - - - -@timeline: -@Returns: - - - - - - - -@timeline: - - - - - - - -@timeline: -@n_frames: - - - - - - - -@timeline: -@frame_num: - - - - - - - -@timeline: -@Returns: - - - - - - - -@timeline: -@n_frames: - - - - - - - -@timeline: -@Returns: - - - - - - - -@timeline: -@Returns: - - - - - - - -@timeline: -@msecs: - - - - - - - -@timeline: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-units.sgml b/doc/reference/tmpl/clutter-units.sgml deleted file mode 100644 index 696b4f4cb..000000000 --- a/doc/reference/tmpl/clutter-units.sgml +++ /dev/null @@ -1,118 +0,0 @@ - -Clutter Units - - - - - - - - - - - - - - - - - - - -Macro for converting from device units to #ClutterUnit. - - -@x: int - - - - -Macro for converting from #ClutterFixed pixels to #ClutterUnit. - - -@x: #ClutterFixed - - - - -Macro for converting from floating point pixels to #ClutterUnit. - - -@x: float - - - - -Macro for converting from pixels to #ClutterUnit. - - -@x: int - - - - -Macro for converting from Pango units to #ClutterUnit. - - -@x: int - - - - -Macro to ease furture transition #ClutterUnit-based API. - -This is presently an identity macro, that can be used around integer pixel -values passed into clutter functions. When the API is changed to use -#ClutterUnit, this macro will be modified to carry out pixel -> #ClutterUnit -conversion. - - -@x: int - - - - -Macro to ease furture transition #ClutterUnit-based API. - -This is presently an identity macro, that can be used around integer pixel -values return from clutter functions. When the API is changed to return -#ClutterUnit, this macro will be modified to carry out #ClutterUnit -> -pixel conversion. - - -@x: int - - - - -Macro for conversion from #ClutterUnit values to device unit (currently -pixels). - - -@x: #ClutterUnit - - - - -Macro for conversion of #ClutterUnit value to #ClutterFixed pixel value. - - -@x: #ClutterUnit - - - - -Macro for conversion of #ClutterUnit value to floating point pixel value. - - -@x: #ClutterUnit - - - - -Macro for conversion of #ClutterUnit value to int pixel value. - - -@x: #ClutterUnit - - diff --git a/doc/reference/tmpl/clutter-util.sgml b/doc/reference/tmpl/clutter-util.sgml deleted file mode 100644 index 2c8f149ad..000000000 --- a/doc/reference/tmpl/clutter-util.sgml +++ /dev/null @@ -1,28 +0,0 @@ - -clutter-util - - - - - - - - - - - - - - - - - - - - - - -@a: -@Returns: - - diff --git a/doc/reference/tmpl/clutter-version.sgml b/doc/reference/tmpl/clutter-version.sgml deleted file mode 100644 index 8288fab8b..000000000 --- a/doc/reference/tmpl/clutter-version.sgml +++ /dev/null @@ -1,80 +0,0 @@ - -clutter-version - - -Versioning utilities - - - -Clutter exports some macros representing the version at compile time. These -macros are useful for configure and compile time checks. - - - - - - - - - - - - -The major version component of Clutter version - - - - - - -The minor version component of Clutter version - - - - - - -The micro version component of Clutter version - - - - - - -The Clutter version - - - - - - -The Clutter version as a string - - - - - - -The Clutter version as a hexadecimal number - - - - - - -Returns TRUE if the version of the Clutter header files is the same as or newer -than the passed-in version. - - -@major: major version (e.g. 1, for 1.2.3) -@minor: minor version (e.g. 2, for 1.2.3) -@micro: micro version (e.g. 3, for 1.2.3) - - - - - - - - -