isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-26 01:50:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Even more documentation fixes

Browse Source
This commit is contained in:
Emmanuele Bassi 2007-08-07 14:03:58 +00:00
parent 790ef05b46
commit f57edd70d3
17 changed files with 225 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
clutter/clutter-behaviour-ellipse.c
View File

@ -1196,7 +1196,7 @@ clutter_behaviour_ellipse_get_tilt (ClutterBehaviourEllipse *self,
}
/**
* clutter_behaviour_ellipse_get_angle_tilt_yx
* clutter_behaviour_ellipse_get_tiltx
* @self: a #ClutterBehaviourEllipse
* @angle_tilt_x: #ClutterAngle location for tilt of the elipse around the
* center in X axis, or NULL.

14
clutter/clutter-behaviour-ellipse.h
View File

@ -61,17 +61,31 @@ typedef struct _ClutterBehaviourEllipseClass ClutterBehaviourEllipseClass;
struct _ClutterBehaviourEllipse
{
/*< private >*/
ClutterBehaviour parent_instance;
ClutterBehaviourEllipsePrivate *priv;
};
/**
* ClutterBehaviourEllipseClass
* @knot_reached: signal class handler for the
* ClutterBehaviourEllipse::knot_reached signal
*
* Ellipse behaviour class
*
* Since: 0.4
*/
struct _ClutterBehaviourEllipseClass
{
/*< private >*/
ClutterBehaviourClass parent_class;
/*< public >*/
void (*knot_reached) (ClutterBehaviourEllipse *ellipseb,
const ClutterKnot *knot);
/*< private >*/
/* padding, for future expansion */
void (*_clutter_ellipse_1) (void);
void (*_clutter_ellipse_2) (void);
void (*_clutter_ellipse_3) (void);

11
clutter/clutter-behaviour-path.h
View File

@ -61,17 +61,28 @@ typedef struct _ClutterBehaviourPathClass ClutterBehaviourPathClass;
struct _ClutterBehaviourPath
{
/*< private >*/
ClutterBehaviour parent;
ClutterBehaviourPathPrivate *priv;
};
/**
* ClutterBehaviourPathClass
* @knot_reached: signal class handler for the
* ClutterBehaviourPath::knot_reached signal
*
* Since 0.2
*/
struct _ClutterBehaviourPathClass
{
/*< private >*/
ClutterBehaviourClass parent_class;
/*< public >*/
void (*knot_reached) (ClutterBehaviourPath *pathb,
const ClutterKnot *knot);
/*< private >*/
void (*_clutter_path_1) (void);
void (*_clutter_path_2) (void);
void (*_clutter_path_3) (void);

22
clutter/clutter-behaviour-rotate.c
View File

@ -616,6 +616,16 @@ clutter_behaviour_rotate_get_bounds (ClutterBehaviourRotate *rotate,
*angle_end = CLUTTER_FIXED_TO_DOUBLE (priv->angle_end);
}
/**
* clutter_behaviour_rotate_set_bounds:
* @rotate: a #ClutterBehaviourRotate
* @angle_begin: initial angle
* @angle_end: final angle
*
* Sets the initial and final angles of a rotation behaviour.
*
* Since: 0.4
*/
void
clutter_behaviour_rotate_set_bounds (ClutterBehaviourRotate *rotate,
gdouble angle_begin,
@ -629,7 +639,7 @@ clutter_behaviour_rotate_set_bounds (ClutterBehaviourRotate *rotate,
}
/**
* clutter_behaviour_rotate_get_bounds:
* clutter_behaviour_rotate_get_boundsx:
* @rotate: a #ClutterBehaviourRotate
* @angle_begin: return value for the initial angle
* @angle_end: return value for the final angle
@ -657,6 +667,16 @@ clutter_behaviour_rotate_get_boundsx (ClutterBehaviourRotate *rotate,
*angle_end = priv->angle_end;
}
/**
* clutter_behaviour_rotate_set_boundsx:
* @rotate: a #ClutterBehaviourRotate
* @angle_begin: initial angle, in fixed point notation
* @angle_end: final angle, in fixed point notation
*
* Fixed point version of clutter_behaviour_rotate_set_bounds().
*
* Since: 0.4
*/
void
clutter_behaviour_rotate_set_boundsx (ClutterBehaviourRotate *rotate,
ClutterFixed angle_begin,

21
clutter/clutter-behaviour.h
View File

@ -61,13 +61,15 @@ typedef struct _ClutterBehaviourPrivate ClutterBehaviourPrivate;
typedef struct _ClutterBehaviourClass ClutterBehaviourClass;
/**
* ClutterBehaviourFunction:
* ClutterBehaviourForeachFunc:
* @behaviour: the #ClutterBehaviour
* @actor: an actor driven by @behaviour
* @data: optional data passed to the function
*
* This function is passed to clutter_behaviour_foreach_actor() and
* will be called for each actor driven by @behaviour.
*
* Since: 0.2
*/
typedef void (*ClutterBehaviourForeachFunc) (ClutterBehaviour *behaviour,
ClutterActor *actor,
@ -80,19 +82,36 @@ struct _ClutterBehaviour
ClutterBehaviourPrivate *priv;
};
/**
* ClutterBehaviourClass
* @alpha_notify: virtual function, called each time the #ClutterAlpha
* computes a new alpha value; the actors to which the behaviour applies
* should be changed in this function. Every subclass of #ClutterBehaviour
* must implement this virtual function
* @applied: signal class handler for the ClutterBehaviour::applied signal
* @removed: signal class handler for the ClutterBehaviour::removed signal
*
* Base class for behaviours.
*
* Since: 0.2
*/
struct _ClutterBehaviourClass
{
/*< private >*/
GObjectClass parent_class;
/*< public >*/
/* vfunc, not signal */
void (*alpha_notify) (ClutterBehaviour *behave,
guint32 alpha_value);
/* signals */
void (*applied) (ClutterBehaviour *behave,
ClutterActor *actor);
void (*removed) (ClutterBehaviour *behave,
ClutterActor *actor);
/*< private >*/
/* padding, for future expansion */
void (*_clutter_behaviour1) (void);
void (*_clutter_behaviour2) (void);

17
clutter/clutter-box.h
View File

@ -33,9 +33,8 @@ typedef struct _ClutterBoxClass ClutterBoxClass;
struct _ClutterBox
{
ClutterActor parent_instance;
/*< private >*/
ClutterActor parent_instance;
/* We need to put these in the instance structure, since this
* is an abstract class meant to be subclassed; think of these
@ -58,16 +57,30 @@ struct _ClutterBox
ClutterPadding default_padding;
};
/**
* ClutterBoxClass:
* @pack_child: virtual function, called when packing a new child. All
* #ClutterBox subclasses must implement this function
* @unpack_child: virtual function, called when unpacking a child. All
* #ClutterBox subclasses must implement this function
*
* Base class for layout containers
*
* Since: 0.4
*/
struct _ClutterBoxClass
{
/*< private >*/
ClutterActorClass parent_class;
/*< public >*/
/* vfuncs, not signals */
void (* pack_child) (ClutterBox *box,
ClutterBoxChild *child);
void (* unpack_child) (ClutterBox *box,
ClutterBoxChild *child);
/*< private >*/
/* padding, for future expansion */
void (*_clutter_reserved1) (void);
void (*_clutter_reserved2) (void);

9
clutter/clutter-color.h
View File

@ -35,6 +35,15 @@ G_BEGIN_DECLS
typedef struct _ClutterColor ClutterColor;
/**
* ClutterColor:
* @red: red component, between 0 and 255
* @green: green component, between 0 and 255
* @blue: blue component, between 0 and 255
* @alpha: alpha component, between 0 and 255
*
* Color representation.
*/
struct _ClutterColor
{
guint8 red;

14
clutter/clutter-container.h
View File

@ -41,10 +41,24 @@ G_BEGIN_DECLS
typedef struct _ClutterContainer ClutterContainer; /* dummy */
typedef struct _ClutterContainerIface ClutterContainerIface;
/**
* ClutterContainerIface:
* @add: virtual function for adding an actor to the container
* @remove: virtual function for removing an actor from the container
* @foreach: virtual function for iterating over the container's children
* @actor_added: signal class handler for ClutterContainer::actor_added
* @actor_removed: signal class handler for ClutterContainer::actor_removed
*
* Base interface for container actors.
*
* Since: 0.4
*/
struct _ClutterContainerIface
{
/*< private >*/
GTypeInterface g_iface;
/*< public >*/
void (* add) (ClutterContainer *container,
ClutterActor *actor);
void (* remove) (ClutterContainer *container,

15
clutter/clutter-effect.h
View File

@ -34,6 +34,15 @@
G_BEGIN_DECLS
/**
* ClutterEffectCompleteFunc:
* @actor: a #ClutterActor
* @user_data: user data
*
* Callback function invoked when an effect is complete.
*
* Since: 0.4
*/
typedef void (*ClutterEffectCompleteFunc) (ClutterActor *actor,
gpointer user_data);
@ -66,17 +75,16 @@ typedef struct _ClutterEffectTemplateClass ClutterEffectTemplateClass;
struct _ClutterEffectTemplate
{
/*< private >*/
GObject parent_instance;
/*< private >*/
ClutterEffectTemplatePrivate *priv;
};
struct _ClutterEffectTemplateClass
{
GObjectClass parent_class;
/*< private >*/
GObjectClass parent_class;
/* padding, for future expansion */
void (*_clutter_reserved1) (void);
@ -150,4 +158,3 @@ ClutterTimeline * clutter_effect_rotate_z (ClutterEffectTemplate *template_,
G_END_DECLS
#endif /* _CLUTTER_EFFECT */

14
clutter/clutter-entry.h
View File

@ -69,10 +69,24 @@ struct _ClutterEntry
ClutterEntryPrivate *priv;
};
/**
* ClutterEntryClass:
* @paint_cursor: virtual function for subclasses to use to draw a custom
* cursor instead of the default one
* @text_changed: signal class handler for ClutterEntry::text-changed
* @cursor_event: signal class handler for ClutterEntry::cursor-event
* @activate: signal class handler for ClutterEntry::activate
*
* Class fo entry actors.
*
* Since: 0.4
*/
struct _ClutterEntryClass
{
/*< private >*/
ClutterActorClass parent_class;
/*< public >*/
/* vfuncs, not signals */
void (* paint_cursor) (ClutterEntry *entry);

18
clutter/clutter-fixed.h
View File

@ -155,6 +155,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FIXED_TO_FLOAT:
* @x: a fixed point value
*
* Convert a fixed point value to float.
*/
@ -162,6 +163,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FIXED_TO_DOUBLE:
* @x: a fixed point value
*
* Convert a fixed point value to double.
*/
@ -169,6 +171,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FLOAT_TO_FIXED:
* @x: a floating point value
*
* Convert a float value to fixed.
*/
@ -176,6 +179,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FLOAT_TO_INT:
* @x: a floating point value
*
* Convert a float value to int.
*/
@ -183,6 +187,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FLOAT_TO_UINT:
* @x: a floating point value
*
* Convert a float value to unsigned int.
*/
@ -190,6 +195,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_INT_TO_FIXED:
* @x: an integer value
*
* Convert an integer value to fixed point.
*/
@ -197,6 +203,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FIXED_INT:
* @x: a fixed point value
*
* Convert a fixed point value to integer (removing decimal part).
*/
@ -204,6 +211,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FIXED_FRACTION:
* @x: a fixed point value
*
* FIXME
*/
@ -211,6 +219,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FIXED_FLOOR:
* @x: a fixed point value
*
* Round down a fixed point value to an integer.
*/
@ -218,6 +227,7 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
: ~((~(x)) >> CFX_Q))
/**
* CLUTTER_FIXED_CEIL:
* @x: a fixed point value
*
* Round up a fixed point value to an integer.
*/
@ -225,15 +235,19 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */
/**
* CLUTTER_FIXED_MUL:
* @x: a fixed point value
* @y: a fixed point value
*
* Multiply two fixed point values
*/
#define CLUTTER_FIXED_MUL(x,y) ((x) >> 8) * ((y) >> 8)
/**
* CLUTTER_FIXED_MUL:
* CLUTTER_FIXED_DIV:
* @x: a fixed point value
* @y: a fixed point value
*
* Devide two fixed point values
* Divide two fixed point values
*/
#define CLUTTER_FIXED_DIV(x,y) ((((x) << 8)/(y)) << 8)

14
clutter/clutter-layout.h
View File

@ -63,10 +63,24 @@ typedef enum {
typedef struct _ClutterLayout ClutterLayout; /* dummy */
typedef struct _ClutterLayoutIface ClutterLayoutIface;
/**
* ClutterLayoutIface:
* @get_layout_flags: Retrieve the layout mode used by the actor
* @width_for_height: Compute width for a given height
* @height_for_width: Compute height for a given width
* @natural_request: Natural size of an actor
* @tune_request: Iterative size allocation
*
* Interface for extended layout support in actors.
*
* Since: 0.4
*/
struct _ClutterLayoutIface
{
/*< private >*/
GTypeInterface g_iface;
/*< public >*/
/* Retrieve the layout mode used by the actor */
ClutterLayoutFlags (* get_layout_flags) (ClutterLayout *layout);

14
clutter/clutter-main.h
View File

@ -33,9 +33,21 @@ G_BEGIN_DECLS
#define CLUTTER_INIT_ERROR (clutter_init_error_quark ())
/**
* ClutterInitError:
* @CLUTTER_INIT_SUCCESS: Initialisation successful
* @CLUTTER_INIT_ERROR_UNKNOWN: Unknown error
* @CLUTTER_INIT_ERROR_THREADS: Thread initialisation failed
* @CLUTTER_INIT_ERROR_BACKEND: Backend initialisation failed
* @CLUTTER_INIT_ERROR_INTERNAL: Internal error
*
* Error conditions returned by clutter_init() and clutter_init_with_args().
*
* Since: 0.2
*/
typedef enum {
CLUTTER_INIT_SUCCESS = 1,
CLUTTER_INIT_ERROR_UNKOWN = 0,
CLUTTER_INIT_ERROR_UNKNOWN = 0,
CLUTTER_INIT_ERROR_THREADS = -1,
CLUTTER_INIT_ERROR_BACKEND = -2,
CLUTTER_INIT_ERROR_INTERNAL = -3

20
clutter/clutter-stage.h
View File

@ -33,6 +33,7 @@
G_BEGIN_DECLS
#define CLUTTER_TYPE_PERSPECTIVE (clutter_perspective_get_type ())
#define CLUTTER_TYPE_STAGE (clutter_stage_get_type())
#define CLUTTER_STAGE(obj) \
@ -61,22 +62,25 @@ G_BEGIN_DECLS
#define CLUTTER_STAGE_HEIGHT() \
clutter_actor_get_height (clutter_stage_get_default ())
typedef struct _ClutterPerspective ClutterPerspective;
typedef struct _ClutterStage ClutterStage;
typedef struct _ClutterStageClass ClutterStageClass;
typedef struct _ClutterStagePrivate ClutterStagePrivate;
struct _ClutterStage
{
/*< private >*/
ClutterGroup parent_instance;
/*< private >*/
ClutterStagePrivate *priv;
};
struct _ClutterStageClass
{
/*< private >*/
ClutterGroupClass parent_class;
/*< public >*/
/* vfuncs, not signals */
void (* set_fullscreen) (ClutterStage *stage,
gboolean fullscreen);
@ -119,10 +123,19 @@ struct _ClutterStageClass
gpointer _padding_dummy[32];
};
#define CLUTTER_TYPE_PERSPECTIVE (clutter_perspective_get_type ())
typedef struct _ClutterPerspective ClutterPerspective;
/**
* ClutterPerspective:
* @fovy: FIXME
* @aspect: FIXME
* @z_near: FIXME
* @z_far: FIXME
*
* Stage perspective definition
*
* Since: 0.4
*/
struct _ClutterPerspective
{
ClutterFixed fovy;
@ -134,6 +147,7 @@ struct _ClutterPerspective
GType clutter_perspective_get_type (void) G_GNUC_CONST;
ClutterPerspective *clutter_perspective_copy (const ClutterPerspective *perspective);
void clutter_perspective_free (ClutterPerspective *perspective);
GType clutter_stage_get_type (void) G_GNUC_CONST;
ClutterActor *clutter_stage_get_default (void);

23
clutter/clutter-texture.h
View File

@ -38,6 +38,16 @@ G_BEGIN_DECLS
#define CLUTTER_IS_TEXTURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_TEXTURE))
#define CLUTTER_TEXTURE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_TEXTURE, ClutterTextureClass))
/**
* ClutterTextureError:
* @CLUTTER_TEXTURE_ERROR_OUT_OF_MEMORY: OOM condition
* @CLUTTER_TEXTURE_ERROR_NO_YUV: YUV operation attempted but no YUV support
* found
*
* Error enumeration for #ClutterTexture
*
* Since: 0.4
*/
typedef enum {
CLUTTER_TEXTURE_ERROR_OUT_OF_MEMORY,
CLUTTER_TEXTURE_ERROR_NO_YUV
@ -52,6 +62,7 @@ typedef struct _ClutterTexturePrivate ClutterTexturePrivate;
struct _ClutterTexture
{
/*< private >*/
ClutterActor parent;
ClutterTexturePrivate *priv;
@ -66,6 +77,7 @@ struct _ClutterTextureClass
gint height);
void (*pixbuf_change) (ClutterTexture *texture);
/*< private >*/
/* padding, for future expansion */
void (*_clutter_texture1) (void);
void (*_clutter_texture2) (void);
@ -75,6 +87,17 @@ struct _ClutterTextureClass
void (*_clutter_texture6) (void);
};
/**
* ClutterTextureFlags:
* @CLUTTER_TEXTURE_RGB_FLAG_BGR: FIXME
* @CLUTTER_TEXTURE_RGB_FLAG_PREMULT: FIXME
* @CLUTTER_TEXTURE_YUV_FLAG_YUV2: FIXME
*
* Flags for clutter_texture_set_from_rgb_data() and
* clutter_texture_set_from_rgb_data().
*
* Since: 0.4
*/
typedef enum { /*< prefix=CLUTTER_TEXTURE >*/
CLUTTER_TEXTURE_RGB_FLAG_BGR = 1 << 1,
CLUTTER_TEXTURE_RGB_FLAG_PREMULT = 1 << 2, /* FIXME: not handled */

8
clutter/clutter-units.h
View File

@ -51,6 +51,14 @@
G_BEGIN_DECLS
/**
* ClutterUnit:
*
* Device independent unit used by Clutter. The value held can be transformed
* into other units, likes pixels.
*
* Since: 0.4
*/
typedef gint32 ClutterUnit;
/*

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

@ -414,7 +414,6 @@ CLUTTER_STAGE_HEIGHT
ClutterPerspective
clutter_perspective_copy
clutter_perspective_free
ClutterStageClass
clutter_stage_get_default
clutter_stage_set_color
clutter_stage_get_color
@ -435,6 +434,7 @@ clutter_stage_set_user_resizable
clutter_stage_get_user_resizable
<SUBSECTION Standard>
ClutterStage
ClutterStageClass
CLUTTER_STAGE
CLUTTER_IS_STAGE
CLUTTER_TYPE_STAGE
@ -451,7 +451,6 @@ clutter_perspective_get_type
<SECTION>
<FILE>clutter-timeline</FILE>
<TITLE>ClutterTimeline</TITLE>
ClutterTimelineClass
clutter_timeline_new
clutter_timeline_clone
clutter_timeline_set_speed
@ -472,6 +471,7 @@ clutter_timeline_set_delay
clutter_timeline_get_delay
<SUBSECTION Standard>
ClutterTimeline
ClutterTimelineClass
CLUTTER_TIMELINE
CLUTTER_IS_TIMELINE
CLUTTER_TYPE_TIMELINE
@ -824,7 +824,6 @@ clutter_event_get_type
<SECTION>
<FILE>clutter-main</FILE>
<TITLE>General</TITLE>
CLUTTER_INIT_ERROR
ClutterInitError
clutter_init
clutter_init_with_args
@ -835,6 +834,8 @@ clutter_main
clutter_main_quit
clutter_main_level
clutter_get_timestamp
<SUBSECTION Standard>
CLUTTER_INIT_ERROR
<SUBSECTION Private>
clutter_init_error_quark
clutter_base_init