isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-29 06:12:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Clarify the set_cogl_texture() documentation

Browse Source 
When setting the COGL texture handle for a ClutterTexture the
texture will be set as the first layer of the material used
by the ClutterTexture. The documentation should clarify this
point.
This commit is contained in:
Emmanuele Bassi 2009-02-19 13:44:29 +00:00
parent a0800b44ad
commit c18e756267
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
clutter/clutter-texture.c
View File

@ -1203,7 +1203,7 @@ clutter_texture_load_from_local_data (ClutterTexture *texture)
* *
* Returns a handle to the underlying COGL material used for drawing * Returns a handle to the underlying COGL material used for drawing
* the actor. No extra reference is taken so if you need to keep the * the actor. No extra reference is taken so if you need to keep the
* handle then you should call cogl_material_ref on it. * handle then you should call cogl_material_ref() on it.
* *
* Since: 1.0 * Since: 1.0
* *
@ -1255,14 +1255,19 @@ clutter_texture_set_cogl_material (ClutterTexture *texture,
* clutter_texture_get_cogl_texture * clutter_texture_get_cogl_texture
* @texture: A #ClutterTexture * @texture: A #ClutterTexture
* *
* Returns a handle to the underlying COGL texture used for drawing * Retrieves the handle to the underlying COGL texture used for drawing
* the actor. No extra reference is taken so if you need to keep the * the actor. No extra reference is taken so if you need to keep the
* handle then you should call cogl_texture_ref on it. * handle then you should call cogl_texture_ref() on it.
*
* The texture handle returned is the first layer of the material
* handle used by the #ClutterTexture. If you need to access the other
* layers you should use clutter_texture_get_cogl_material() instead
* and use the #CoglMaterial API.
* *
* Since: 0.8 * Since: 0.8
* *
* Return value: COGL texture handle * Return value: COGL texture handle
**/ */
CoglHandle CoglHandle
clutter_texture_get_cogl_texture (ClutterTexture *texture) clutter_texture_get_cogl_texture (ClutterTexture *texture)
{ {