← Back to branch summary

~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-base-plugins-textrender.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plugins/html/gst-plugins-base-plugins-textrender.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>textrender</title>
 
5
<title>GStreamer Base Plugins 1.0 Plugins Reference Manual: textrender</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
9
9
<link rel="prev" href="gst-plugins-base-plugins-textoverlay.html" title="textoverlay">
10
10
<link rel="next" href="gst-plugins-base-plugins-theoradec.html" title="theoradec">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="gst-plugins-base-plugins-textoverlay.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">GStreamer Base Plugins 1.0 Plugins Reference Manual</th>
21
 
<td><a accesskey="n" href="gst-plugins-base-plugins-theoradec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#gst-plugins-base-plugins-textrender.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#gst-plugins-base-plugins-textrender.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#gst-plugins-base-plugins-textrender.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#gst-plugins-base-plugins-textrender.properties" class="shortcut">Properties</a>
31
 
</td></tr>
32
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#gst-plugins-base-plugins-textrender.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-plugins-textrender.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 
 
20
                  <a href="#gst-plugins-base-plugins-textrender.properties" class="shortcut">Properties</a></span>
 
21
</td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
23
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="p" href="gst-plugins-base-plugins-textoverlay.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
25
<td><a accesskey="n" href="gst-plugins-base-plugins-theoradec.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
26
</tr></table>
33
27
<div class="refentry">
34
28
<a name="gst-plugins-base-plugins-textrender"></a><div class="titlepage"></div>
35
29
<div class="refnamediv"><table width="100%"><tr>
37
31
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-textrender.top_of_page"></a>textrender</span></h2>
38
32
<p>textrender — Renders a text string to an image bitmap</p>
39
33
</td>
40
 
<td valign="top" align="right"></td>
 
34
<td class="gallery_image" valign="top" align="right"></td>
41
35
</tr></table></div>
42
 
<div class="refsynopsisdiv">
43
 
<a name="gst-plugins-base-plugins-textrender.synopsis"></a><h2>Synopsis</h2>
44
 
<a name="GstTextRender"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender-struct" title="struct GstTextRender">GstTextRender</a>;
45
 
</pre>
 
36
<div class="refsect1">
 
37
<a name="gst-plugins-base-plugins-textrender.properties"></a><h2>Properties</h2>
 
38
<div class="informaltable"><table border="0">
 
39
<colgroup>
 
40
<col width="150px" class="properties_type">
 
41
<col width="300px" class="properties_name">
 
42
<col width="200px" class="properties_flags">
 
43
</colgroup>
 
44
<tbody>
 
45
<tr>
 
46
<td class="property_type">
 
47
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
48
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--font-desc" title="The “font-desc” property">font-desc</a></td>
 
49
<td class="property_flags">Write</td>
 
50
</tr>
 
51
<tr>
 
52
<td class="property_type"><span class="type">GstTextRenderHAlign</span></td>
 
53
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--halignment" title="The “halignment” property">halignment</a></td>
 
54
<td class="property_flags">Read / Write</td>
 
55
</tr>
 
56
<tr>
 
57
<td class="property_type"><span class="type">GstTextRenderLineAlign</span></td>
 
58
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--line-alignment" title="The “line-alignment” property">line-alignment</a></td>
 
59
<td class="property_flags">Read / Write</td>
 
60
</tr>
 
61
<tr>
 
62
<td class="property_type"><span class="type">GstTextRenderVAlign</span></td>
 
63
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--valignment" title="The “valignment” property">valignment</a></td>
 
64
<td class="property_flags">Read / Write</td>
 
65
</tr>
 
66
<tr>
 
67
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
68
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--xpad" title="The “xpad” property">xpad</a></td>
 
69
<td class="property_flags">Read / Write</td>
 
70
</tr>
 
71
<tr>
 
72
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
 
73
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--ypad" title="The “ypad” property">ypad</a></td>
 
74
<td class="property_flags">Read / Write</td>
 
75
</tr>
 
76
</tbody>
 
77
</table></div>
 
78
</div>
 
79
<a name="GstTextRender"></a><div class="refsect1">
 
80
<a name="gst-plugins-base-plugins-textrender.other"></a><h2>Types and Values</h2>
 
81
<div class="informaltable"><table width="100%" border="0">
 
82
<colgroup>
 
83
<col width="150px" class="name">
 
84
<col class="description">
 
85
</colgroup>
 
86
<tbody><tr>
 
87
<td class="datatype_keyword">struct</td>
 
88
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender-struct" title="struct GstTextRender">GstTextRender</a></td>
 
89
</tr></tbody>
 
90
</table></div>
46
91
</div>
47
92
<div class="refsect1">
48
93
<a name="gst-plugins-base-plugins-textrender.object-hierarchy"></a><h2>Object Hierarchy</h2>
49
 
<pre class="synopsis">
50
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
52
 
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
53
 
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
54
 
                     +----GstTextRender
55
 
</pre>
56
 
</div>
57
 
<div class="refsect1">
58
 
<a name="gst-plugins-base-plugins-textrender.properties"></a><h2>Properties</h2>
59
 
<pre class="synopsis">
60
 
  "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--font-desc" title='The "font-desc" property'>font-desc</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write
61
 
  "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--halignment" title='The "halignment" property'>halignment</a>"               <span class="type">GstTextRenderHAlign</span>   : Read / Write
62
 
  "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--line-alignment" title='The "line-alignment" property'>line-alignment</a>"           <span class="type">GstTextRenderLineAlign</span>  : Read / Write
63
 
  "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--valignment" title='The "valignment" property'>valignment</a>"               <span class="type">GstTextRenderVAlign</span>   : Read / Write
64
 
  "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--xpad" title='The "xpad" property'>xpad</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
65
 
  "<a class="link" href="gst-plugins-base-plugins-textrender.html#GstTextRender--ypad" title='The "ypad" property'>ypad</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
 
94
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
95
    <span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
96
        <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
 
97
            <span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
 
98
                <span class="lineart">╰──</span> GstTextRender
66
99
</pre>
67
100
</div>
68
101
<div class="refsect1">
70
103
<div class="refsynopsisdiv">
71
104
<h2>Synopsis</h2>
72
105
<div class="refsect2">
73
 
<a name="id-1.2.31.6.2.1"></a><h3>Element Information</h3>
 
106
<a name="id-1.2.31.7.2.1"></a><h3>Element Information</h3>
74
107
<div class="variablelist"><table border="0" class="variablelist">
75
108
<colgroup>
76
109
<col align="left" valign="top">
96
129
</div>
97
130
<hr>
98
131
<div class="refsect2">
99
 
<a name="id-1.2.31.6.2.2"></a><h3>Element Pads</h3>
 
132
<a name="id-1.2.31.7.2.2"></a><h3>Element Pads</h3>
100
133
<div class="variablelist"><table border="0" class="variablelist">
101
134
<colgroup>
102
135
<col align="left" valign="top">
151
184
</p>
152
185
</div>
153
186
<div class="refsect1">
154
 
<a name="gst-plugins-base-plugins-textrender.details"></a><h2>Details</h2>
 
187
<a name="gst-plugins-base-plugins-textrender.functions_details"></a><h2>Functions</h2>
 
188
</div>
 
189
<div class="refsect1">
 
190
<a name="gst-plugins-base-plugins-textrender.other_details"></a><h2>Types and Values</h2>
155
191
<div class="refsect2">
156
192
<a name="GstTextRender-struct"></a><h3>struct GstTextRender</h3>
157
193
<pre class="programlisting">struct GstTextRender;</pre>
162
198
<div class="refsect1">
163
199
<a name="gst-plugins-base-plugins-textrender.property-details"></a><h2>Property Details</h2>
164
200
<div class="refsect2">
165
 
<a name="GstTextRender--font-desc"></a><h3>The <code class="literal">"font-desc"</code> property</h3>
166
 
<pre class="programlisting">  "font-desc"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write</pre>
 
201
<a name="GstTextRender--font-desc"></a><h3>The <code class="literal">“font-desc”</code> property</h3>
 
202
<pre class="programlisting">  “font-desc”                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
167
203
<p>Pango font description of font to be used for rendering. See documentation of pango_font_description_from_string for syntax.</p>
 
204
<p>Flags: Write</p>
168
205
<p>Default value: ""</p>
169
206
</div>
170
207
<hr>
171
208
<div class="refsect2">
172
 
<a name="GstTextRender--halignment"></a><h3>The <code class="literal">"halignment"</code> property</h3>
173
 
<pre class="programlisting">  "halignment"               <span class="type">GstTextRenderHAlign</span>   : Read / Write</pre>
 
209
<a name="GstTextRender--halignment"></a><h3>The <code class="literal">“halignment”</code> property</h3>
 
210
<pre class="programlisting">  “halignment”               <span class="type">GstTextRenderHAlign</span></pre>
174
211
<p>Horizontal alignment of the text.</p>
 
212
<p>Flags: Read / Write</p>
175
213
<p>Default value: center</p>
176
214
</div>
177
215
<hr>
178
216
<div class="refsect2">
179
 
<a name="GstTextRender--line-alignment"></a><h3>The <code class="literal">"line-alignment"</code> property</h3>
180
 
<pre class="programlisting">  "line-alignment"           <span class="type">GstTextRenderLineAlign</span>  : Read / Write</pre>
 
217
<a name="GstTextRender--line-alignment"></a><h3>The <code class="literal">“line-alignment”</code> property</h3>
 
218
<pre class="programlisting">  “line-alignment”           <span class="type">GstTextRenderLineAlign</span></pre>
181
219
<p>Alignment of text lines relative to each other.</p>
 
220
<p>Flags: Read / Write</p>
182
221
<p>Default value: center</p>
183
222
</div>
184
223
<hr>
185
224
<div class="refsect2">
186
 
<a name="GstTextRender--valignment"></a><h3>The <code class="literal">"valignment"</code> property</h3>
187
 
<pre class="programlisting">  "valignment"               <span class="type">GstTextRenderVAlign</span>   : Read / Write</pre>
 
225
<a name="GstTextRender--valignment"></a><h3>The <code class="literal">“valignment”</code> property</h3>
 
226
<pre class="programlisting">  “valignment”               <span class="type">GstTextRenderVAlign</span></pre>
188
227
<p>Vertical alignment of the text.</p>
 
228
<p>Flags: Read / Write</p>
189
229
<p>Default value: baseline</p>
190
230
</div>
191
231
<hr>
192
232
<div class="refsect2">
193
 
<a name="GstTextRender--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
194
 
<pre class="programlisting">  "xpad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
233
<a name="GstTextRender--xpad"></a><h3>The <code class="literal">“xpad”</code> property</h3>
 
234
<pre class="programlisting">  “xpad”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
195
235
<p>Horizontal paddding when using left/right alignment.</p>
 
236
<p>Flags: Read / Write</p>
196
237
<p>Allowed values: &gt;= 0</p>
197
238
<p>Default value: 25</p>
198
239
</div>
199
240
<hr>
200
241
<div class="refsect2">
201
 
<a name="GstTextRender--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
202
 
<pre class="programlisting">  "ypad"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
242
<a name="GstTextRender--ypad"></a><h3>The <code class="literal">“ypad”</code> property</h3>
 
243
<pre class="programlisting">  “ypad”                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
203
244
<p>Vertical padding when using top/bottom alignment.</p>
 
245
<p>Flags: Read / Write</p>
204
246
<p>Allowed values: &gt;= 0</p>
205
247
<p>Default value: 25</p>
206
248
</div>
208
250
</div>
209
251
<div class="footer">
210
252
<hr>
211
 
          Generated by GTK-Doc V1.19</div>
 
253
          Generated by GTK-Doc V1.20</div>
212
254
</body>
213
255
</html>
 
 
b'\\ No newline at end of file'