git.roojs.org Git - gir-1.1/blob - GtkClutter-1.0.gir

   1 <?xml version="1.0"?>
   2 <!-- This file was automatically generated from C sources - DO NOT EDIT!
   3 To affect the contents of this file, edit the original C definitions,
   4 and/or use gtk-doc annotations.  -->
   5 <repository version="1.1"
   6             xmlns="http://www.gtk.org/introspection/core/1.0"
   7             xmlns:c="http://www.gtk.org/introspection/c/1.0"
   8             xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
   9   <include name="Atk" version="1.0"/>
  10   <include name="Clutter" version="1.0"/>
  11   <include name="ClutterJson" version="1.0"/>
  12   <include name="Cogl" version="1.0"/>
  13   <include name="GL" version="1.0"/>
  14   <include name="GLib" version="2.0"/>
  15   <include name="GModule" version="2.0"/>
  16   <include name="GObject" version="2.0"/>
  17   <include name="Gdk" version="2.0"/>
  18   <include name="GdkPixbuf" version="2.0"/>
  19   <include name="Gio" version="2.0"/>
  20   <include name="Gtk" version="2.0"/>
  21   <include name="Pango" version="1.0"/>
  22   <include name="PangoCairo" version="1.0"/>
  23   <include name="PangoFT2" version="1.0"/>
  24   <include name="cairo" version="1.0"/>
  25   <include name="fontconfig" version="2.0"/>
  26   <include name="freetype2" version="2.0"/>
  27   <package name="clutter-1.0"/>
  28   <package name="gtk+-2.0"/>
  29   <namespace name="GtkClutter"
  30              version="1.0"
  31              shared-library="libclutter-gtk-1.0.so.0"
  32              c:prefix="GtkClutter">
  33     <class name="Actor"
  34            c:type="GtkClutterActor"
  35            parent="Clutter.Actor"
  36            glib:type-name="GtkClutterActor"
  37            glib:get-type="gtk_clutter_actor_get_type"
  38            glib:type-struct="ActorClass">
  39       <doc xml:whitespace="preserve">A ClutterActor containing a #GtkWidget.</doc>
  40       <implements name="Atk.ImplementorIface"/>
  41       <implements name="Clutter.Animatable"/>
  42       <implements name="Clutter.Container"/>
  43       <implements name="Clutter.Scriptable"/>
  44       <constructor name="new" c:identifier="gtk_clutter_actor_new">
  45         <doc xml:whitespace="preserve">Creates a new #GtkClutterActor.
  46 This widget can be used to embed a #GtkWidget into a Clutter scene,
  47 by retrieving the internal #GtkBin container using
  48 gtk_clutter_actor_get_widget() and adding the #GtkWidget to it.</doc>
  49         <return-value transfer-ownership="full">
  50           <doc xml:whitespace="preserve">the newly created #GtkClutterActor</doc>
  51           <type name="Actor" c:type="ClutterActor*"/>
  52         </return-value>
  53       </constructor>
  54       <constructor name="new_with_contents"
  55                    c:identifier="gtk_clutter_actor_new_with_contents">
  56         <doc xml:whitespace="preserve">Creates a new #GtkClutterActor widget. This widget can be
  57 used to embed a Gtk widget into a clutter scene.
  58 This function is the logical equivalent of:
  59 |[
  60 ClutterActor *actor = gtk_clutter_actor_new ();
  61 GtkWidget *bin = gtk_clutter_actor_get_widget (GTK_CLUTTER_ACTOR (actor));
  62 gtk_container_add (GTK_CONTAINER (bin), contents);
  63 ]|</doc>
  64         <return-value transfer-ownership="full">
  65           <doc xml:whitespace="preserve">the newly created #GtkClutterActor</doc>
  66           <type name="Actor" c:type="ClutterActor*"/>
  67         </return-value>
  68         <parameters>
  69           <parameter name="contents" transfer-ownership="none">
  70             <doc xml:whitespace="preserve">a #GtkWidget to pack into this #ClutterActor</doc>
  71             <type name="Gtk.Widget" c:type="GtkWidget*"/>
  72           </parameter>
  73         </parameters>
  74       </constructor>
  75       <method name="get_contents"
  76               c:identifier="gtk_clutter_actor_get_contents">
  77         <doc xml:whitespace="preserve">Retrieves the child of the #GtkBin used to hold the contents of @actor.
  78 This convenience function is the logical equivalent of:
  79 |[
  80 GtkWidget *bin;
  81 bin = gtk_clutter_actor_get_widget (GTK_CLUTTER_ACTOR (actor));
  82 return gtk_bin_get_child (GTK_BIN (bin));
  83 ]|
  84 has been set</doc>
  85         <return-value transfer-ownership="none">
  86           <doc xml:whitespace="preserve">a #GtkWidget, or %NULL if not content</doc>
  87           <type name="Gtk.Widget" c:type="GtkWidget*"/>
  88         </return-value>
  89       </method>
  90       <method name="get_widget" c:identifier="gtk_clutter_actor_get_widget">
  91         <doc xml:whitespace="preserve">Retrieves the #GtkBin used to hold the #GtkClutterActor:contents widget</doc>
  92         <return-value transfer-ownership="none">
  93           <doc xml:whitespace="preserve">a #GtkBin</doc>
  94           <type name="Gtk.Widget" c:type="GtkWidget*"/>
  95         </return-value>
  96       </method>
  97       <property name="contents"
  98                 writable="1"
  99                 construct="1"
 100                 transfer-ownership="none">
 101         <doc xml:whitespace="preserve">The #GtkWidget to be embedded into the #GtkClutterActor</doc>
 102         <type name="Gtk.Widget" c:type="GtkWidget"/>
 103       </property>
 104       <field name="parent_instance">
 105         <type name="Clutter.Actor" c:type="ClutterActor"/>
 106       </field>
 107       <field name="priv">
 108         <type name="ActorPrivate" c:type="GtkClutterActorPrivate*"/>
 109       </field>
 110     </class>
 111     <record name="ActorClass"
 112             c:type="GtkClutterActorClass"
 113             glib:is-gtype-struct-for="Actor">
 114       <doc xml:whitespace="preserve">Base class for #GtkClutterActor.</doc>
 115       <field name="parent_class">
 116         <type name="Clutter.ActorClass" c:type="ClutterActorClass"/>
 117       </field>
 118       <field name="clutter_gtk_reserved1">
 119         <callback name="clutter_gtk_reserved1" c:type="_clutter_gtk_reserved1">
 120           <return-value transfer-ownership="none">
 121             <type name="none" c:type="void"/>
 122           </return-value>
 123         </callback>
 124       </field>
 125       <field name="clutter_gtk_reserved2">
 126         <callback name="clutter_gtk_reserved2" c:type="_clutter_gtk_reserved2">
 127           <return-value transfer-ownership="none">
 128             <type name="none" c:type="void"/>
 129           </return-value>
 130         </callback>
 131       </field>
 132       <field name="clutter_gtk_reserved3">
 133         <callback name="clutter_gtk_reserved3" c:type="_clutter_gtk_reserved3">
 134           <return-value transfer-ownership="none">
 135             <type name="none" c:type="void"/>
 136           </return-value>
 137         </callback>
 138       </field>
 139       <field name="clutter_gtk_reserved4">
 140         <callback name="clutter_gtk_reserved4" c:type="_clutter_gtk_reserved4">
 141           <return-value transfer-ownership="none">
 142             <type name="none" c:type="void"/>
 143           </return-value>
 144         </callback>
 145       </field>
 146       <field name="clutter_gtk_reserved5">
 147         <callback name="clutter_gtk_reserved5" c:type="_clutter_gtk_reserved5">
 148           <return-value transfer-ownership="none">
 149             <type name="none" c:type="void"/>
 150           </return-value>
 151         </callback>
 152       </field>
 153       <field name="clutter_gtk_reserved6">
 154         <callback name="clutter_gtk_reserved6" c:type="_clutter_gtk_reserved6">
 155           <return-value transfer-ownership="none">
 156             <type name="none" c:type="void"/>
 157           </return-value>
 158         </callback>
 159       </field>
 160     </record>
 161     <record name="ActorPrivate" c:type="GtkClutterActorPrivate">
 162     </record>
 163     <enumeration name="ClutterGtkInitError" c:type="ClutterGtkInitError">
 164       <doc xml:whitespace="preserve">Extension of the #ClutterInitError enumeration for the integration
 165 with GTK+
 166 This enumeration might be extended at later date</doc>
 167       <member name="last" value="-3" c:identifier="CLUTTER_INIT_ERROR_LAST"/>
 168       <member name="gtk" value="-4" c:identifier="CLUTTER_INIT_ERROR_GTK"/>
 169     </enumeration>
 170     <class name="Embed"
 171            c:type="GtkClutterEmbed"
 172            parent="Gtk.Container"
 173            glib:type-name="GtkClutterEmbed"
 174            glib:get-type="gtk_clutter_embed_get_type"
 175            glib:type-struct="EmbedClass">
 176       <doc xml:whitespace="preserve">A #GtkWidget containing the default Clutter stage.
 177 The &lt;structname&gt;GtkClutterEmbed&lt;/structname&gt; structure contains only
 178 private data and should be accessed using the provided API.</doc>
 179       <implements name="Atk.ImplementorIface"/>
 180       <implements name="Gtk.Buildable"/>
 181       <constructor name="new" c:identifier="gtk_clutter_embed_new">
 182         <doc xml:whitespace="preserve">Creates a new #GtkClutterEmbed widget. This widget can be
 183 used to build a scene using Clutter API into a GTK+ application.</doc>
 184         <return-value transfer-ownership="full">
 185           <doc xml:whitespace="preserve">the newly created #GtkClutterEmbed</doc>
 186           <type name="Embed" c:type="GtkWidget*"/>
 187         </return-value>
 188       </constructor>
 189       <method name="get_stage" c:identifier="gtk_clutter_embed_get_stage">
 190         <doc xml:whitespace="preserve">Retrieves the #ClutterStage from @embed. The returned stage can be
 191 used to add actors to the Clutter scene.
 192 the returned actor.</doc>
 193         <return-value transfer-ownership="full">
 194           <doc xml:whitespace="preserve">the Clutter stage. You should never destroy or unref</doc>
 195           <type name="Clutter.Actor" c:type="ClutterActor*"/>
 196         </return-value>
 197       </method>
 198       <field name="parent_instance">
 199         <type name="Gtk.Container" c:type="GtkContainer"/>
 200       </field>
 201       <field name="priv">
 202         <type name="EmbedPrivate" c:type="GtkClutterEmbedPrivate*"/>
 203       </field>
 204     </class>
 205     <record name="EmbedClass"
 206             c:type="GtkClutterEmbedClass"
 207             glib:is-gtype-struct-for="Embed">
 208       <doc xml:whitespace="preserve">Base class for #GtkClutterEmbed.
 209 The &lt;structname&gt;GtkClutterEmbedClass&lt;/structname&gt; contains only private
 210 data.</doc>
 211       <field name="parent_class">
 212         <type name="Gtk.ContainerClass" c:type="GtkContainerClass"/>
 213       </field>
 214       <field name="clutter_gtk_reserved1">
 215         <callback name="clutter_gtk_reserved1" c:type="_clutter_gtk_reserved1">
 216           <return-value transfer-ownership="none">
 217             <type name="none" c:type="void"/>
 218           </return-value>
 219         </callback>
 220       </field>
 221       <field name="clutter_gtk_reserved2">
 222         <callback name="clutter_gtk_reserved2" c:type="_clutter_gtk_reserved2">
 223           <return-value transfer-ownership="none">
 224             <type name="none" c:type="void"/>
 225           </return-value>
 226         </callback>
 227       </field>
 228       <field name="clutter_gtk_reserved3">
 229         <callback name="clutter_gtk_reserved3" c:type="_clutter_gtk_reserved3">
 230           <return-value transfer-ownership="none">
 231             <type name="none" c:type="void"/>
 232           </return-value>
 233         </callback>
 234       </field>
 235       <field name="clutter_gtk_reserved4">
 236         <callback name="clutter_gtk_reserved4" c:type="_clutter_gtk_reserved4">
 237           <return-value transfer-ownership="none">
 238             <type name="none" c:type="void"/>
 239           </return-value>
 240         </callback>
 241       </field>
 242       <field name="clutter_gtk_reserved5">
 243         <callback name="clutter_gtk_reserved5" c:type="_clutter_gtk_reserved5">
 244           <return-value transfer-ownership="none">
 245             <type name="none" c:type="void"/>
 246           </return-value>
 247         </callback>
 248       </field>
 249       <field name="clutter_gtk_reserved6">
 250         <callback name="clutter_gtk_reserved6" c:type="_clutter_gtk_reserved6">
 251           <return-value transfer-ownership="none">
 252             <type name="none" c:type="void"/>
 253           </return-value>
 254         </callback>
 255       </field>
 256     </record>
 257     <record name="EmbedPrivate" c:type="GtkClutterEmbedPrivate">
 258     </record>
 259     <enumeration name="TextureError"
 260                  c:type="GtkClutterTextureError"
 261                  glib:error-quark="gtk_clutter_texture_error_quark">
 262       <doc xml:whitespace="preserve">An enumeration of error types used in ClutterGtk texture functions
 263 This enumeration might be extended at later date</doc>
 264       <member name="gtk_clutter_texture_invalid_stock_id"
 265               value="0"
 266               c:identifier="GTK_CLUTTER_TEXTURE_INVALID_STOCK_ID"/>
 267     </enumeration>
 268     <class name="Window"
 269            c:type="GtkClutterWindow"
 270            parent="Gtk.Window"
 271            glib:type-name="GtkClutterWindow"
 272            glib:get-type="gtk_clutter_window_get_type"
 273            glib:type-struct="WindowClass">
 274       <doc xml:whitespace="preserve">A #GtkWindow containing a #ClutterStage.
 275 The &lt;structname&gt;GtkClutterWindow&lt;/structname&gt; structure contains only
 276 private data and it should be accessed using the provided API.</doc>
 277       <implements name="Atk.ImplementorIface"/>
 278       <implements name="Gtk.Buildable"/>
 279       <constructor name="new" c:identifier="gtk_clutter_window_new">
 280         <doc xml:whitespace="preserve">Creates a new #GtkClutterWindow widget.
 281 This window provides a hidden #ClutterStage on which the child
 282 #GtkWidget&lt;!-- --&gt;s are placed. This allows other #ClutterActor&lt;!-- --&gt;s
 283 to also be placed on the stage.</doc>
 284         <return-value transfer-ownership="full">
 285           <doc xml:whitespace="preserve">the newly created #GtkClutterWindow</doc>
 286           <type name="Window" c:type="GtkWidget*"/>
 287         </return-value>
 288       </constructor>
 289       <method name="get_stage" c:identifier="gtk_clutter_window_get_stage">
 290         <doc xml:whitespace="preserve">Retrieves the #ClutterStage that this window is embedding
 291 Use this function if you wish to add other actors to the #ClutterStage.</doc>
 292         <return-value transfer-ownership="none">
 293           <doc xml:whitespace="preserve">the window's #ClutterStage</doc>
 294           <type name="Clutter.Actor" c:type="ClutterActor*"/>
 295         </return-value>
 296       </method>
 297       <field name="parent_instance">
 298         <type name="Gtk.Window" c:type="GtkWindow"/>
 299       </field>
 300       <field name="priv">
 301         <type name="WindowPrivate" c:type="GtkClutterWindowPrivate*"/>
 302       </field>
 303     </class>
 304     <record name="WindowClass"
 305             c:type="GtkClutterWindowClass"
 306             glib:is-gtype-struct-for="Window">
 307       <doc xml:whitespace="preserve">Base class for #GtkClutterWindow.
 308 The &lt;structname&gt;GtkClutterWindowClass&lt;/structname&gt; structure contains
 309 only private data.</doc>
 310       <field name="parent_class">
 311         <type name="Gtk.WindowClass" c:type="GtkWindowClass"/>
 312       </field>
 313       <field name="clutter_gtk_reserved1">
 314         <callback name="clutter_gtk_reserved1" c:type="_clutter_gtk_reserved1">
 315           <return-value transfer-ownership="none">
 316             <type name="none" c:type="void"/>
 317           </return-value>
 318         </callback>
 319       </field>
 320       <field name="clutter_gtk_reserved2">
 321         <callback name="clutter_gtk_reserved2" c:type="_clutter_gtk_reserved2">
 322           <return-value transfer-ownership="none">
 323             <type name="none" c:type="void"/>
 324           </return-value>
 325         </callback>
 326       </field>
 327       <field name="clutter_gtk_reserved3">
 328         <callback name="clutter_gtk_reserved3" c:type="_clutter_gtk_reserved3">
 329           <return-value transfer-ownership="none">
 330             <type name="none" c:type="void"/>
 331           </return-value>
 332         </callback>
 333       </field>
 334       <field name="clutter_gtk_reserved4">
 335         <callback name="clutter_gtk_reserved4" c:type="_clutter_gtk_reserved4">
 336           <return-value transfer-ownership="none">
 337             <type name="none" c:type="void"/>
 338           </return-value>
 339         </callback>
 340       </field>
 341       <field name="clutter_gtk_reserved5">
 342         <callback name="clutter_gtk_reserved5" c:type="_clutter_gtk_reserved5">
 343           <return-value transfer-ownership="none">
 344             <type name="none" c:type="void"/>
 345           </return-value>
 346         </callback>
 347       </field>
 348       <field name="clutter_gtk_reserved6">
 349         <callback name="clutter_gtk_reserved6" c:type="_clutter_gtk_reserved6">
 350           <return-value transfer-ownership="none">
 351             <type name="none" c:type="void"/>
 352           </return-value>
 353         </callback>
 354       </field>
 355     </record>
 356     <record name="WindowPrivate" c:type="GtkClutterWindowPrivate">
 357     </record>
 358     <function name="get_base_color" c:identifier="gtk_clutter_get_base_color">
 359       <doc xml:whitespace="preserve">Retrieves the base color of @widget for the given @state and copies it
 360 into @color.</doc>
 361       <return-value transfer-ownership="none">
 362         <type name="none" c:type="void"/>
 363       </return-value>
 364       <parameters>
 365         <parameter name="widget" transfer-ownership="none">
 366           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 367           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 368         </parameter>
 369         <parameter name="state" transfer-ownership="none">
 370           <doc xml:whitespace="preserve">a state</doc>
 371           <type name="Gtk.StateType" c:type="GtkStateType"/>
 372         </parameter>
 373         <parameter name="color"
 374                    direction="out"
 375                    caller-allocates="1"
 376                    transfer-ownership="none">
 377           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 378           <type name="Clutter.Color" c:type="ClutterColor*"/>
 379         </parameter>
 380       </parameters>
 381     </function>
 382     <function name="get_bg_color" c:identifier="gtk_clutter_get_bg_color">
 383       <doc xml:whitespace="preserve">Retrieves the background color of @widget for the given @state and copies
 384 it into @color.</doc>
 385       <return-value transfer-ownership="none">
 386         <type name="none" c:type="void"/>
 387       </return-value>
 388       <parameters>
 389         <parameter name="widget" transfer-ownership="none">
 390           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 391           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 392         </parameter>
 393         <parameter name="state" transfer-ownership="none">
 394           <doc xml:whitespace="preserve">a state</doc>
 395           <type name="Gtk.StateType" c:type="GtkStateType"/>
 396         </parameter>
 397         <parameter name="color"
 398                    direction="out"
 399                    caller-allocates="1"
 400                    transfer-ownership="none">
 401           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 402           <type name="Clutter.Color" c:type="ClutterColor*"/>
 403         </parameter>
 404       </parameters>
 405     </function>
 406     <function name="get_dark_color" c:identifier="gtk_clutter_get_dark_color">
 407       <doc xml:whitespace="preserve">Retrieves the dark color of @widget for the given @state and copies it
 408 into @color.</doc>
 409       <return-value transfer-ownership="none">
 410         <type name="none" c:type="void"/>
 411       </return-value>
 412       <parameters>
 413         <parameter name="widget" transfer-ownership="none">
 414           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 415           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 416         </parameter>
 417         <parameter name="state" transfer-ownership="none">
 418           <doc xml:whitespace="preserve">a state</doc>
 419           <type name="Gtk.StateType" c:type="GtkStateType"/>
 420         </parameter>
 421         <parameter name="color"
 422                    direction="out"
 423                    caller-allocates="1"
 424                    transfer-ownership="none">
 425           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 426           <type name="Clutter.Color" c:type="ClutterColor*"/>
 427         </parameter>
 428       </parameters>
 429     </function>
 430     <function name="get_fg_color" c:identifier="gtk_clutter_get_fg_color">
 431       <doc xml:whitespace="preserve">Retrieves the foreground color of @widget for the given @state and copies
 432 it into @color.</doc>
 433       <return-value transfer-ownership="none">
 434         <type name="none" c:type="void"/>
 435       </return-value>
 436       <parameters>
 437         <parameter name="widget" transfer-ownership="none">
 438           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 439           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 440         </parameter>
 441         <parameter name="state" transfer-ownership="none">
 442           <doc xml:whitespace="preserve">a state</doc>
 443           <type name="Gtk.StateType" c:type="GtkStateType"/>
 444         </parameter>
 445         <parameter name="color"
 446                    direction="out"
 447                    caller-allocates="1"
 448                    transfer-ownership="none">
 449           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 450           <type name="Clutter.Color" c:type="ClutterColor*"/>
 451         </parameter>
 452       </parameters>
 453     </function>
 454     <function name="get_light_color"
 455               c:identifier="gtk_clutter_get_light_color">
 456       <doc xml:whitespace="preserve">Retrieves the light color of @widget for the given @state and copies it
 457 into @color.</doc>
 458       <return-value transfer-ownership="none">
 459         <type name="none" c:type="void"/>
 460       </return-value>
 461       <parameters>
 462         <parameter name="widget" transfer-ownership="none">
 463           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 464           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 465         </parameter>
 466         <parameter name="state" transfer-ownership="none">
 467           <doc xml:whitespace="preserve">a state</doc>
 468           <type name="Gtk.StateType" c:type="GtkStateType"/>
 469         </parameter>
 470         <parameter name="color"
 471                    direction="out"
 472                    caller-allocates="1"
 473                    transfer-ownership="none">
 474           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 475           <type name="Clutter.Color" c:type="ClutterColor*"/>
 476         </parameter>
 477       </parameters>
 478     </function>
 479     <function name="get_mid_color" c:identifier="gtk_clutter_get_mid_color">
 480       <doc xml:whitespace="preserve">Retrieves the mid color of @widget for the given @state and copies it
 481 into @color.</doc>
 482       <return-value transfer-ownership="none">
 483         <type name="none" c:type="void"/>
 484       </return-value>
 485       <parameters>
 486         <parameter name="widget" transfer-ownership="none">
 487           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 488           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 489         </parameter>
 490         <parameter name="state" transfer-ownership="none">
 491           <doc xml:whitespace="preserve">a state</doc>
 492           <type name="Gtk.StateType" c:type="GtkStateType"/>
 493         </parameter>
 494         <parameter name="color"
 495                    direction="out"
 496                    caller-allocates="1"
 497                    transfer-ownership="none">
 498           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 499           <type name="Clutter.Color" c:type="ClutterColor*"/>
 500         </parameter>
 501       </parameters>
 502     </function>
 503     <function name="get_option_group"
 504               c:identifier="gtk_clutter_get_option_group">
 505       <doc xml:whitespace="preserve">Returns a #GOptionGroup for the command line arguments recognized
 506 by Clutter. You should add this group to your #GOptionContext with
 507 g_option_context_add_group(), if you are using g_option_context_parse()
 508 to parse your commandline arguments instead of using gtk_clutter_init()
 509 or gtk_clutter_init_with_args().
 510 You should add this option group to your #GOptionContext after
 511 the GTK option group created with gtk_get_option_group(), and after
 512 the clutter option group obtained from clutter_get_option_group_without_init().
 513 You should not use clutter_get_option_group() together with this function.
 514 You must pass %TRUE to gtk_get_option_group() since gtk-clutter's option
 515 group relies on it.
 516 Parsing options using g_option_context_parse() with a #GOptionContext
 517 containing the returned #GOptionGroupwith will result in Clutter's and
 518 GTK-Clutter's initialisation.  That is, the following code:
 519 |[
 520 g_option_context_add_group (context, gtk_get_option_group (TRUE));
 521 g_option_context_add_group (context, cogl_get_option_group ());
 522 g_option_context_add_group (context, clutter_get_option_group_without_init ());
 523 g_option_context_add_group (context, gtk_clutter_get_option_group ());
 524 res = g_option_context_parse (context, &amp;amp;argc, &amp;amp;argc, NULL);
 525 ]|
 526 is functionally equivalent to:
 527 |[
 528 gtk_clutter_init (&amp;amp;argc, &amp;amp;argv);
 529 ]|
 530 After g_option_context_parse() on a #GOptionContext containing the
 531 the returned #GOptionGroup has returned %TRUE, Clutter and GTK-Clutter are
 532 guaranteed to be initialized.
 533 recognized by ClutterGtk</doc>
 534       <return-value transfer-ownership="full">
 535         <doc xml:whitespace="preserve">a #GOptionGroup for the commandline arguments</doc>
 536         <type name="GLib.OptionGroup" c:type="GOptionGroup*"/>
 537       </return-value>
 538     </function>
 539     <function name="get_text_aa_color"
 540               c:identifier="gtk_clutter_get_text_aa_color">
 541       <doc xml:whitespace="preserve">Retrieves the text-aa color of @widget for the given @state and copies it
 542 into @color.</doc>
 543       <return-value transfer-ownership="none">
 544         <type name="none" c:type="void"/>
 545       </return-value>
 546       <parameters>
 547         <parameter name="widget" transfer-ownership="none">
 548           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 549           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 550         </parameter>
 551         <parameter name="state" transfer-ownership="none">
 552           <doc xml:whitespace="preserve">a state</doc>
 553           <type name="Gtk.StateType" c:type="GtkStateType"/>
 554         </parameter>
 555         <parameter name="color" transfer-ownership="none">
 556           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 557           <type name="Clutter.Color" c:type="ClutterColor*"/>
 558         </parameter>
 559       </parameters>
 560     </function>
 561     <function name="get_text_color" c:identifier="gtk_clutter_get_text_color">
 562       <doc xml:whitespace="preserve">Retrieves the text color of @widget for the given @state and copies it
 563 into @color.</doc>
 564       <return-value transfer-ownership="none">
 565         <type name="none" c:type="void"/>
 566       </return-value>
 567       <parameters>
 568         <parameter name="widget" transfer-ownership="none">
 569           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 570           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 571         </parameter>
 572         <parameter name="state" transfer-ownership="none">
 573           <doc xml:whitespace="preserve">a state</doc>
 574           <type name="Gtk.StateType" c:type="GtkStateType"/>
 575         </parameter>
 576         <parameter name="color"
 577                    direction="out"
 578                    caller-allocates="1"
 579                    transfer-ownership="none">
 580           <doc xml:whitespace="preserve">return location for a #ClutterColor</doc>
 581           <type name="Clutter.Color" c:type="ClutterColor*"/>
 582         </parameter>
 583       </parameters>
 584     </function>
 585     <function name="init" c:identifier="gtk_clutter_init">
 586       <doc xml:whitespace="preserve">This function should be called instead of clutter_init() and
 587 gtk_init().
 588 on failure.</doc>
 589       <return-value transfer-ownership="full">
 590         <doc xml:whitespace="preserve">%CLUTTER_INIT_SUCCESS on success, a negative integer</doc>
 591         <type name="Clutter.InitError" c:type="ClutterInitError"/>
 592       </return-value>
 593       <parameters>
 594         <parameter name="argc"
 595                    direction="out"
 596                    caller-allocates="0"
 597                    transfer-ownership="full">
 598           <doc xml:whitespace="preserve">pointer to the arguments count, or %NULL</doc>
 599           <type name="int" c:type="int*"/>
 600         </parameter>
 601         <parameter name="argv" transfer-ownership="none">
 602           <doc xml:whitespace="preserve">pointer to the arguments vector, or %NULL</doc>
 603           <array length="0" c:type="char***">
 604             <type name="int8"/>
 605           </array>
 606         </parameter>
 607       </parameters>
 608     </function>
 609     <function name="init_with_args"
 610               c:identifier="gtk_clutter_init_with_args"
 611               throws="1">
 612       <doc xml:whitespace="preserve">This function should be called instead of clutter_init() and
 613 gtk_init_with_args().
 614 on failure.</doc>
 615       <return-value transfer-ownership="full">
 616         <doc xml:whitespace="preserve">%CLUTTER_INIT_SUCCESS on success, a negative integer</doc>
 617         <type name="Clutter.InitError" c:type="ClutterInitError"/>
 618       </return-value>
 619       <parameters>
 620         <parameter name="argc"
 621                    direction="out"
 622                    caller-allocates="0"
 623                    transfer-ownership="full">
 624           <doc xml:whitespace="preserve">a pointer to the number of command line arguments.</doc>
 625           <type name="int" c:type="int*"/>
 626         </parameter>
 627         <parameter name="argv" transfer-ownership="none">
 628           <doc xml:whitespace="preserve">a pointer to the array of command line arguments.</doc>
 629           <array length="0" c:type="char***">
 630             <type name="int8"/>
 631           </array>
 632         </parameter>
 633         <parameter name="parameter_string" transfer-ownership="none">
 634           <doc xml:whitespace="preserve">a string which is displayed in the first line of &lt;option&gt;--help&lt;/option&gt; output, after &lt;literal&gt;&lt;replaceable&gt;programname&lt;/replaceable&gt; [OPTION...]&lt;/literal&gt;</doc>
 635           <type name="utf8" c:type="char*"/>
 636         </parameter>
 637         <parameter name="entries" transfer-ownership="none">
 638           <doc xml:whitespace="preserve">a %NULL-terminated array of #GOptionEntry&lt;!-- --&gt;s describing the options of your program</doc>
 639           <type name="GLib.OptionEntry" c:type="GOptionEntry*"/>
 640         </parameter>
 641         <parameter name="translation_domain" transfer-ownership="none">
 642           <doc xml:whitespace="preserve">a translation domain to use for translating the &lt;option&gt;--help&lt;/option&gt; output for the options in @entries with gettext(), or %NULL</doc>
 643           <type name="utf8" c:type="char*"/>
 644         </parameter>
 645       </parameters>
 646     </function>
 647     <function name="texture_new_from_icon_name"
 648               c:identifier="gtk_clutter_texture_new_from_icon_name">
 649       <doc xml:whitespace="preserve">Creates a new #ClutterTexture and sets its contents to be
 650 the @icon_name from the current icon theme.
 651 was %NULL and @icon_name was not found.</doc>
 652       <return-value transfer-ownership="full">
 653         <doc xml:whitespace="preserve">the newly created texture, or %NULL if @widget</doc>
 654         <type name="Clutter.Actor" c:type="ClutterActor*"/>
 655       </return-value>
 656       <parameters>
 657         <parameter name="widget" transfer-ownership="none">
 658           <doc xml:whitespace="preserve">a #GtkWidget or %NULL</doc>
 659           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 660         </parameter>
 661         <parameter name="icon_name" transfer-ownership="none">
 662           <doc xml:whitespace="preserve">the name of the icon</doc>
 663           <type name="utf8" c:type="gchar*"/>
 664         </parameter>
 665         <parameter name="size" transfer-ownership="none">
 666           <doc xml:whitespace="preserve">the size of the icon, or -1</doc>
 667           <type name="Gtk.IconSize" c:type="GtkIconSize"/>
 668         </parameter>
 669       </parameters>
 670     </function>
 671     <function name="texture_new_from_pixbuf"
 672               c:identifier="gtk_clutter_texture_new_from_pixbuf">
 673       <doc xml:whitespace="preserve">Creates a new #ClutterTexture and sets its contents with a copy
 674 of @pixbuf.</doc>
 675       <return-value transfer-ownership="full">
 676         <doc xml:whitespace="preserve">the newly created #ClutterTexture</doc>
 677         <type name="Clutter.Actor" c:type="ClutterActor*"/>
 678       </return-value>
 679       <parameters>
 680         <parameter name="pixbuf" transfer-ownership="none">
 681           <doc xml:whitespace="preserve">a #GdkPixbuf</doc>
 682           <type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
 683         </parameter>
 684       </parameters>
 685     </function>
 686     <function name="texture_new_from_stock"
 687               c:identifier="gtk_clutter_texture_new_from_stock">
 688       <doc xml:whitespace="preserve">Creates a new #ClutterTexture and sets its contents using the stock
 689 icon @stock_id as rendered by @widget.</doc>
 690       <return-value transfer-ownership="full">
 691         <doc xml:whitespace="preserve">the newly created #ClutterTexture</doc>
 692         <type name="Clutter.Actor" c:type="ClutterActor*"/>
 693       </return-value>
 694       <parameters>
 695         <parameter name="widget" transfer-ownership="none">
 696           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 697           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 698         </parameter>
 699         <parameter name="stock_id" transfer-ownership="none">
 700           <doc xml:whitespace="preserve">the stock id of the icon</doc>
 701           <type name="utf8" c:type="gchar*"/>
 702         </parameter>
 703         <parameter name="size" transfer-ownership="none">
 704           <doc xml:whitespace="preserve">the size of the icon, or -1</doc>
 705           <type name="Gtk.IconSize" c:type="GtkIconSize"/>
 706         </parameter>
 707       </parameters>
 708     </function>
 709     <function name="texture_set_from_icon_name"
 710               c:identifier="gtk_clutter_texture_set_from_icon_name"
 711               throws="1">
 712       <doc xml:whitespace="preserve">Sets the contents of @texture using the @icon_name from the
 713 current icon theme.</doc>
 714       <return-value transfer-ownership="none">
 715         <doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure.</doc>
 716         <type name="boolean" c:type="gboolean"/>
 717       </return-value>
 718       <parameters>
 719         <parameter name="texture" transfer-ownership="none">
 720           <doc xml:whitespace="preserve">a #ClutterTexture</doc>
 721           <type name="Clutter.Texture" c:type="ClutterTexture*"/>
 722         </parameter>
 723         <parameter name="widget" transfer-ownership="none">
 724           <doc xml:whitespace="preserve">a #GtkWidget or %NULL</doc>
 725           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 726         </parameter>
 727         <parameter name="icon_name" transfer-ownership="none">
 728           <doc xml:whitespace="preserve">the name of the icon</doc>
 729           <type name="utf8" c:type="gchar*"/>
 730         </parameter>
 731         <parameter name="size" transfer-ownership="none">
 732           <doc xml:whitespace="preserve">the icon size or -1</doc>
 733           <type name="Gtk.IconSize" c:type="GtkIconSize"/>
 734         </parameter>
 735       </parameters>
 736     </function>
 737     <function name="texture_set_from_pixbuf"
 738               c:identifier="gtk_clutter_texture_set_from_pixbuf"
 739               throws="1">
 740       <doc xml:whitespace="preserve">Sets the contents of @texture with a copy of @pixbuf.</doc>
 741       <return-value transfer-ownership="none">
 742         <doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure.</doc>
 743         <type name="boolean" c:type="gboolean"/>
 744       </return-value>
 745       <parameters>
 746         <parameter name="texture" transfer-ownership="none">
 747           <doc xml:whitespace="preserve">a #ClutterTexture</doc>
 748           <type name="Clutter.Texture" c:type="ClutterTexture*"/>
 749         </parameter>
 750         <parameter name="pixbuf" transfer-ownership="none">
 751           <doc xml:whitespace="preserve">a #GdkPixbuf</doc>
 752           <type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
 753         </parameter>
 754       </parameters>
 755     </function>
 756     <function name="texture_set_from_stock"
 757               c:identifier="gtk_clutter_texture_set_from_stock"
 758               throws="1">
 759       <doc xml:whitespace="preserve">Sets the contents of @texture using the stock icon @stock_id, as
 760 rendered by @widget.</doc>
 761       <return-value transfer-ownership="none">
 762         <doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure.</doc>
 763         <type name="boolean" c:type="gboolean"/>
 764       </return-value>
 765       <parameters>
 766         <parameter name="texture" transfer-ownership="none">
 767           <doc xml:whitespace="preserve">a #ClutterTexture</doc>
 768           <type name="Clutter.Texture" c:type="ClutterTexture*"/>
 769         </parameter>
 770         <parameter name="widget" transfer-ownership="none">
 771           <doc xml:whitespace="preserve">a #GtkWidget</doc>
 772           <type name="Gtk.Widget" c:type="GtkWidget*"/>
 773         </parameter>
 774         <parameter name="stock_id" transfer-ownership="none">
 775           <doc xml:whitespace="preserve">the stock id of the icon</doc>
 776           <type name="utf8" c:type="gchar*"/>
 777         </parameter>
 778         <parameter name="size" transfer-ownership="none">
 779           <doc xml:whitespace="preserve">the size of the icon, or -1</doc>
 780           <type name="Gtk.IconSize" c:type="GtkIconSize"/>
 781         </parameter>
 782       </parameters>
 783     </function>
 784   </namespace>
 785 </repository>