brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* clutter/clutter-clone-texture.c:

Browse Source 
* clutter/clutter-texture.c: (clutter_texture_class_init):
        More documentation fixes
This commit is contained in:
Chris Lord 2008-02-15 15:49:44 +00:00
parent d722fb9220
commit 94f884f2ef
3 changed files with 49 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,3 +1,9 @@
2008-02-15 Chris Lord <chris@openedhand.com>
* clutter/clutter-clone-texture.c:
* clutter/clutter-texture.c: (clutter_texture_class_init):
More documentation fixes
2008-02-15 Chris Lord <chris@openedhand.com> 2008-02-15 Chris Lord <chris@openedhand.com>
* clutter/clutter-actor.c: * clutter/clutter-actor.c:

6
clutter/clutter-clone-texture.c
View File

@ -361,13 +361,13 @@ clutter_clone_texture_init (ClutterCloneTexture *self)
/** /**
* clutter_clone_texture_new: * clutter_clone_texture_new:
* @texture: a #ClutterTexture or %NULL * @texture: a #ClutterTexture, or %NULL
* *
* Creates an efficient 'clone' of a pre-existing texture if which it * Creates an efficient 'clone' of a pre-existing texture with which it
* shares the underlying pixbuf data. * shares the underlying pixbuf data.
* *
* You can use clutter_clone_texture_set_parent_texture() to change the * You can use clutter_clone_texture_set_parent_texture() to change the
* parent texture to be cloned. * cloned texture.
* *
* Return value: the newly created #ClutterCloneTexture * Return value: the newly created #ClutterCloneTexture
*/ */

80
clutter/clutter-texture.c
View File

@ -1050,8 +1050,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
(gobject_class, PROP_SYNC_SIZE, (gobject_class, PROP_SYNC_SIZE,
g_param_spec_boolean ("sync-size", g_param_spec_boolean ("sync-size",
"Sync size of actor", "Sync size of actor",
"Auto sync size of actor to underlying pixbuf" "Auto sync size of actor to underlying pixbuf "
"dimentions", "dimensions",
TRUE, TRUE,
CLUTTER_PARAM_READWRITE)); CLUTTER_PARAM_READWRITE));
@ -1059,8 +1059,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
(gobject_class, PROP_REPEAT_X, (gobject_class, PROP_REPEAT_X,
g_param_spec_boolean ("repeat-x", g_param_spec_boolean ("repeat-x",
"Tile underlying pixbuf in x direction", "Tile underlying pixbuf in x direction",
"Reapeat underlying pixbuf rather than scale" "Reapeat underlying pixbuf rather than scale "
"in x direction. Currently UNWORKING", "in x direction. Currently ignored",
FALSE, FALSE,
CLUTTER_PARAM_READWRITE)); CLUTTER_PARAM_READWRITE));
@ -1068,8 +1068,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
(gobject_class, PROP_REPEAT_Y, (gobject_class, PROP_REPEAT_Y,
g_param_spec_boolean ("repeat-y", g_param_spec_boolean ("repeat-y",
"Tile underlying pixbuf in y direction", "Tile underlying pixbuf in y direction",
"Reapeat underlying pixbuf rather than scale" "Reapeat underlying pixbuf rather than scale "
"in y direction. Currently UNWORKING", "in y direction. Currently ignored",
FALSE, FALSE,
CLUTTER_PARAM_READWRITE)); CLUTTER_PARAM_READWRITE));
@ -1080,10 +1080,10 @@ clutter_texture_class_init (ClutterTextureClass *klass)
(gobject_class, PROP_FILTER_QUALITY, (gobject_class, PROP_FILTER_QUALITY,
g_param_spec_int ("filter-quality", g_param_spec_int ("filter-quality",
"Quality of filter used when scaling a texture", "Quality of filter used when scaling a texture",
"Values 0 and 1 current only supported, with 0" "Values 0 and 1 current only supported, with 0 "
"being lower quality but fast, 1 being better " "being lower quality but fast, 1 being better "
"quality but slower. ( Currently just maps to " "quality but slower. ( Currently just maps to "
" GL_NEAREST / GL_LINEAR )", "GL_NEAREST / GL_LINEAR )",
0, 0,
G_MAXINT, G_MAXINT,
1, 1,
@ -1092,10 +1092,10 @@ clutter_texture_class_init (ClutterTextureClass *klass)
g_object_class_install_property g_object_class_install_property
(gobject_class, PROP_MAX_TILE_WASTE, (gobject_class, PROP_MAX_TILE_WASTE,
g_param_spec_int ("tile-waste", g_param_spec_int ("tile-waste",
"Tile dimention to waste", "Tile dimension to waste",
"Max wastage dimention of a texture when using " "Max wastage dimension of a texture when using "
"tiled textures. Bigger values use less textures, " "tiled textures. Bigger values use less textures, "
"smaller values less texture memory. ", "smaller values less texture memory.",
0, 0,
G_MAXINT, G_MAXINT,
64, 64,
@ -1262,9 +1262,9 @@ texture_get_tile_pixbuf (ClutterTexture *texture,
* Gets a #GdkPixbuf representation of the #ClutterTexture data. * Gets a #GdkPixbuf representation of the #ClutterTexture data.
* The created #GdkPixbuf is not owned by the texture but the caller. * The created #GdkPixbuf is not owned by the texture but the caller.
* *
* Note: NULL is always returned with OpenGL ES. * Note: %NULL is always returned with OpenGL ES.
* *
* Return value: A #GdkPixbuf or NULL on fail. * Return value: A #GdkPixbuf, or %NULL on fail.
**/ **/
GdkPixbuf * GdkPixbuf *
clutter_texture_get_pixbuf (ClutterTexture *texture) clutter_texture_get_pixbuf (ClutterTexture *texture)
@ -1449,7 +1449,7 @@ texture_prepare_upload (gboolean initialize,
* clutter_texture_set_from_rgb_data: * clutter_texture_set_from_rgb_data:
* @texture: A #ClutterTexture * @texture: A #ClutterTexture
* @data: Image data in RGB type colorspace. * @data: Image data in RGB type colorspace.
* @has_alpha: Set to TRUE if image data has a alpha channel. * @has_alpha: Set to TRUE if image data has an alpha channel.
* @width: Width in pixels of image data. * @width: Width in pixels of image data.
* @height: Height in pixels of image data * @height: Height in pixels of image data
* @rowstride: Distance in bytes between row starts. * @rowstride: Distance in bytes between row starts.
@ -1810,10 +1810,10 @@ clutter_texture_get_base_size (ClutterTexture *texture,
* @texture: A #ClutterTexture * @texture: A #ClutterTexture
* @index_: Tile index to bind * @index_: Tile index to bind
* *
* Proxys a call to glBindTexture a to bind an internal 'tile'. * Proxies a call to glBindTexture to bind an internal 'tile'.
* *
* This function is only useful for sub class implementations * This function is only useful for #ClutterTexture sub-classes
* and never should be called by an application. * and should never be called by an application.
**/ **/
void void
clutter_texture_bind_tile (ClutterTexture *texture, clutter_texture_bind_tile (ClutterTexture *texture,
@ -1834,10 +1834,10 @@ clutter_texture_bind_tile (ClutterTexture *texture,
* @n_x_tiles: Location to store number of tiles in horizonally axis * @n_x_tiles: Location to store number of tiles in horizonally axis
* @n_y_tiles: Location to store number of tiles in vertical axis * @n_y_tiles: Location to store number of tiles in vertical axis
* *
* Retreives internal tile dimentioning. * Retreives internal tile dimensioning.
* *
* This function is only useful for sub class implementations * This function is only useful for #ClutterTexture sub-classes
* and never should be called by an application. * and should never be called by an application.
**/ **/
void void
clutter_texture_get_n_tiles (ClutterTexture *texture, clutter_texture_get_n_tiles (ClutterTexture *texture,
@ -1856,14 +1856,14 @@ clutter_texture_get_n_tiles (ClutterTexture *texture,
* clutter_texture_get_x_tile_detail: * clutter_texture_get_x_tile_detail:
* @texture: A #ClutterTexture * @texture: A #ClutterTexture
* @x_index: X index of tile to query * @x_index: X index of tile to query
* @pos: Location to store tiles X position * @pos: Location to store tile's X position
* @size: Location to store tiles horizontal size in pixels * @size: Location to store tile's horizontal size in pixels
* @waste: Location to store tiles horizontal wastage in pixels * @waste: Location to store tile's horizontal wastage in pixels
* *
* Retreives details of a tile on x axis. * Retreives details of a tile on the X axis.
* *
* This function is only useful for sub class implementations * This function is only useful for #ClutterTexture sub-classes
* and never should be called by an application. * and should never be called by an application.
**/ **/
void void
clutter_texture_get_x_tile_detail (ClutterTexture *texture, clutter_texture_get_x_tile_detail (ClutterTexture *texture,
@ -1888,14 +1888,14 @@ clutter_texture_get_x_tile_detail (ClutterTexture *texture,
* clutter_texture_get_y_tile_detail: * clutter_texture_get_y_tile_detail:
* @texture: A #ClutterTexture * @texture: A #ClutterTexture
* @y_index: Y index of tile to query * @y_index: Y index of tile to query
* @pos: Location to store tiles Y position * @pos: Location to store tile's Y position
* @size: Location to store tiles vertical size in pixels * @size: Location to store tile's vertical size in pixels
* @waste: Location to store tiles vertical wastage in pixels * @waste: Location to store tile's vertical wastage in pixels
* *
* Retreives details of a tile on y axis. * Retreives details of a tile on the Y axis.
* *
* This function is only useful for sub class implementations * This function is only useful for #ClutterTexture sub-classes
* and never should be called by an application. * and should never be called by an application.
**/ **/
void void
clutter_texture_get_y_tile_detail (ClutterTexture *texture, clutter_texture_get_y_tile_detail (ClutterTexture *texture,
@ -1928,10 +1928,10 @@ clutter_texture_get_y_tile_detail (ClutterTexture *texture,
* *
* Checks if #ClutterTexture has generated underlying GL texture tiles. * Checks if #ClutterTexture has generated underlying GL texture tiles.
* *
* This function is only useful for sub class implementations * This function is only useful for #ClutterTexture sub-classes
* and never should be called by an application. * and should never be called by an application.
* *
* Return value: TRUE if texture has pregenerated GL tiles. * Return value: %TRUE if texture has pre-generated GL tiles.
**/ **/
gboolean gboolean
clutter_texture_has_generated_tiles (ClutterTexture *texture) clutter_texture_has_generated_tiles (ClutterTexture *texture)
@ -1947,10 +1947,10 @@ clutter_texture_has_generated_tiles (ClutterTexture *texture)
* *
* Checks if #ClutterTexture is tiled. * Checks if #ClutterTexture is tiled.
* *
* This function is only useful for sub class implementations * This function is only useful for #ClutterTexture sub-classes
* and never should be called by an application. * and should never be called by an application.
* *
* Return value: TRUE if texture is tiled * Return value: %TRUE if texture is tiled
**/ **/
gboolean gboolean
clutter_texture_is_tiled (ClutterTexture *texture) clutter_texture_is_tiled (ClutterTexture *texture)
@ -2146,7 +2146,7 @@ texture_update_data (ClutterTexture *texture,
* clutter_texture_set_area_from_rgb_data: * clutter_texture_set_area_from_rgb_data:
* @texture: A #ClutterTexture * @texture: A #ClutterTexture
* @data: Image data in RGB type colorspace. * @data: Image data in RGB type colorspace.
* @has_alpha: Set to TRUE if image data has a alpha channel. * @has_alpha: Set to TRUE if image data has an alpha channel.
* @x: X coordinate of upper left corner of region to update. * @x: X coordinate of upper left corner of region to update.
* @y: Y coordinate of upper left corner of region to update. * @y: Y coordinate of upper left corner of region to update.
* @width: Width in pixels of region to update. * @width: Width in pixels of region to update.
@ -2156,7 +2156,7 @@ texture_update_data (ClutterTexture *texture,
* @flags: #ClutterTextureFlags * @flags: #ClutterTextureFlags
* @error: return location for a #GError, or %NULL * @error: return location for a #GError, or %NULL
* *
* Updates a subregion of the pixel data in a #ClutterTexture. * Updates a sub-region of the pixel data in a #ClutterTexture.
* *
* Return value: %TRUE on success, %FALSE on failure. * Return value: %TRUE on success, %FALSE on failure.
* *