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

docs: Documentation fixes for CoglBitmap

Browse Source 
• Use the same style for the Cogl API reference as the one used for
  the Clutter API reference.

• Fix the introspection annotations for cogl_bitmap_get_size_from_file()
This commit is contained in:
Emmanuele Bassi 2009-11-19 13:29:02 +00:00
parent 1bf8db9e75
commit fe804f1d02
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
clutter/cogl/cogl/cogl-bitmap.h
View File

@ -34,11 +34,12 @@ G_BEGIN_DECLS
/** /**
* SECTION:cogl-bitmap * SECTION:cogl-bitmap
* @short_description: Fuctions for loading images but not directly * @short_description: Fuctions for loading images
* into textures
* *
* Cogl allows loading image data into memory as CoglBitmaps without * Cogl allows loading image data into memory as CoglBitmaps without
* loading them immediately into GPU textures. * loading them immediately into GPU textures.
*
* #CoglBitmap is available since Cogl 1.0
*/ */
@ -50,7 +51,7 @@ G_BEGIN_DECLS
* Loads an image file from disk. This function can be safely called from * Loads an image file from disk. This function can be safely called from
* within a thread. * within a thread.
* *
* Returns: a #CoglHandle to the new loaded image data, or * Return value: a #CoglHandle to the new loaded image data, or
* %COGL_INVALID_HANDLE if loading the image failed. * %COGL_INVALID_HANDLE if loading the image failed.
* *
* Since: 1.0 * Since: 1.0
@ -61,13 +62,13 @@ CoglHandle cogl_bitmap_new_from_file (const gchar *filename,
/** /**
* cogl_bitmap_get_size_from_file: * cogl_bitmap_get_size_from_file:
* @filename: the file to check * @filename: the file to check
* @width: return location for the bitmap width * @width: (out): return location for the bitmap width, or %NULL
* @height: return location for the bitmap height * @height: (out): return location for the bitmap height, or %NULL
* *
* Parses an image file enough to extract the width and height * Parses an image file enough to extract the width and height
* of the bitmap. * of the bitmap.
* *
* Returns: %TRUE if the image was successfully parsed * Return value: %TRUE if the image was successfully parsed
* *
* Since: 1.0 * Since: 1.0
*/ */