isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-09-20 14:35:48 -04:00
Code Issues Packages Projects Releases Wiki Activity

2007-06-07 Emmanuele Bassi <ebassi@openedhand.com>

Browse Source 
* clutter/*: Move documentation from the templates into the
	source code.
This commit is contained in:
Emmanuele Bassi 2007-06-07 15:28:59 +00:00
parent 3c2defee9d
commit e30df678ae
37 changed files with 78 additions and 5265 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2007-06-07 Emmanuele Bassi <ebassi@openedhand.com>
* clutter/*: Move documentation from the templates into the
source code.
2007-06-07 Emmanuele Bassi <ebassi@openedhand.com>
* clutter/clutter-container.[ch]: Add a generic actor container

7
clutter/clutter-event.c
View File

@ -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};

2
clutter/clutter-feature.c
View File

@ -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
*/

34
clutter/clutter-fixed.c
View File

@ -23,8 +23,42 @@
* Boston, MA 02111-1307, USA.
*/
#include "config.h"
#include <clutter-fixed.h>
/**
* 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:
*
* <itemizedlist>
* <listitem>
* <para>Two fixed point numbers can be directly added and
* subtracted.</para>
* </listitem>
* <listitem>
* <para>To add other numerical type to a fixed point number it has to
* be first converted to fixed point.</para>
* </listitem>
* <listitem>
* <para>A fixed point number can be directly multiplied or divided by
* an integer.</para>
* </listitem>
* <listitem>
* <para>Two fixed point numbers can only be multiplied and divided by the
* provided #CLUTTER_FIXED_MUL and #CLUTTER_FIXED_DIV macros.</para>
* </listitem>
* </itemizedlist>
*/
/* pre-computed sin table for 1st quadrant
*
* Currently contains 257 entries.

32
clutter/clutter-fixed.h
View File

@ -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 */

9
doc/reference/ChangeLog
View File

@ -1,4 +1,11 @@
2007-05-31 Emmanuele Bassi <ebassi@openedhand.com>
2007-06-07 Emmanuele Bassi <ebassi@openedhand.com>
* 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 <ebassi@openedhand.com>
* clutter.types:
* clutter-sections.txt:

10
doc/reference/clutter-sections.txt
View File

@ -26,7 +26,7 @@ clutter_media_get_type
<SECTION>
<FILE>clutter-units</FILE>
<TITLE>clutter-units</TITLE>
<TITLE>Unit conversion</TITLE>
CLUTTER_UNITS_FROM_DEVICE
CLUTTER_UNITS_FROM_FIXED
CLUTTER_UNITS_FROM_FLOAT
@ -644,11 +644,13 @@ clutter_backend_get_type
<SECTION>
<FILE>clutter-util</FILE>
<TITLE>Utilities</TITLE>
clutter_util_next_p2
</SECTION>
<SECTION>
<FILE>clutter-feature</FILE>
<TITLE>GL Features</TITLE>
ClutterFeatureFlags
clutter_feature_available
clutter_feature_get_all
@ -657,6 +659,7 @@ clutter_feature_wait_for_vblank
<SECTION>
<FILE>clutter-fixed</FILE>
<TITLE>Fixed Point Support</TITLE>
ClutterFixed
CFX_Q
CFX_ONE
@ -697,6 +700,7 @@ clutter_sqrtx
<SECTION>
<FILE>clutter-color</FILE>
<TITLE>Colors</TITLE>
ClutterColor
clutter_color_copy
clutter_color_free
@ -721,6 +725,7 @@ clutter_color_get_type
<SECTION>
<FILE>clutter-event</FILE>
<TITLE>Events</TITLE>
CLUTTER_CURRENT_TIME
CLUTTER_PRIORITY_EVENTS
ClutterFilterFunc
@ -760,6 +765,7 @@ clutter_event_get_type
<SECTION>
<FILE>clutter-main</FILE>
<TITLE>General</TITLE>
CLUTTER_INIT_ERROR
ClutterInitError
clutter_init
@ -780,6 +786,7 @@ clutter_init_error_quark
<SECTION>
<FILE>clutter-glx</FILE>
<TITLE>GLX Specific Support</TITLE>
clutter_glx_get_default_display
clutter_glx_get_default_screen
clutter_glx_get_root_window
@ -792,6 +799,7 @@ clutter_glx_untrap_x_errors
<SECTION>
<FILE>clutter-version</FILE>
<TITLE>Versioning Macros</TITLE>
CLUTTER_MAJOR_VERSION
CLUTTER_MINOR_VERSION
CLUTTER_MICRO_VERSION

686
doc/reference/tmpl/clutter-actor.sgml
View File

@ -1,686 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterActor
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_ACTOR_SET_FLAGS ##### -->
<para>
Sets a flag from #ClutterActorFlags to an actor
</para>
@e: a #ClutterActor
@f: the flag to set
<!-- ##### MACRO CLUTTER_ACTOR_UNSET_FLAGS ##### -->
<para>
Unsets a flag from #ClutterActorFlags to an actor
</para>
@e: a #ClutterActor
@f: the flag to unset
<!-- ##### MACRO CLUTTER_ACTOR_IS_MAPPED ##### -->
<para>
Evaluates to %TRUE if an actor is mapped.
</para>
@e: a #ClutterActor
<!-- ##### MACRO CLUTTER_ACTOR_IS_REALIZED ##### -->
<para>
Evaluates to %TRUE if an actor has been realized.
</para>
@e: a #ClutterActor
<!-- ##### MACRO CLUTTER_ACTOR_IS_VISIBLE ##### -->
<para>
Evaluates to %TRUE if an actor is visible.
</para>
@e: a #ClutterActor
<!-- ##### STRUCT ClutterActorBox ##### -->
<para>
Coordinates (top-left to bottom-right) of a box surrounding an actor; in
cluttter units.
</para>
@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
<!-- ##### ENUM ClutterActorFlags ##### -->
<para>
Flags used by an actor.
</para>
@CLUTTER_ACTOR_MAPPED: the actor is mapped
@CLUTTER_ACTOR_REALIZED: the actor is realised
<!-- ##### STRUCT ClutterGeometry ##### -->
<para>
Positional and dimensional coordinates of an actor.
</para>
@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
<!-- ##### MACRO CLUTTER_CALLBACK ##### -->
<para>
Casts a generic callback function into a #ClutterCallback
</para>
@f: a function pointer
<!-- ##### USER_FUNCTION ClutterCallback ##### -->
<para>
Generic callback function.
</para>
@actor: a #ClutterActor
@data: optional data to be passed to the function
<!-- ##### STRUCT ClutterActor ##### -->
<para>
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 #ClutterGroup<!-- -->s or let them follow a #ClutterBehaviour.
</para>
@parent_instance: parent class
@flags: flags set for the actor
<!-- ##### SIGNAL ClutterActor::destroy ##### -->
<para>
</para>
@clutteractor: the object which received the signal.
<!-- ##### SIGNAL ClutterActor::hide ##### -->
<para>
</para>
@clutteractor: the object which received the signal.
<!-- ##### SIGNAL ClutterActor::parent-set ##### -->
<para>
</para>
@clutteractor: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterActor::show ##### -->
<para>
</para>
@clutteractor: the object which received the signal.
<!-- ##### ARG ClutterActor:clip ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:has-clip ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:height ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:name ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:opacity ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:visible ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:width ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:x ##### -->
<para>
</para>
<!-- ##### ARG ClutterActor:y ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterActorClass ##### -->
<para>
Base class for #ClutterActor
</para>
@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:
<!-- ##### FUNCTION clutter_actor_show ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_show_all ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_hide ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_hide_all ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_realize ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_unrealize ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_paint ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_queue_redraw ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_destroy ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_request_coords ##### -->
<para>
</para>
@self:
@box:
<!-- ##### FUNCTION clutter_actor_allocate_coords ##### -->
<para>
</para>
@self:
@box:
<!-- ##### FUNCTION clutter_actor_set_geometry ##### -->
<para>
</para>
@self:
@geometry:
<!-- ##### FUNCTION clutter_actor_get_geometry ##### -->
<para>
</para>
@self:
@geometry:
<!-- ##### FUNCTION clutter_actor_get_coords ##### -->
<para>
</para>
@self:
@x1:
@y1:
@x2:
@y2:
<!-- ##### FUNCTION clutter_actor_set_size ##### -->
<para>
</para>
@self:
@width:
@height:
<!-- ##### FUNCTION clutter_actor_get_size ##### -->
<para>
</para>
@self:
@width:
@height:
<!-- ##### FUNCTION clutter_actor_set_position ##### -->
<para>
</para>
@self:
@x:
@y:
<!-- ##### FUNCTION clutter_actor_get_abs_position ##### -->
<para>
</para>
@self:
@x:
@y:
<!-- ##### FUNCTION clutter_actor_set_width ##### -->
<para>
</para>
@self:
@width:
<!-- ##### FUNCTION clutter_actor_get_width ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_set_height ##### -->
<para>
</para>
@self:
@height:
<!-- ##### FUNCTION clutter_actor_get_height ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_get_x ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_get_y ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_move_by ##### -->
<para>
</para>
@self:
@dx:
@dy:
<!-- ##### FUNCTION clutter_actor_rotate_x ##### -->
<para>
</para>
@self:
@angle:
@y:
@z:
<!-- ##### FUNCTION clutter_actor_rotate_y ##### -->
<para>
</para>
@self:
@angle:
@x:
@z:
<!-- ##### FUNCTION clutter_actor_rotate_z ##### -->
<para>
</para>
@self:
@angle:
@x:
@y:
<!-- ##### FUNCTION clutter_actor_set_opacity ##### -->
<para>
</para>
@self:
@opacity:
<!-- ##### FUNCTION clutter_actor_get_opacity ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_set_name ##### -->
<para>
</para>
@self:
@name:
<!-- ##### FUNCTION clutter_actor_get_name ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_get_id ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_set_clip ##### -->
<para>
</para>
@self:
@xoff:
@yoff:
@width:
@height:
<!-- ##### FUNCTION clutter_actor_remove_clip ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_has_clip ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_set_parent ##### -->
<para>
</para>
@self:
@parent:
<!-- ##### FUNCTION clutter_actor_get_parent ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_reparent ##### -->
<para>
</para>
@self:
@new_parent:
<!-- ##### FUNCTION clutter_actor_unparent ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_raise ##### -->
<para>
</para>
@self:
@below:
<!-- ##### FUNCTION clutter_actor_lower ##### -->
<para>
</para>
@self:
@above:
<!-- ##### FUNCTION clutter_actor_raise_top ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_lower_bottom ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_set_depth ##### -->
<para>
</para>
@self:
@depth:
<!-- ##### FUNCTION clutter_actor_get_depth ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_actor_set_scalex ##### -->
<para>
</para>
@self:
@scale_x:
@scale_y:
<!-- ##### FUNCTION clutter_actor_set_scale ##### -->
<para>
</para>
@self:
@scale_x:
@scale_y:
<!-- ##### FUNCTION clutter_actor_get_scalex ##### -->
<para>
</para>
@self:
@scale_x:
@scale_y:
<!-- ##### FUNCTION clutter_actor_get_scale ##### -->
<para>
</para>
@self:
@scale_x:
@scale_y:
<!-- ##### FUNCTION clutter_actor_get_abs_size ##### -->
<para>
</para>
@self:
@width:
@height:

295
doc/reference/tmpl/clutter-alpha.sgml
View File

@ -1,295 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterAlpha
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#ClutterBehaviour, #ClutterTimeline
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterAlpha ##### -->
<para>
The #ClutterAlpha structure contains only private data and should not be
accessed directly.
</para>
<!-- ##### ARG ClutterAlpha:alpha ##### -->
<para>
</para>
<!-- ##### ARG ClutterAlpha:timeline ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterAlphaClass ##### -->
<para>
Class structure for #ClutterApha.
</para>
@parent_class:
@_clutter_alpha_1:
@_clutter_alpha_2:
@_clutter_alpha_3:
@_clutter_alpha_4:
@_clutter_alpha_5:
<!-- ##### FUNCTION clutter_alpha_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_alpha_new_full ##### -->
<para>
</para>
@timeline:
@func:
@data:
@destroy:
@Returns:
<!-- ##### FUNCTION clutter_alpha_get_alpha ##### -->
<para>
</para>
@alpha:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_MAX_ALPHA ##### -->
<para>
Maximum value of the alpha function. You should use this value to
scale the computed alpha value.
</para>
<!-- ##### USER_FUNCTION ClutterAlphaFunc ##### -->
<para>
The alpha function is a function of time. You should provide a function
transforming the current position in the timeline.
</para>
@alpha: a #ClutterAlpha
@user_data: optional user defined data passed to the function
@Returns: a value between 0 and CLUTTER_ALPHA_MAX_ALPHA
<!-- ##### FUNCTION clutter_alpha_set_func ##### -->
<para>
</para>
@alpha:
@func:
@data:
@destroy:
<!-- ##### FUNCTION clutter_alpha_set_timeline ##### -->
<para>
</para>
@alpha:
@timeline:
<!-- ##### FUNCTION clutter_alpha_get_timeline ##### -->
<para>
</para>
@alpha:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_RAMP_INC ##### -->
<para>
Symbolic name for passing clutter_ramp_inc_func().
</para>
<!-- ##### FUNCTION clutter_ramp_inc_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_RAMP_DEC ##### -->
<para>
Symbolic name for passing clutter_ramp_dec_func().
</para>
<!-- ##### FUNCTION clutter_ramp_dec_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_RAMP ##### -->
<para>
Symbolic name for passing clutter_ramp_func().
</para>
<!-- ##### FUNCTION clutter_ramp_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE ##### -->
<para>
Symbolic name for passing clutter_sine_func().
</para>
<!-- ##### FUNCTION clutter_sine_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE_INC ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_sine_inc_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE_DEC ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_sine_dec_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE_HALF ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_sine_half_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SQUARE ##### -->
<para>
Symbolic name for passing clutter_square_func().
</para>
<!-- ##### FUNCTION clutter_square_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_EXP_INC ##### -->
<para>
Symbolic name for passing clutter_exp_inc_func().
</para>
<!-- ##### FUNCTION clutter_exp_inc_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_EXP_DEC ##### -->
<para>
Symbolic name for passing clutter_exp_dec_func().
</para>
<!-- ##### FUNCTION clutter_exp_dec_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:

96
doc/reference/tmpl/clutter-backend.sgml
View File

@ -1,96 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBackend
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterBackend ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_get_default_backend ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_backend_get_event ##### -->
<para>
</para>
@backend:
@Returns:
<!-- ##### FUNCTION clutter_backend_peek_event ##### -->
<para>
</para>
@backend:
@Returns:
<!-- ##### FUNCTION clutter_backend_put_event ##### -->
<para>
</para>
@backend:
@event:
<!-- ##### FUNCTION clutter_backend_get_double_click_time ##### -->
<para>
</para>
@backend:
@Returns:
<!-- ##### FUNCTION clutter_backend_set_double_click_time ##### -->
<para>
</para>
@backend:
@msec:
<!-- ##### FUNCTION clutter_backend_get_double_click_distance ##### -->
<para>
</para>
@backend:
@Returns:
<!-- ##### FUNCTION clutter_backend_set_double_click_distance ##### -->
<para>
</para>
@backend:
@distance:

140
doc/reference/tmpl/clutter-behaviour-bspline.sgml
View File

@ -1,140 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBehaviourBspline
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterBehaviourBspline ##### -->
<para>
The <structname>ClutterBehaviourBspline</structname> structure contains
only private data, and should not be accessed directly.
</para>
<!-- ##### SIGNAL ClutterBehaviourBspline::knot-reached ##### -->
<para>
</para>
@clutterbehaviourbspline: the object which received the signal.
@arg1:
<!-- ##### STRUCT ClutterBehaviourBsplineClass ##### -->
<para>
Class structure for #ClutterBehaviouBspline.
</para>
@parent_class:
@knot_reached:
@_clutter_bspline_1:
@_clutter_bspline_2:
@_clutter_bspline_3:
@_clutter_bspline_4:
<!-- ##### FUNCTION clutter_behaviour_bspline_new ##### -->
<para>
</para>
@alpha:
@knots:
@n_knots:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_bspline_append_knot ##### -->
<para>
</para>
@bs:
@knot:
<!-- ##### FUNCTION clutter_behaviour_bspline_append ##### -->
<para>
</para>
@bs:
@first_knot:
@Varargs:
<!-- ##### FUNCTION clutter_behaviour_bspline_truncate ##### -->
<para>
</para>
@bs:
@offset:
<!-- ##### FUNCTION clutter_behaviour_bspline_join ##### -->
<para>
</para>
@bs1:
@bs2:
<!-- ##### FUNCTION clutter_behaviour_bspline_split ##### -->
<para>
</para>
@bs:
@offset:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_bspline_clear ##### -->
<para>
</para>
@bs:
<!-- ##### FUNCTION clutter_behaviour_bspline_adjust ##### -->
<para>
</para>
@bs:
@offset:
@knot:
<!-- ##### FUNCTION clutter_behaviour_bspline_set_origin ##### -->
<para>
</para>
@bs:
@knot:
<!-- ##### FUNCTION clutter_behaviour_bspline_get_origin ##### -->
<para>
</para>
@bs:
@knot:

194
doc/reference/tmpl/clutter-behaviour-ellipse.sgml
View File

@ -1,194 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBehaviourEllipse
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterBehaviourEllipse ##### -->
<para>
The <structname>ClutterBehaviourEllipse</structname> structure contains
only private data, and should not be accessed directly.
</para>
<!-- ##### ARG ClutterBehaviourEllipse:angle-begin ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourEllipse:angle-end ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourEllipse:angle-tilt ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourEllipse:center ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourEllipse:height ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourEllipse:width ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterBehaviourEllipseClass ##### -->
<para>
Class structure for #ClutterBehaviourEllipse.
</para>
@parent_class:
@knot_reached:
@_clutter_ellipse_1:
@_clutter_ellipse_2:
@_clutter_ellipse_3:
@_clutter_ellipse_4:
<!-- ##### FUNCTION clutter_behaviour_ellipse_new ##### -->
<para>
</para>
@alpha:
@x:
@y:
@width:
@height:
@begin:
@end:
@tilt:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_ellipse_set_center ##### -->
<para>
</para>
@self:
@x:
@y:
<!-- ##### FUNCTION clutter_behaviour_ellipse_get_center ##### -->
<para>
</para>
@self:
@x:
@y:
<!-- ##### FUNCTION clutter_behaviour_ellipse_get_angle_begin ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_ellipse_get_angle_end ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_ellipse_get_angle_tilt ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_ellipse_get_height ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_ellipse_get_width ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_ellipse_set_angle_begin ##### -->
<para>
</para>
@self:
@angle_begin:
<!-- ##### FUNCTION clutter_behaviour_ellipse_set_angle_end ##### -->
<para>
</para>
@self:
@angle_end:
<!-- ##### FUNCTION clutter_behaviour_ellipse_set_angle_tilt ##### -->
<para>
</para>
@self:
@angle_tilt:
<!-- ##### FUNCTION clutter_behaviour_ellipse_set_height ##### -->
<para>
</para>
@self:
@height:
<!-- ##### FUNCTION clutter_behaviour_ellipse_set_width ##### -->
<para>
</para>
@self:
@width:

54
doc/reference/tmpl/clutter-behaviour-opacity.sgml
View File

@ -1,54 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBehaviourOpacity
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterBehaviourOpacity ##### -->
<para>
The <structname>ClutterBehaviourOpacity</structname> struct has only
private data and should not be accessed directly.
</para>
<!-- ##### ARG ClutterBehaviourOpacity:opacity-end ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourOpacity:opacity-start ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterBehaviourOpacityClass ##### -->
<para>
Class structure for #ClutterBehaviourOpacity.
</para>
@parent_class:
<!-- ##### FUNCTION clutter_behaviour_opacity_new ##### -->
<para>
</para>
@alpha:
@opacity_start:
@opacity_end:
@Returns:

152
doc/reference/tmpl/clutter-behaviour-path.sgml
View File

@ -1,152 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBehaviourPath
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterKnot ##### -->
<para>
A single node of the path followed by a #ClutterBehaviourPath.
</para>
@x: X coordinate of the node
@y: Y coordinate of the node
<!-- ##### FUNCTION clutter_knot_copy ##### -->
<para>
</para>
@knot:
@Returns:
<!-- ##### FUNCTION clutter_knot_free ##### -->
<para>
</para>
@knot:
<!-- ##### FUNCTION clutter_knot_equal ##### -->
<para>
</para>
@knot_a:
@knot_b:
@Returns:
<!-- ##### STRUCT ClutterBehaviourPath ##### -->
<para>
The <structname>ClutterBehaviourPath</structname> structure contains
only private data, and should not be accessed directly.
</para>
<!-- ##### SIGNAL ClutterBehaviourPath::knot-reached ##### -->
<para>
</para>
@clutterbehaviourpath: the object which received the signal.
@arg1:
<!-- ##### ARG ClutterBehaviourPath:knot ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterBehaviourPathClass ##### -->
<para>
Class structure for #ClutterBehaviourPath.
</para>
@parent_class:
@knot_reached:
@_clutter_path_1:
@_clutter_path_2:
@_clutter_path_3:
@_clutter_path_4:
<!-- ##### FUNCTION clutter_behaviour_path_new ##### -->
<para>
</para>
@alpha:
@knots:
@n_knots:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_path_get_knots ##### -->
<para>
</para>
@pathb:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_path_append_knot ##### -->
<para>
</para>
@pathb:
@knot:
<!-- ##### FUNCTION clutter_behaviour_path_append_knots ##### -->
<para>
</para>
@pathb:
@first_knot:
@Varargs:
<!-- ##### FUNCTION clutter_behaviour_path_insert_knot ##### -->
<para>
</para>
@pathb:
@offset:
@knot:
<!-- ##### FUNCTION clutter_behaviour_path_remove_knot ##### -->
<para>
</para>
@pathb:
@offset:
<!-- ##### FUNCTION clutter_behaviour_path_clear ##### -->
<para>
</para>
@pathb:

152
doc/reference/tmpl/clutter-behaviour-rotate.sgml
View File

@ -1,152 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBehaviourRotate
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM ClutterRotateAxis ##### -->
<para>
</para>
@CLUTTER_X_AXIS:
@CLUTTER_Y_AXIS:
@CLUTTER_Z_AXIS:
<!-- ##### ENUM ClutterRotateDirection ##### -->
<para>
</para>
@CLUTTER_ROTATE_CW:
@CLUTTER_ROTATE_CCW:
<!-- ##### STRUCT ClutterBehaviourRotate ##### -->
<para>
The <structname>ClutterBehaviourRotate</structname> structure contains
only private data, and should not be accessed directly.
</para>
<!-- ##### ARG ClutterBehaviourRotate:angle-begin ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourRotate:angle-end ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourRotate:axis ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourRotate:direction ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterBehaviourRotateClass ##### -->
<para>
Class structure for #ClutterBehaviourRotate.
</para>
@parent_class:
<!-- ##### FUNCTION clutter_behaviour_rotate_new ##### -->
<para>
</para>
@alpha:
@axis:
@direction:
@angle_begin:
@angle_end:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_rotate_newx ##### -->
<para>
</para>
@alpha:
@axis:
@direction:
@angle_begin:
@angle_end:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_rotate_set_axis ##### -->
<para>
</para>
@rotate:
@axis:
<!-- ##### FUNCTION clutter_behaviour_rotate_set_direction ##### -->
<para>
</para>
@rotate:
@direction:
<!-- ##### FUNCTION clutter_behaviour_rotate_get_axis ##### -->
<para>
</para>
@rotate:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_rotate_get_bounds ##### -->
<para>
</para>
@rotate:
@angle_begin:
@angle_end:
<!-- ##### FUNCTION clutter_behaviour_rotate_get_boundsx ##### -->
<para>
</para>
@rotate:
@angle_begin:
@angle_end:
<!-- ##### FUNCTION clutter_behaviour_rotate_get_direction ##### -->
<para>
</para>
@rotate:
@Returns:

117
doc/reference/tmpl/clutter-behaviour-scale.sgml
View File

@ -1,117 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBehaviourScale
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM ClutterGravity ##### -->
<para>
Defines the reference point of the scaling.
</para>
@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
<!-- ##### STRUCT ClutterBehaviourScale ##### -->
<para>
The <structname>ClutterBehaviourScale</structname> structure contains only
private data and should not be accessed directly.
</para>
<!-- ##### ARG ClutterBehaviourScale:scale-begin ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourScale:scale-end ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviourScale:scale-gravity ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterBehaviourScaleClass ##### -->
<para>
Class structure for #ClutterBehaviourScale.
</para>
@parent_class:
<!-- ##### FUNCTION clutter_behaviour_scale_new ##### -->
<para>
</para>
@alpha:
@scale_begin:
@scale_end:
@gravity:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_scale_newx ##### -->
<para>
</para>
@alpha:
@scale_begin:
@scale_end:
@gravity:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_scale_get_bounds ##### -->
<para>
</para>
@scale:
@scale_begin:
@scale_end:
<!-- ##### FUNCTION clutter_behaviour_scale_get_boundsx ##### -->
<para>
</para>
@scale:
@scale_begin:
@scale_end:
<!-- ##### FUNCTION clutter_behaviour_scale_get_gravity ##### -->
<para>
</para>
@scale:
@Returns:

143
doc/reference/tmpl/clutter-behaviour.sgml
View File

@ -1,143 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterBehaviour
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterBehaviour ##### -->
<para>
</para>
<!-- ##### ARG ClutterBehaviour:alpha ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterBehaviourClass ##### -->
<para>
Class structure.
</para>
@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:
<!-- ##### FUNCTION clutter_behaviour_apply ##### -->
<para>
</para>
@behave:
@actor:
<!-- ##### FUNCTION clutter_behaviour_remove ##### -->
<para>
</para>
@behave:
@actor:
<!-- ##### FUNCTION clutter_behaviour_is_applied ##### -->
<para>
</para>
@behave:
@actor:
@Returns:
<!-- ##### USER_FUNCTION ClutterBehaviourForeachFunc ##### -->
<para>
The function used to iterate on every #ClutterActor to which a behaviour
applies.
</para>
@behaviour: a #ClutterBehaviour
@actor: a #ClutterActor
@data: optional user data passed to this function
<!-- ##### FUNCTION clutter_behaviour_actors_foreach ##### -->
<para>
</para>
@behave:
@func:
@data:
<!-- ##### FUNCTION clutter_behaviour_get_actors ##### -->
<para>
</para>
@behave:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_get_n_actors ##### -->
<para>
</para>
@behave:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_get_nth_actor ##### -->
<para>
</para>
@behave:
@index:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_get_alpha ##### -->
<para>
</para>
@behave:
@Returns:
<!-- ##### FUNCTION clutter_behaviour_set_alpha ##### -->
<para>
</para>
@behave:
@alpha:

68
doc/reference/tmpl/clutter-clone-texture.sgml
View File

@ -1,68 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterCloneTexture
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterCloneTexture ##### -->
<para>
#ClutterCloneTexture has no publicly available members.
</para>
<!-- ##### ARG ClutterCloneTexture:parent-texture ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterCloneTextureClass ##### -->
<para>
</para>
@parent_class:
@_clutter_clone_1:
@_clutter_clone_2:
@_clutter_clone_3:
@_clutter_clone_4:
<!-- ##### FUNCTION clutter_clone_texture_new ##### -->
<para>
</para>
@texture:
@Returns:
<!-- ##### FUNCTION clutter_clone_texture_get_parent_texture ##### -->
<para>
</para>
@clone:
@Returns:
<!-- ##### FUNCTION clutter_clone_texture_set_parent_texture ##### -->
<para>
</para>
@clone:
@texture:

173
doc/reference/tmpl/clutter-color.sgml
View File

@ -1,173 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-color
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterColor ##### -->
<para>
</para>
@red:
@green:
@blue:
@alpha:
<!-- ##### FUNCTION clutter_color_copy ##### -->
<para>
</para>
@color:
@Returns:
<!-- ##### FUNCTION clutter_color_free ##### -->
<para>
</para>
@color:
<!-- ##### FUNCTION clutter_color_parse ##### -->
<para>
</para>
@color:
@dest:
@Returns:
<!-- ##### FUNCTION clutter_color_from_hls ##### -->
<para>
</para>
@dest:
@hue:
@luminance:
@saturation:
<!-- ##### FUNCTION clutter_color_from_pixel ##### -->
<para>
</para>
@dest:
@pixel:
<!-- ##### FUNCTION clutter_color_add ##### -->
<para>
</para>
@src1:
@src2:
@dest:
<!-- ##### FUNCTION clutter_color_subtract ##### -->
<para>
</para>
@src1:
@src2:
@dest:
<!-- ##### FUNCTION clutter_color_equal ##### -->
<para>
</para>
@a:
@b:
@Returns:
<!-- ##### FUNCTION clutter_color_lighten ##### -->
<para>
</para>
@src:
@dest:
<!-- ##### FUNCTION clutter_color_darken ##### -->
<para>
</para>
@src:
@dest:
<!-- ##### FUNCTION clutter_color_shade ##### -->
<para>
</para>
@src:
@dest:
@shade:
<!-- ##### FUNCTION clutter_color_shadex ##### -->
<para>
</para>
@src:
@dest:
@shade:
<!-- ##### FUNCTION clutter_color_to_hls ##### -->
<para>
</para>
@src:
@hue:
@luminance:
@saturation:
<!-- ##### FUNCTION clutter_color_to_pixel ##### -->
<para>
</para>
@src:
@Returns:
<!-- ##### FUNCTION clutter_color_to_string ##### -->
<para>
</para>
@color:
@Returns:

324
doc/reference/tmpl/clutter-entry.sgml
View File

@ -1,324 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterEntry
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterEntry ##### -->
<para>
</para>
<!-- ##### SIGNAL ClutterEntry::cursor-event ##### -->
<para>
</para>
@clutterentry: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterEntry::text-changed ##### -->
<para>
</para>
@clutterentry: the object which received the signal.
<!-- ##### ARG ClutterEntry:alignment ##### -->
<para>
</para>
<!-- ##### ARG ClutterEntry:color ##### -->
<para>
</para>
<!-- ##### ARG ClutterEntry:cursor-visible ##### -->
<para>
</para>
<!-- ##### ARG ClutterEntry:font-name ##### -->
<para>
</para>
<!-- ##### ARG ClutterEntry:max-length ##### -->
<para>
</para>
<!-- ##### ARG ClutterEntry:position ##### -->
<para>
</para>
<!-- ##### ARG ClutterEntry:text ##### -->
<para>
</para>
<!-- ##### ARG ClutterEntry:text-visible ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterEntryClass ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_entry_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_entry_new_with_text ##### -->
<para>
</para>
@font_name:
@text:
@Returns:
<!-- ##### FUNCTION clutter_entry_new_full ##### -->
<para>
</para>
@font_name:
@text:
@color:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_text ##### -->
<para>
</para>
@entry:
@text:
<!-- ##### FUNCTION clutter_entry_get_text ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_font_name ##### -->
<para>
</para>
@entry:
@font_name:
<!-- ##### FUNCTION clutter_entry_get_font_name ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_color ##### -->
<para>
</para>
@entry:
@color:
<!-- ##### FUNCTION clutter_entry_get_color ##### -->
<para>
</para>
@entry:
@color:
<!-- ##### FUNCTION clutter_entry_get_layout ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_alignment ##### -->
<para>
</para>
@entry:
@alignment:
<!-- ##### FUNCTION clutter_entry_get_alignment ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_position ##### -->
<para>
</para>
@entry:
@position:
<!-- ##### FUNCTION clutter_entry_get_position ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_handle_key_event ##### -->
<para>
</para>
@entry:
@kev:
<!-- ##### FUNCTION clutter_entry_add ##### -->
<para>
</para>
@entry:
@wc:
<!-- ##### FUNCTION clutter_entry_remove ##### -->
<para>
</para>
@entry:
@len:
<!-- ##### FUNCTION clutter_entry_insert_text ##### -->
<para>
</para>
@entry:
@text:
@position:
<!-- ##### FUNCTION clutter_entry_delete_text ##### -->
<para>
</para>
@entry:
@start_pos:
@end_pos:
<!-- ##### FUNCTION clutter_entry_set_visible_cursor ##### -->
<para>
</para>
@entry:
@visible:
<!-- ##### FUNCTION clutter_entry_get_visible_cursor ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_visibility ##### -->
<para>
</para>
@entry:
@visible:
<!-- ##### FUNCTION clutter_entry_get_visibility ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_invisible_char ##### -->
<para>
</para>
@entry:
@wc:
<!-- ##### FUNCTION clutter_entry_get_invisible_char ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION clutter_entry_set_max_length ##### -->
<para>
</para>
@entry:
@max:

311
doc/reference/tmpl/clutter-event.sgml
View File

@ -1,311 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-event
<!-- ##### SECTION Short_Description ##### -->
User and window system event functionality
<!-- ##### SECTION Long_Description ##### -->
<para>
Windowing events handled by Clutter.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_CURRENT_TIME ##### -->
<para>
</para>
<!-- ##### MACRO CLUTTER_PRIORITY_EVENTS ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION ClutterFilterFunc ##### -->
<para>
</para>
@event:
@data:
@Returns:
<!-- ##### ENUM ClutterFilterResponse ##### -->
<para>
</para>
@CLUTTER_FILTER_CONTINUE:
@CLUTTER_FILTER_TRANSLATE:
@CLUTTER_FILTER_REMOVE:
<!-- ##### ENUM ClutterScrollDirection ##### -->
<para>
</para>
@CLUTTER_SCROLL_UP:
@CLUTTER_SCROLL_DOWN:
@CLUTTER_SCROLL_LEFT:
@CLUTTER_SCROLL_RIGHT:
<!-- ##### ENUM ClutterStageState ##### -->
<para>
</para>
@CLUTTER_STAGE_STATE_FULLSCREEN:
@CLUTTER_STAGE_STATE_MAXIMIZED:
@CLUTTER_STAGE_STATE_MINIMIZED:
@CLUTTER_STAGE_STATE_OFFSCREEN:
<!-- ##### ENUM ClutterEventType ##### -->
<para>
</para>
@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:
<!-- ##### UNION ClutterEvent ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterAnyEvent ##### -->
<para>
</para>
@type:
<!-- ##### STRUCT ClutterButtonEvent ##### -->
<para>
</para>
@type:
@time:
@x:
@y:
@modifier_state:
@button:
@axes:
@device:
<!-- ##### STRUCT ClutterKeyEvent ##### -->
<para>
</para>
@type:
@time:
@modifier_state:
@keyval:
@hardware_keycode:
<!-- ##### STRUCT ClutterMotionEvent ##### -->
<para>
</para>
@type:
@time:
@x:
@y:
@modifier_state:
@axes:
@device:
<!-- ##### STRUCT ClutterScrollEvent ##### -->
<para>
</para>
@type:
@time:
@x:
@y:
@direction:
@modifier_state:
@axes:
@device:
<!-- ##### STRUCT ClutterStageStateEvent ##### -->
<para>
</para>
@type:
@changed_mask:
@new_state:
<!-- ##### STRUCT ClutterInputDevice ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_event_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION clutter_event_copy ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_free ##### -->
<para>
</para>
@event:
<!-- ##### FUNCTION clutter_event_type ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_get_coords ##### -->
<para>
</para>
@event:
@x:
@y:
<!-- ##### FUNCTION clutter_event_get_state ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_get_time ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_event_get ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_event_peek ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_event_put ##### -->
<para>
</para>
@event:
<!-- ##### FUNCTION clutter_events_pending ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_button_event_button ##### -->
<para>
</para>
@buttev:
@Returns:
<!-- ##### FUNCTION clutter_key_event_symbol ##### -->
<para>
</para>
@keyev:
@Returns:
<!-- ##### FUNCTION clutter_key_event_code ##### -->
<para>
</para>
@keyev:
@Returns:
<!-- ##### FUNCTION clutter_key_event_unicode ##### -->
<para>
</para>
@keyev:
@Returns:
<!-- ##### FUNCTION clutter_keysym_to_unicode ##### -->
<para>
</para>
@keyval:
@Returns:

46
doc/reference/tmpl/clutter-feature.sgml
View File

@ -1,46 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-feature
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM ClutterFeatureFlags ##### -->
<para>
</para>
@CLUTTER_FEATURE_TEXTURE_RECTANGLE:
@CLUTTER_FEATURE_SYNC_TO_VBLANK:
@CLUTTER_FEATURE_TEXTURE_YUV:
@CLUTTER_FEATURE_TEXTURE_READ_PIXELS:
<!-- ##### FUNCTION clutter_feature_available ##### -->
<para>
</para>
@feature:
@Returns:
<!-- ##### FUNCTION clutter_feature_get_all ##### -->
<para>
</para>
@Returns:

325
doc/reference/tmpl/clutter-fixed.sgml
View File

@ -1,325 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-fixed
<!-- ##### SECTION Short_Description ##### -->
Fixed point API
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<section>
<title>Basic Rules of Fixed Point Arithmetic</title>
<itemizedlist>
<listitem>
<para>
Two fixed point numbers can be directly added and subtracted.
</para>
</listitem>
<listitem>
<para>
To add other numerical type to a fixed point number it has to be first
converted to fixed point.
</para>
</listitem>
<listitem>
<para>
A fixed point number can be directly multiplied or divided by an integer.
</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
</itemizedlist>
</section>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### TYPEDEF ClutterFixed ##### -->
<para>
</para>
<!-- ##### MACRO CFX_Q ##### -->
<para>
Number of bits used to store fractional part of #ClutterFixed.
</para>
<!-- ##### MACRO CFX_ONE ##### -->
<para>
#ClutterFixed representation of 1.
</para>
<!-- ##### MACRO CFX_MAX ##### -->
<para>
Maximum number representable by #ClutterFixed.
</para>
<!-- ##### MACRO CFX_MIN ##### -->
<para>
Minumum number representable by #ClutterFixed.
</para>
<!-- ##### TYPEDEF ClutterAngle ##### -->
<para>
</para>
<!-- ##### MACRO CFX_PI ##### -->
<para>
</para>
<!-- ##### MACRO CFX_2PI ##### -->
<para>
</para>
<!-- ##### MACRO CFX_PI_2 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_PI_4 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_120 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_180 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_240 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_360 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_60 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_255 ##### -->
<para>
</para>
<!-- ##### MACRO CFX_DIV ##### -->
<para>
Alias for #CLUTTER_FIXED_DIV.
</para>
<!-- ##### MACRO CFX_INT ##### -->
<para>
Alias for #CLUTTER_FIXED_INT.
</para>
<!-- ##### MACRO CFX_MUL ##### -->
<para>
Alias for #CLUTTER_FIXED_MUL.
</para>
<!-- ##### MACRO CLUTTER_FIXED_TO_FLOAT ##### -->
<para>
Macro for converting #ClutterFixed to single precission floating point.
</para>
@x: #ClutterFixed
<!-- ##### MACRO CLUTTER_FIXED_TO_DOUBLE ##### -->
<para>
Macro for converting #ClutterFixed to double precission floating point.
</para>
@x: #ClutterFixed
<!-- ##### MACRO CLUTTER_FLOAT_TO_FIXED ##### -->
<para>
Macro for converting floating point numbers to #ClutterFixed.
</para>
@x: double or float
<!-- ##### MACRO CLUTTER_FLOAT_TO_INT ##### -->
<para>
Macro for converting floating point numbers to intergers; this conversion
is significantly faster that casting floats to int.
</para>
@x: float
<!-- ##### MACRO CLUTTER_INT_TO_FIXED ##### -->
<para>
Macro for converting integers to #ClutterFixed.
</para>
@x: int
<!-- ##### MACRO CLUTTER_FIXED_INT ##### -->
<para>
Macro to obtain integer part of #ClutterFixed.
</para>
@x: #ClutterFixed
<!-- ##### MACRO CLUTTER_FIXED_FRACTION ##### -->
<para>
Macro to obtain the fraction of #ClutterFixed.
</para>
@x: #ClutterFixed
<!-- ##### MACRO CLUTTER_FIXED_FLOOR ##### -->
<para>
Macro to obtain greatest integer smaller than given #ClutterFixed.
</para>
@x: #ClutterFixed
<!-- ##### MACRO CLUTTER_FIXED_CEIL ##### -->
<para>
Macro to obtain smallest integer greater than given #ClutterFixed.
</para>
@x: #ClutterFixed
<!-- ##### MACRO CLUTTER_FIXED_MUL ##### -->
<para>
Macro for multiplication of two #ClutterFixed numbers.
</para>
@x: #ClutterFixed
@y: #ClutterFixed
<!-- ##### MACRO CLUTTER_FIXED_DIV ##### -->
<para>
Macro for difvision of two #ClutterFixed numbers.
</para>
@x: #ClutterFixed
@y: #ClutterFixed
<!-- ##### MACRO clutter_cosi ##### -->
<para>
</para>
@angle:
<!-- ##### MACRO clutter_cosx ##### -->
<para>
</para>
@angle:
<!-- ##### FUNCTION clutter_sini ##### -->
<para>
</para>
@angle:
@Returns:
<!-- ##### FUNCTION clutter_sinx ##### -->
<para>
</para>
@angle:
@Returns:
<!-- ##### FUNCTION clutter_sqrti ##### -->
<para>
</para>
@x:
@Returns:
<!-- ##### FUNCTION clutter_sqrtx ##### -->
<para>
</para>
@x:
@Returns:

86
doc/reference/tmpl/clutter-glx.sgml
View File

@ -1,86 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-glx
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION clutter_glx_get_default_display ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_glx_get_default_screen ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_glx_get_root_window ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_glx_get_stage_visual ##### -->
<para>
</para>
@stage:
@Returns:
<!-- ##### FUNCTION clutter_glx_get_stage_window ##### -->
<para>
</para>
@stage:
@Returns:
<!-- ##### FUNCTION clutter_glx_set_stage_foreign ##### -->
<para>
</para>
@stage:
@xwindow:
@Returns:
<!-- ##### FUNCTION clutter_glx_trap_x_errors ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_glx_untrap_x_errors ##### -->
<para>
</para>
@Returns:

158
doc/reference/tmpl/clutter-group.sgml
View File

@ -1,158 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterGroup
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterGroup ##### -->
<para>
#ClutterGroup has no publicly available members.
</para>
<!-- ##### SIGNAL ClutterGroup::add ##### -->
<para>
The #ClutterActor @arg1 was added to the group.
</para>
@cluttergroup: the object which received the signal.
@arg1: a #ClutterActor.
<!-- ##### SIGNAL ClutterGroup::remove ##### -->
<para>
The #ClutterActor @arg1 was removed from the group.
</para>
@cluttergroup: the object which received the signal.
@arg1: a #ClutterActor.
<!-- ##### STRUCT ClutterGroupClass ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_group_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_group_get_n_children ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### FUNCTION clutter_group_get_nth_child ##### -->
<para>
</para>
@self:
@index:
@Returns:
<!-- ##### FUNCTION clutter_group_add ##### -->
<para>
</para>
@group:
@actor:
<!-- ##### FUNCTION clutter_group_add_many_valist ##### -->
<para>
</para>
@group:
@first_actor:
@var_args:
<!-- ##### FUNCTION clutter_group_add_many ##### -->
<para>
</para>
@group:
@first_actor:
@Varargs:
<!-- ##### FUNCTION clutter_group_remove ##### -->
<para>
</para>
@group:
@actor:
<!-- ##### FUNCTION clutter_group_remove_all ##### -->
<para>
</para>
@group:
<!-- ##### FUNCTION clutter_group_find_child_by_id ##### -->
<para>
</para>
@self:
@id:
@Returns:
<!-- ##### FUNCTION clutter_group_raise ##### -->
<para>
</para>
@self:
@actor:
@sibling:
<!-- ##### FUNCTION clutter_group_lower ##### -->
<para>
</para>
@self:
@actor:
@sibling:
<!-- ##### FUNCTION clutter_group_sort_depth_order ##### -->
<para>
</para>
@self:

19
doc/reference/tmpl/clutter-keysyms.sgml
View File

@ -1,19 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-keysyms
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->

276
doc/reference/tmpl/clutter-label.sgml
View File

@ -1,276 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterLabel
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterLabel ##### -->
<para>
#ClutterLabel has no publicly available members.
</para>
<!-- ##### ARG ClutterLabel:alignment ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:attributes ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:color ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:ellipsize ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:font-name ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:text ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:use-markup ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:wrap ##### -->
<para>
</para>
<!-- ##### ARG ClutterLabel:wrap-mode ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterLabelClass ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_label_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_label_new_with_text ##### -->
<para>
</para>
@font_name:
@text:
@Returns:
<!-- ##### FUNCTION clutter_label_new_full ##### -->
<para>
</para>
@font_name:
@text:
@color:
@Returns:
<!-- ##### FUNCTION clutter_label_set_text ##### -->
<para>
</para>
@label:
@text:
<!-- ##### FUNCTION clutter_label_get_text ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_set_font_name ##### -->
<para>
</para>
@label:
@font_name:
<!-- ##### FUNCTION clutter_label_get_font_name ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_set_color ##### -->
<para>
</para>
@label:
@color:
<!-- ##### FUNCTION clutter_label_get_color ##### -->
<para>
</para>
@label:
@color:
<!-- ##### FUNCTION clutter_label_set_ellipsize ##### -->
<para>
</para>
@label:
@mode:
<!-- ##### FUNCTION clutter_label_get_ellipsize ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_set_line_wrap ##### -->
<para>
</para>
@label:
@wrap:
<!-- ##### FUNCTION clutter_label_get_line_wrap ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_set_line_wrap_mode ##### -->
<para>
</para>
@label:
@wrap_mode:
<!-- ##### FUNCTION clutter_label_get_line_wrap_mode ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_get_layout ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_set_attributes ##### -->
<para>
</para>
@label:
@attrs:
<!-- ##### FUNCTION clutter_label_get_attributes ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_set_use_markup ##### -->
<para>
</para>
@label:
@setting:
<!-- ##### FUNCTION clutter_label_get_use_markup ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION clutter_label_set_alignment ##### -->
<para>
</para>
@label:
@alignment:
<!-- ##### FUNCTION clutter_label_get_alignment ##### -->
<para>
</para>
@label:
@Returns:

128
doc/reference/tmpl/clutter-main.sgml
View File

@ -1,128 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-main
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_INIT_ERROR ##### -->
<para>
GError domain for the #ClutterInitError enum.
</para>
<!-- ##### ENUM ClutterInitError ##### -->
<para>
Error codes for the Clutter initialisation process.
</para>
@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
<!-- ##### FUNCTION clutter_init ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### FUNCTION clutter_init_with_args ##### -->
<para>
</para>
@argc:
@argv:
@parameter_string:
@entries:
@translation_domain:
@error:
@Returns:
<!-- ##### FUNCTION clutter_get_option_group ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_get_debug_enabled ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_get_show_fps ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_main ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_main_quit ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_main_level ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_redraw ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_threads_enter ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_threads_leave ##### -->
<para>
</para>

19
doc/reference/tmpl/clutter-marshal.sgml
View File

@ -1,19 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-marshal
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->

203
doc/reference/tmpl/clutter-media.sgml
View File

@ -1,203 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-media
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterMedia ##### -->
<para>
</para>
<!-- ##### SIGNAL ClutterMedia::eos ##### -->
<para>
</para>
@cluttermedia: the object which received the signal.
<!-- ##### SIGNAL ClutterMedia::error ##### -->
<para>
</para>
@cluttermedia: the object which received the signal.
@arg1:
<!-- ##### ARG ClutterMedia:buffer-percent ##### -->
<para>
</para>
<!-- ##### ARG ClutterMedia:can-seek ##### -->
<para>
</para>
<!-- ##### ARG ClutterMedia:duration ##### -->
<para>
</para>
<!-- ##### ARG ClutterMedia:playing ##### -->
<para>
</para>
<!-- ##### ARG ClutterMedia:position ##### -->
<para>
</para>
<!-- ##### ARG ClutterMedia:uri ##### -->
<para>
</para>
<!-- ##### ARG ClutterMedia:volume ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterMediaInterface ##### -->
<para>
</para>
@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:
<!-- ##### FUNCTION clutter_media_set_uri ##### -->
<para>
</para>
@media:
@uri:
<!-- ##### FUNCTION clutter_media_get_uri ##### -->
<para>
</para>
@media:
@Returns:
<!-- ##### FUNCTION clutter_media_set_playing ##### -->
<para>
</para>
@media:
@playing:
<!-- ##### FUNCTION clutter_media_get_playing ##### -->
<para>
</para>
@media:
@Returns:
<!-- ##### FUNCTION clutter_media_set_position ##### -->
<para>
</para>
@media:
@position:
<!-- ##### FUNCTION clutter_media_get_position ##### -->
<para>
</para>
@media:
@Returns:
<!-- ##### FUNCTION clutter_media_set_volume ##### -->
<para>
</para>
@media:
@volume:
<!-- ##### FUNCTION clutter_media_get_volume ##### -->
<para>
</para>
@media:
@Returns:
<!-- ##### FUNCTION clutter_media_get_can_seek ##### -->
<para>
</para>
@media:
@Returns:
<!-- ##### FUNCTION clutter_media_get_buffer_percent ##### -->
<para>
</para>
@media:
@Returns:
<!-- ##### FUNCTION clutter_media_get_duration ##### -->
<para>
</para>
@media:
@Returns:
<!-- ##### FUNCTION clutter_media_set_filename ##### -->
<para>
</para>
@media:
@filename:

127
doc/reference/tmpl/clutter-rectangle.sgml
View File

@ -1,127 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterRectangle
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterRectangle ##### -->
<para>
#ClutterRectangle has no publicly available members.
</para>
<!-- ##### ARG ClutterRectangle:border-color ##### -->
<para>
</para>
<!-- ##### ARG ClutterRectangle:border-width ##### -->
<para>
</para>
<!-- ##### ARG ClutterRectangle:color ##### -->
<para>
</para>
<!-- ##### ARG ClutterRectangle:has-border ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterRectangleClass ##### -->
<para>
</para>
@parent_class:
@_clutter_rectangle1:
@_clutter_rectangle2:
@_clutter_rectangle3:
@_clutter_rectangle4:
<!-- ##### FUNCTION clutter_rectangle_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_rectangle_new_with_color ##### -->
<para>
</para>
@color:
@Returns:
<!-- ##### FUNCTION clutter_rectangle_get_color ##### -->
<para>
</para>
@rectangle:
@color:
<!-- ##### FUNCTION clutter_rectangle_set_color ##### -->
<para>
</para>
@rectangle:
@color:
<!-- ##### FUNCTION clutter_rectangle_get_border_color ##### -->
<para>
</para>
@rectangle:
@color:
<!-- ##### FUNCTION clutter_rectangle_set_border_color ##### -->
<para>
</para>
@rectangle:
@color:
<!-- ##### FUNCTION clutter_rectangle_get_border_width ##### -->
<para>
</para>
@rectangle:
@Returns:
<!-- ##### FUNCTION clutter_rectangle_set_border_width ##### -->
<para>
</para>
@rectangle:
@width:

268
doc/reference/tmpl/clutter-stage.sgml
View File

@ -1,268 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterStage
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_STAGE_WIDTH ##### -->
<para>
Macro evaluating to the width of the #ClutterStage
</para>
<!-- ##### MACRO CLUTTER_STAGE_HEIGHT ##### -->
<para>
Macro evaluating to the height of the #ClutterStage
</para>
<!-- ##### STRUCT ClutterPerspective ##### -->
<para>
</para>
@fovy:
@aspect:
@z_near:
@z_far:
<!-- ##### FUNCTION clutter_perspective_copy ##### -->
<para>
</para>
@perspective:
@Returns:
<!-- ##### FUNCTION clutter_perspective_free ##### -->
<para>
</para>
@perspective:
<!-- ##### STRUCT ClutterStage ##### -->
<para>
#ClutterStage has no publicly available members.
</para>
<!-- ##### SIGNAL ClutterStage::button-press-event ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterStage::button-release-event ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterStage::event ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterStage::event-after ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterStage::key-press-event ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterStage::key-release-event ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterStage::motion-event ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### SIGNAL ClutterStage::scroll-event ##### -->
<para>
</para>
@clutterstage: the object which received the signal.
@arg1:
<!-- ##### ARG ClutterStage:color ##### -->
<para>
</para>
<!-- ##### ARG ClutterStage:cursor-visible ##### -->
<para>
</para>
<!-- ##### ARG ClutterStage:fullscreen ##### -->
<para>
</para>
<!-- ##### ARG ClutterStage:offscreen ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterStageClass ##### -->
<para>
</para>
@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:
<!-- ##### FUNCTION clutter_stage_get_default ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_stage_set_color ##### -->
<para>
</para>
@stage:
@color:
<!-- ##### FUNCTION clutter_stage_get_color ##### -->
<para>
</para>
@stage:
@color:
<!-- ##### FUNCTION clutter_stage_fullscreen ##### -->
<para>
</para>
@stage:
<!-- ##### FUNCTION clutter_stage_unfullscreen ##### -->
<para>
</para>
@stage:
<!-- ##### FUNCTION clutter_stage_show_cursor ##### -->
<para>
</para>
@stage:
<!-- ##### FUNCTION clutter_stage_hide_cursor ##### -->
<para>
</para>
@stage:
<!-- ##### FUNCTION clutter_stage_get_actor_at_pos ##### -->
<para>
</para>
@stage:
@x:
@y:
@Returns:
<!-- ##### FUNCTION clutter_stage_snapshot ##### -->
<para>
</para>
@stage:
@x:
@y:
@width:
@height:
@Returns:
<!-- ##### FUNCTION clutter_stage_event ##### -->
<para>
</para>
@stage:
@event:
@Returns:

209
doc/reference/tmpl/clutter-texture.sgml
View File

@ -1,209 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterTexture
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterTexture ##### -->
<para>
#ClutterTexture has no publicly available members.
</para>
<!-- ##### SIGNAL ClutterTexture::pixbuf-change ##### -->
<para>
</para>
@cluttertexture: the object which received the signal.
<!-- ##### SIGNAL ClutterTexture::size-change ##### -->
<para>
</para>
@cluttertexture: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG ClutterTexture:filter-quality ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:pixbuf ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:pixel-format ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:pixel-type ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:repeat-x ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:repeat-y ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:sync-size ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:tile-waste ##### -->
<para>
</para>
<!-- ##### ARG ClutterTexture:tiled ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterTextureClass ##### -->
<para>
</para>
@parent_class:
@size_change:
@pixbuf_change:
@_clutter_texture1:
@_clutter_texture2:
@_clutter_texture3:
@_clutter_texture4:
@_clutter_texture5:
@_clutter_texture6:
<!-- ##### FUNCTION clutter_texture_new_from_pixbuf ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION clutter_texture_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_texture_set_pixbuf ##### -->
<para>
</para>
@texture:
@pixbuf:
@error:
@Returns:
<!-- ##### FUNCTION clutter_texture_get_pixbuf ##### -->
<para>
</para>
@texture:
@Returns:
<!-- ##### FUNCTION clutter_texture_get_base_size ##### -->
<para>
</para>
@texture:
@width:
@height:
<!-- ##### FUNCTION clutter_texture_bind_tile ##### -->
<para>
</para>
@texture:
@index:
<!-- ##### FUNCTION clutter_texture_get_n_tiles ##### -->
<para>
</para>
@texture:
@n_x_tiles:
@n_y_tiles:
<!-- ##### FUNCTION clutter_texture_get_x_tile_detail ##### -->
<para>
</para>
@texture:
@x_index:
@pos:
@size:
@waste:
<!-- ##### FUNCTION clutter_texture_get_y_tile_detail ##### -->
<para>
</para>
@texture:
@y_index:
@pos:
@size:
@waste:
<!-- ##### FUNCTION clutter_texture_has_generated_tiles ##### -->
<para>
</para>
@texture:
@Returns:
<!-- ##### FUNCTION clutter_texture_is_tiled ##### -->
<para>
</para>
@texture:
@Returns:

249
doc/reference/tmpl/clutter-timeline.sgml
View File

@ -1,249 +0,0 @@
<!-- ##### SECTION Title ##### -->
ClutterTimeline
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterTimeline ##### -->
<para>
#ClutterTimeline has no publicly available members.
</para>
<!-- ##### SIGNAL ClutterTimeline::completed ##### -->
<para>
The #ClutterTimeline has completed running.
</para>
@cluttertimeline: the object which received the signal.
<!-- ##### SIGNAL ClutterTimeline::new-frame ##### -->
<para>
</para>
@cluttertimeline: the object which received the signal.
@arg1: the frame number.
<!-- ##### SIGNAL ClutterTimeline::paused ##### -->
<para>
The #ClutterTimeline has been paused.
</para>
@cluttertimeline: the object which received the signal.
<!-- ##### SIGNAL ClutterTimeline::started ##### -->
<para>
The #ClutterTimeline has been started.
</para>
@cluttertimeline: the object which received the signal.
<!-- ##### ARG ClutterTimeline:delay ##### -->
<para>
</para>
<!-- ##### ARG ClutterTimeline:fps ##### -->
<para>
</para>
<!-- ##### ARG ClutterTimeline:loop ##### -->
<para>
</para>
<!-- ##### ARG ClutterTimeline:num-frames ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterTimelineClass ##### -->
<para>
</para>
@parent_class:
@started:
@completed:
@paused:
@new_frame:
@_clutter_timeline_1:
@_clutter_timeline_2:
@_clutter_timeline_3:
@_clutter_timeline_4:
@_clutter_timeline_5:
<!-- ##### FUNCTION clutter_timeline_new ##### -->
<para>
</para>
@n_frames:
@fps:
@Returns:
<!-- ##### FUNCTION clutter_timeline_clone ##### -->
<para>
</para>
@timeline:
@Returns:
<!-- ##### FUNCTION clutter_timeline_set_speed ##### -->
<para>
</para>
@timeline:
@fps:
<!-- ##### FUNCTION clutter_timeline_get_speed ##### -->
<para>
</para>
@timeline:
@Returns:
<!-- ##### FUNCTION clutter_timeline_start ##### -->
<para>
</para>
@timeline:
<!-- ##### FUNCTION clutter_timeline_pause ##### -->
<para>
</para>
@timeline:
<!-- ##### FUNCTION clutter_timeline_stop ##### -->
<para>
</para>
@timeline:
<!-- ##### FUNCTION clutter_timeline_set_loop ##### -->
<para>
</para>
@timeline:
@loop:
<!-- ##### FUNCTION clutter_timeline_get_loop ##### -->
<para>
</para>
@timeline:
@Returns:
<!-- ##### FUNCTION clutter_timeline_rewind ##### -->
<para>
</para>
@timeline:
<!-- ##### FUNCTION clutter_timeline_skip ##### -->
<para>
</para>
@timeline:
@n_frames:
<!-- ##### FUNCTION clutter_timeline_advance ##### -->
<para>
</para>
@timeline:
@frame_num:
<!-- ##### FUNCTION clutter_timeline_get_current_frame ##### -->
<para>
</para>
@timeline:
@Returns:
<!-- ##### FUNCTION clutter_timeline_set_n_frames ##### -->
<para>
</para>
@timeline:
@n_frames:
<!-- ##### FUNCTION clutter_timeline_get_n_frames ##### -->
<para>
</para>
@timeline:
@Returns:
<!-- ##### FUNCTION clutter_timeline_is_playing ##### -->
<para>
</para>
@timeline:
@Returns:
<!-- ##### FUNCTION clutter_timeline_set_delay ##### -->
<para>
</para>
@timeline:
@msecs:
<!-- ##### FUNCTION clutter_timeline_get_delay ##### -->
<para>
</para>
@timeline:
@Returns:

118
doc/reference/tmpl/clutter-units.sgml
View File

@ -1,118 +0,0 @@
<!-- ##### SECTION Title ##### -->
Clutter Units
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_UNITS_FROM_DEVICE ##### -->
<para>
Macro for converting from device units to #ClutterUnit.
</para>
@x: int
<!-- ##### MACRO CLUTTER_UNITS_FROM_FIXED ##### -->
<para>
Macro for converting from #ClutterFixed pixels to #ClutterUnit.
</para>
@x: #ClutterFixed
<!-- ##### MACRO CLUTTER_UNITS_FROM_FLOAT ##### -->
<para>
Macro for converting from floating point pixels to #ClutterUnit.
</para>
@x: float
<!-- ##### MACRO CLUTTER_UNITS_FROM_INT ##### -->
<para>
Macro for converting from pixels to #ClutterUnit.
</para>
@x: int
<!-- ##### MACRO CLUTTER_UNITS_FROM_PANGO_UNIT ##### -->
<para>
Macro for converting from Pango units to #ClutterUnit.
</para>
@x: int
<!-- ##### MACRO CLUTTER_UNITS_TMP_FROM_DEVICE ##### -->
<para>
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 -&gt; #ClutterUnit
conversion.
</para>
@x: int
<!-- ##### MACRO CLUTTER_UNITS_TMP_TO_DEVICE ##### -->
<para>
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 -&gt;
pixel conversion.
</para>
@x: int
<!-- ##### MACRO CLUTTER_UNITS_TO_DEVICE ##### -->
<para>
Macro for conversion from #ClutterUnit values to device unit (currently
pixels).
</para>
@x: #ClutterUnit
<!-- ##### MACRO CLUTTER_UNITS_TO_FIXED ##### -->
<para>
Macro for conversion of #ClutterUnit value to #ClutterFixed pixel value.
</para>
@x: #ClutterUnit
<!-- ##### MACRO CLUTTER_UNITS_TO_FLOAT ##### -->
<para>
Macro for conversion of #ClutterUnit value to floating point pixel value.
</para>
@x: #ClutterUnit
<!-- ##### MACRO CLUTTER_UNITS_TO_INT ##### -->
<para>
Macro for conversion of #ClutterUnit value to int pixel value.
</para>
@x: #ClutterUnit

28
doc/reference/tmpl/clutter-util.sgml
View File

@ -1,28 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-util
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION clutter_util_next_p2 ##### -->
<para>
</para>
@a:
@Returns:

80
doc/reference/tmpl/clutter-version.sgml
View File

@ -1,80 +0,0 @@
<!-- ##### SECTION Title ##### -->
clutter-version
<!-- ##### SECTION Short_Description ##### -->
Versioning utilities
<!-- ##### SECTION Long_Description ##### -->
<para>
Clutter exports some macros representing the version at compile time. These
macros are useful for configure and compile time checks.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_MAJOR_VERSION ##### -->
<para>
The major version component of Clutter version
</para>
<!-- ##### MACRO CLUTTER_MINOR_VERSION ##### -->
<para>
The minor version component of Clutter version
</para>
<!-- ##### MACRO CLUTTER_MICRO_VERSION ##### -->
<para>
The micro version component of Clutter version
</para>
<!-- ##### MACRO CLUTTER_VERSION ##### -->
<para>
The Clutter version
</para>
<!-- ##### MACRO CLUTTER_VERSION_S ##### -->
<para>
The Clutter version as a string
</para>
<!-- ##### MACRO CLUTTER_VERSION_HEX ##### -->
<para>
The Clutter version as a hexadecimal number
</para>
<!-- ##### MACRO CLUTTER_CHECK_VERSION ##### -->
<para>
Returns TRUE if the version of the Clutter header files is the same as or newer
than the passed-in version.
</para>
@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)
<!-- ##### MACRO CLUTTER_FLAVOUR ##### -->
<para>
</para>