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

2008-06-12 Emmanuele Bassi <ebassi@openedhand.com>

Browse Source 
* clutter/clutter-actor.[ch]: Documentation fixes.

	* clutter/clutter-backend.c: Documentation fixes.

	* clutter/clutter-container.h: Documentation fixes.

	* clutter/clutter-fixed.c (clutter_qdivx): Fix the return
	value to be after the description.

	* clutter/clutter-texture.[ch]: Documentation fixes.

	* clutter/clutter-timeline.c: Documentation fixes.
This commit is contained in:
Emmanuele Bassi 2008-06-12 11:43:25 +00:00
parent a617fc4cdf
commit 8ff6cec829
9 changed files with 120 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
ChangeLog
View File

@ -1,3 +1,18 @@
2008-06-12 Emmanuele Bassi <ebassi@openedhand.com>
* clutter/clutter-actor.[ch]: Documentation fixes.
* clutter/clutter-backend.c: Documentation fixes.
* clutter/clutter-container.h: Documentation fixes.
* clutter/clutter-fixed.c (clutter_qdivx): Fix the return
value to be after the description.
* clutter/clutter-texture.[ch]: Documentation fixes.
* clutter/clutter-timeline.c: Documentation fixes.
2008-06-11 Emmanuele Bassi <ebassi@openedhand.com> 2008-06-11 Emmanuele Bassi <ebassi@openedhand.com>
* tests/test-layout.c: Take into account the origin of the * tests/test-layout.c: Take into account the origin of the

6
clutter/clutter-actor.c
View File

@ -3085,8 +3085,8 @@ clutter_actor_get_preferred_size (ClutterActor *self,
* @self: A #ClutterActor * @self: A #ClutterActor
* @for_height: available height when computing the preferred width, * @for_height: available height when computing the preferred width,
* or a negative value to indicate that no height is defined * or a negative value to indicate that no height is defined
* @min_width_p: return location for min width, or %NULL * @min_width_p: return location for minimum width, or %NULL
* @natural_width_p: return location for min width, or %NULL * @natural_width_p: return location for the natural width, or %NULL
* *
* Computes the requested minimum and natural widths for an actor, * Computes the requested minimum and natural widths for an actor,
* optionally depending on the specified height, or if they are * optionally depending on the specified height, or if they are
@ -3156,7 +3156,7 @@ clutter_actor_get_preferred_width (ClutterActor *self,
* @self: A #ClutterActor * @self: A #ClutterActor
* @for_width: available width to assume in computing desired height, * @for_width: available width to assume in computing desired height,
* or a negative value to indicate that no width is defined * or a negative value to indicate that no width is defined
* @min_height_p: return location for min height, or %NULL * @min_height_p: return location for minimum height, or %NULL
* @natural_height_p: return location for natural height, or %NULL * @natural_height_p: return location for natural height, or %NULL
* *
* Computes the requested minimum and natural heights for an actor, * Computes the requested minimum and natural heights for an actor,

26
clutter/clutter-actor.h
View File

@ -174,23 +174,23 @@ struct _ClutterActor
* @unrealize: virtual function, used to deallocate resources allocated * @unrealize: virtual function, used to deallocate resources allocated
* in ::realize; it should chain up to the parent's implementation * in ::realize; it should chain up to the parent's implementation
* @paint: virtual function, used to paint the actor * @paint: virtual function, used to paint the actor
* @get_preferred_width: virtual function, used when querying the minimum and * @get_preferred_width: virtual function, used when querying the minimum
* natural widths of an actor * and natural widths of an actor for a given height; it is used by
* @get_preferred_height: virtual function, used when querying the minimum and * clutter_actor_get_preferred_width()
* natural heights of an actor * @get_preferred_height: virtual function, used when querying the minimum
* and natural heights of an actor for a given width; it is used by
* clutter_actor_get_preferred_height()
* @allocate: virtual function, used when settings the coordinates of an * @allocate: virtual function, used when settings the coordinates of an
* actor * actor; it is used by clutter_actor_allocate()
* @get_paint_area: virtual function, used when querying the untrasformed * @get_paint_area: virtual function, used when querying the untrasformed
* bounding box of an actor; it's used internally by * bounding box of an actor; it's used by clutter_actor_get_paint_area()
* clutter_actor_get_stage_area() * @parent_set: signal class handler for the #ClutterActor::parent-set
* @parent_set: signal class closure for the #ClutterActor::parent-set * @destroy: signal class handler for #ClutterActor::destroy
* @destroy: signal class closure for #ClutterActor::destroy
* @pick: virtual function, used to draw an outline of the actor with * @pick: virtual function, used to draw an outline of the actor with
* the given color * the given color
* @event: signal class closure for #ClutterActor::event * @event: class handler for #ClutterActor::event
* @button_press_event: signal class closure for * @button_press_event: class handler for #ClutterActor::button-press-event
* #ClutterActor::button-press-event * @button_release_event: class handler for
* @button_release_event: signal class closure for
* #ClutterActor::button-release-event * #ClutterActor::button-release-event
* @scroll_event: signal class closure for #ClutterActor::scroll-event * @scroll_event: signal class closure for #ClutterActor::scroll-event
* @key_press_event: signal class closure for #ClutterActor::key-press-event * @key_press_event: signal class closure for #ClutterActor::key-press-event

24
clutter/clutter-backend.c
View File

@ -412,6 +412,20 @@ clutter_backend_get_resolution (ClutterBackend *backend)
return CLUTTER_FIXED_TO_FLOAT (backend->priv->resolution); return CLUTTER_FIXED_TO_FLOAT (backend->priv->resolution);
} }
/**
* clutter_backend_set_font_options:
* @backend: a #ClutterBackend
* @options: Cairo font options for the backend, or %NULL
*
* Sets the new font options for @backend. If @options is %NULL,
* the first following call to clutter_backend_get_font_options()
* will return the default font options for @backend.
*
* This function is intended for actors creating a Pango layout
* using the PangoCairo API.
*
* Since: 0.8
*/
void void
clutter_backend_set_font_options (ClutterBackend *backend, clutter_backend_set_font_options (ClutterBackend *backend,
cairo_font_options_t *options) cairo_font_options_t *options)
@ -434,6 +448,16 @@ clutter_backend_set_font_options (ClutterBackend *backend,
} }
} }
/**
* clutter_backend_get_font_options:
* @backend: a #ClutterBackend
*
* Retrieves the font options for @backend.
*
* Return value: the font options of the #ClutterBackend
*
* Since: 0.8
*/
cairo_font_options_t * cairo_font_options_t *
clutter_backend_get_font_options (ClutterBackend *backend) clutter_backend_get_font_options (ClutterBackend *backend)
{ {

7
clutter/clutter-container.h
View File

@ -61,9 +61,10 @@ typedef struct _ClutterContainerIface ClutterContainerIface;
* @destroy_child_meta: virtual function that gets called when a child is * @destroy_child_meta: virtual function that gets called when a child is
* removed; it shuld release all resources held by the record * removed; it shuld release all resources held by the record
* @get_child_meta: return the record for a container child * @get_child_meta: return the record for a container child
* @actor_added: signal class handler for #ClutterContainer::actor_added * @actor_added: class handler for #ClutterContainer::actor_added
* @actor_removed: signal class handler for #ClutterContainer::actor_removed * @actor_removed: class handler for #ClutterContainer::actor_removed
* * @child_notify: class handler for #ClutterContainer::child-notify
*
* Base interface for container actors. * Base interface for container actors.
* *
* Since: 0.4 * Since: 0.4

9
clutter/clutter-fixed.c
View File

@ -935,18 +935,19 @@ clutter_qmulx (ClutterFixed op1, ClutterFixed op2)
* @op1: #ClutterFixed * @op1: #ClutterFixed
* @op2: #ClutterFixed * @op2: #ClutterFixed
* *
* Return value: #ClutterFixed.
*
* Divides two fixed values using 64bit arithmetic; this provides * Divides two fixed values using 64bit arithmetic; this provides
* significantly better precission than the #CLUTTER_FIXED_DIV macro, * significantly better precission than the #CLUTTER_FIXED_DIV macro,
* but at performance cost. * but at performance cost.
* *
* Return value: #ClutterFixed
*
* Since: 0.4 * Since: 0.4
*/ */
ClutterFixed ClutterFixed
clutter_qdivx (ClutterFixed op1, ClutterFixed op2) clutter_qdivx (ClutterFixed op1,
ClutterFixed op2)
{ {
return (ClutterFixed)((((gint64)op1) << CFX_Q) / op2); return (ClutterFixed) ((((gint64) op1) << CFX_Q) / op2);
} }
/* /*

19
clutter/clutter-texture.c
View File

@ -1208,18 +1208,18 @@ clutter_texture_set_from_file (ClutterTexture *texture,
} }
/** /**
* clutter_texture_set_filter_quality * clutter_texture_set_filter_quality:
* @texture: A #ClutterTexture * @texture: a #ClutterTexture
* @filter_quality: New filter quality value * @filter_quality: new filter quality value
* *
* Sets the filter quality when scaling a texture. The quality is an * Sets the filter quality when scaling a texture. The quality is an
* enumeration currently the following values are supported: * enumeration currently the following values are supported:
* CLUTTER_TEXTURE_QUALITY_LOW which is fast but only uses nearest neighbour * %CLUTTER_TEXTURE_QUALITY_LOW which is fast but only uses nearest neighbour
* interpolation. CLUTTER_TEXTURE_QUALITY_MEDIUM which is computationally a bit * interpolation. %CLUTTER_TEXTURE_QUALITY_MEDIUM which is computationally a
* more expensive (bilinear interpolation), and CLUTTER_TEXTURE_QUALITY_HIGH * bit more expensive (bilinear interpolation), and
* which uses extra texture memory resources to improve scaled down rendering * %CLUTTER_TEXTURE_QUALITY_HIGH which uses extra texture memory resources to
* as well (it uses mipmaps). The default value is * improve scaled down rendering as well (by using mipmaps). The default value
* CLUTTER_TEXTURE_QUALITY_MEDIUM. * is %CLUTTER_TEXTURE_QUALITY_MEDIUM.
* *
* Since: 0.8 * Since: 0.8
*/ */
@ -1243,6 +1243,7 @@ clutter_texture_set_filter_quality (ClutterTexture *texture,
cogl_texture_set_filters (priv->texture, cogl_texture_set_filters (priv->texture,
clutter_texture_quality_to_cogl_min_filter (priv->filter_quality), clutter_texture_quality_to_cogl_min_filter (priv->filter_quality),
clutter_texture_quality_to_cogl_mag_filter (priv->filter_quality)); clutter_texture_quality_to_cogl_mag_filter (priv->filter_quality));
if ((old_quality == CLUTTER_TEXTURE_QUALITY_HIGH || if ((old_quality == CLUTTER_TEXTURE_QUALITY_HIGH ||
filter_quality == CLUTTER_TEXTURE_QUALITY_HIGH) && filter_quality == CLUTTER_TEXTURE_QUALITY_HIGH) &&
CLUTTER_ACTOR_IS_REALIZED (texture)) CLUTTER_ACTOR_IS_REALIZED (texture))

94
clutter/clutter-texture.h
View File

@ -131,55 +131,51 @@ typedef enum { /*< prefix=CLUTTER_TEXTURE_QUALITY >*/
GType clutter_texture_get_type (void) G_GNUC_CONST; GType clutter_texture_get_type (void) G_GNUC_CONST;
GType clutter_texture_handle_get_type (void) G_GNUC_CONST; GType clutter_texture_handle_get_type (void) G_GNUC_CONST;
ClutterActor *clutter_texture_new (void); ClutterActor * clutter_texture_new (void);
ClutterActor *clutter_texture_new_from_file (const gchar *filename, ClutterActor * clutter_texture_new_from_file (const gchar *filename,
GError **error); GError **error);
gboolean clutter_texture_set_from_file (ClutterTexture *texture, ClutterActor * clutter_texture_new_from_actor (ClutterActor *actor);
const gchar *filename, gboolean clutter_texture_set_from_file (ClutterTexture *texture,
GError **error); const gchar *filename,
gboolean clutter_texture_set_from_rgb_data (ClutterTexture *texture, GError **error);
const guchar *data, gboolean clutter_texture_set_from_rgb_data (ClutterTexture *texture,
gboolean has_alpha, const guchar *data,
gint width, gboolean has_alpha,
gint height, gint width,
gint rowstride, gint height,
gint bpp, gint rowstride,
ClutterTextureFlags flags, gint bpp,
GError **error); ClutterTextureFlags flags,
ClutterActor *clutter_texture_new_from_actor (ClutterActor *actor); GError **error);
gboolean clutter_texture_set_area_from_rgb_data (ClutterTexture *texture, gboolean clutter_texture_set_from_yuv_data (ClutterTexture *texture,
const guchar *data, const guchar *data,
gboolean has_alpha, gint width,
gint x, gint height,
gint y, ClutterTextureFlags flags,
gint width, GError **error);
gint height, gboolean clutter_texture_set_area_from_rgb_data (ClutterTexture *texture,
gint rowstride, const guchar *data,
gint bpp, gboolean has_alpha,
ClutterTextureFlags flags, gint x,
GError **error); gint y,
gint width,
gboolean clutter_texture_set_from_yuv_data (ClutterTexture *texture, gint height,
const guchar *data, gint rowstride,
gint width, gint bpp,
gint height, ClutterTextureFlags flags,
ClutterTextureFlags flags, GError **error);
GError **error); void clutter_texture_get_base_size (ClutterTexture *texture,
void clutter_texture_get_base_size (ClutterTexture *texture, gint *width,
gint *width, gint *height);
gint *height); void clutter_texture_set_filter_quality (ClutterTexture *texture,
void clutter_texture_set_filter_quality (ClutterTexture *texture, ClutterTextureQuality filter_quality);
ClutterTextureQuality ClutterTextureQuality clutter_texture_get_filter_quality (ClutterTexture *texture);
filter_quality); void clutter_texture_set_max_tile_waste (ClutterTexture *texture,
ClutterTextureQuality gint max_tile_waste);
clutter_texture_get_filter_quality (ClutterTexture *texture); gint clutter_texture_get_max_tile_waste (ClutterTexture *texture);
void clutter_texture_set_max_tile_waste (ClutterTexture *texture, CoglHandle clutter_texture_get_cogl_texture (ClutterTexture *texture);
gint max_tile_waste); void clutter_texture_set_cogl_texture (ClutterTexture *texture,
gint clutter_texture_get_max_tile_waste (ClutterTexture *texture); CoglHandle cogl_tex);
CoglHandle clutter_texture_get_cogl_texture (ClutterTexture *texture);
void clutter_texture_set_cogl_texture (ClutterTexture *texture,
CoglHandle cogl_tex);
G_END_DECLS G_END_DECLS

2
clutter/clutter-timeline.c
View File

@ -25,7 +25,7 @@
/** /**
* SECTION:clutter-timeline * SECTION:clutter-timeline
* @short_description: A class for based events * @short_description: A class for time-based events
* *
* #ClutterTimeline is a base class for managing time based events such * #ClutterTimeline is a base class for managing time based events such
* as animations. * as animations.