1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="GtkClutterEmbed">
<refmeta>
<refentrytitle role="top_of_page" id="GtkClutterEmbed.top_of_page">GtkClutterEmbed</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER-GTK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkClutterEmbed</refname>
<refpurpose>Widget for embedding a Clutter scene</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GtkClutterEmbed.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GtkClutterEmbed-struct">GtkClutterEmbed</link>;
<link linkend="GtkClutterEmbedClass">GtkClutterEmbedClass</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-clutter-embed-new">gtk_clutter_embed_new</link> (void);
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="gtk-clutter-embed-get-stage">gtk_clutter_embed_get_stage</link> (<link linkend="GtkClutterEmbed">GtkClutterEmbed</link> *embed);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GtkClutterEmbed.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----GtkClutterEmbed
</synopsis>
</refsect1>
<refsect1 id="GtkClutterEmbed.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkClutterEmbed implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="GtkClutterEmbed.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GtkClutterEmbed"><type>GtkClutterEmbed</type></link> is a GTK+ widget embedding a <link linkend="ClutterStage"><type>ClutterStage</type></link>. Using
a <link linkend="GtkClutterEmbed"><type>GtkClutterEmbed</type></link> widget is possible to build, show and interact with
a scene built using Clutter inside a GTK+ application.
</para>
<para>
<note>To avoid flickering on show, you should call <link linkend="gtk-widget-show"><function>gtk_widget_show()</function></link>
or <link linkend="gtk-widget-realize"><function>gtk_widget_realize()</function></link> before calling <link linkend="clutter-actor-show"><function>clutter_actor_show()</function></link> on the
embedded <link linkend="ClutterStage"><type>ClutterStage</type></link> actor. This is needed for Clutter to be able
to paint on the <link linkend="GtkClutterEmbed"><type>GtkClutterEmbed</type></link> widget.</note></para>
<para>
</para>
</refsect1>
<refsect1 id="GtkClutterEmbed.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkClutterEmbed-struct" role="struct">
<title>GtkClutterEmbed</title>
<indexterm zone="GtkClutterEmbed-struct" role="0.6"><primary>GtkClutterEmbed</primary></indexterm><programlisting>typedef struct _GtkClutterEmbed GtkClutterEmbed;</programlisting>
<para>
A <link linkend="GtkWidget"><type>GtkWidget</type></link> containing the default Clutter stage.</para>
<para>
</para><para role="since">Since 0.6
</para></refsect2>
<refsect2 id="GtkClutterEmbedClass" role="struct" condition="since:0.6">
<title>GtkClutterEmbedClass</title>
<indexterm zone="GtkClutterEmbedClass" role="0.6"><primary>GtkClutterEmbedClass</primary></indexterm><programlisting>typedef struct {
} GtkClutterEmbedClass;
</programlisting>
<para>
Base class for <link linkend="GtkClutterEmbed"><type>GtkClutterEmbed</type></link>.</para>
<para>
</para><para role="since">Since 0.6
</para></refsect2>
<refsect2 id="gtk-clutter-embed-new" role="function" condition="since:0.6">
<title>gtk_clutter_embed_new ()</title>
<indexterm zone="gtk-clutter-embed-new" role="0.6"><primary>gtk_clutter_embed_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_clutter_embed_new (void);</programlisting>
<para>
Creates a new <link linkend="GtkClutterEmbed"><type>GtkClutterEmbed</type></link> widget. This widget can be
used to build a scene using Clutter API into a GTK+ application.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="GtkClutterEmbed"><type>GtkClutterEmbed</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.6
</para></refsect2>
<refsect2 id="gtk-clutter-embed-get-stage" role="function" condition="since:0.6">
<title>gtk_clutter_embed_get_stage ()</title>
<indexterm zone="gtk-clutter-embed-get-stage" role="0.6"><primary>gtk_clutter_embed_get_stage</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* gtk_clutter_embed_get_stage (<link linkend="GtkClutterEmbed">GtkClutterEmbed</link> *embed);</programlisting>
<para>
Retrieves the <link linkend="ClutterStage"><type>ClutterStage</type></link> from <parameter>embed</parameter>. The returned stage can be
used to add actors to the Clutter scene.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>embed</parameter> :</term>
<listitem><simpara> a <link linkend="GtkClutterEmbed"><type>GtkClutterEmbed</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the Clutter stage. You should never destroy or unref
the returned actor.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.6
</para></refsect2>
</refsect1>
</refentry>
|
