~ubuntu-branches/ubuntu/quantal/gst-plugins-bad-multiverse0.10/quantal

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-bad-plugins-square.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-09-03 16:57:09 UTC
  • mfrom: (1.1.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20100903165709-5158pp06sfg0i6dv
Tags: 0.10.20-1
* New upstream release:
  + debian/build-deps.in:
    - Update build dependencies.
* debian/source/format,
  debian/compat,
  debian/rules,
  debian/patches:
  + Update to debhelper compat level 7.
  + Update to source format 3.0 (quilt).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>square</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
 
8
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
 
9
<link rel="prev" href="gst-plugins-bad-plugins-sphere.html" title="sphere">
 
10
<link rel="next" href="gst-plugins-bad-plugins-stereo.html" title="stereo">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
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-bad-plugins-sphere.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 Bad Plugins 0.10 Plugins Reference Manual</th>
 
21
<td><a accesskey="n" href="gst-plugins-bad-plugins-stereo.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-bad-plugins-square.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#gst-plugins-bad-plugins-square.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#gst-plugins-bad-plugins-square.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#gst-plugins-bad-plugins-square.properties" class="shortcut">Properties</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry" title="square">
 
34
<a name="gst-plugins-bad-plugins-square"></a><div class="titlepage"></div>
 
35
<div class="refnamediv"><table width="100%"><tr>
 
36
<td valign="top">
 
37
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-square.top_of_page"></a>square</span></h2>
 
38
<p>square — Distort center part of the image into a square</p>
 
39
</td>
 
40
<td valign="top" align="right"></td>
 
41
</tr></table></div>
 
42
<div class="refsynopsisdiv" title="Synopsis">
 
43
<a name="gst-plugins-bad-plugins-square.synopsis"></a><h2>Synopsis</h2>
 
44
<a name="GstSquare"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare-struct" title="GstSquare">GstSquare</a>;
 
45
</pre>
 
46
</div>
 
47
<div class="refsect1" title="Object Hierarchy">
 
48
<a name="gst-plugins-bad-plugins-square.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
49
<pre class="synopsis">
 
50
  <a href="http://library.gnome.org/devel/gobject/stable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
51
   +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
 
52
         +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
 
53
               +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
 
54
                     +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
 
55
                           +----GstGeometricTransform
 
56
                                 +----GstSquare
 
57
</pre>
 
58
</div>
 
59
<div class="refsect1" title="Properties">
 
60
<a name="gst-plugins-bad-plugins-square.properties"></a><h2>Properties</h2>
 
61
<pre class="synopsis">
 
62
  "<a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare--height" title='The "height" property'>height</a>"                   <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
 
63
  "<a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare--width" title='The "width" property'>width</a>"                    <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
 
64
  "<a class="link" href="gst-plugins-bad-plugins-square.html#GstSquare--zoom" title='The "zoom" property'>zoom</a>"                     <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
 
65
</pre>
 
66
</div>
 
67
<div class="refsect1" title="Description">
 
68
<a name="gst-plugins-bad-plugins-square.description"></a><h2>Description</h2>
 
69
<div class="refsynopsisdiv" title="Synopsis">
 
70
<h2>Synopsis</h2>
 
71
<div class="refsect2" title="Element Information">
 
72
<a name="id450692"></a><h3>Element Information</h3>
 
73
<div class="variablelist"><table border="0">
 
74
<col align="left" valign="top">
 
75
<tbody>
 
76
<tr>
 
77
<td><p><span class="term">plugin</span></p></td>
 
78
<td>
 
79
            <a class="link" href="gst-plugins-bad-plugins-plugin-geometrictransform.html#plugin-geometrictransform">geometrictransform</a>
 
80
          </td>
 
81
</tr>
 
82
<tr>
 
83
<td><p><span class="term">author</span></p></td>
 
84
<td>Filippo Argiolas &lt;filippo.argiolas@gmail.com</td>
 
85
</tr>
 
86
<tr>
 
87
<td><p><span class="term">class</span></p></td>
 
88
<td>Transform/Effect/Video</td>
 
89
</tr>
 
90
</tbody>
 
91
</table></div>
 
92
</div>
 
93
<hr>
 
94
<div class="refsect2" title="Element Pads">
 
95
<a name="id450636"></a><h3>Element Pads</h3>
 
96
<div class="variablelist"><table border="0">
 
97
<col align="left" valign="top">
 
98
<tbody>
 
99
<tr>
 
100
<td><p><span class="term">name</span></p></td>
 
101
<td>sink</td>
 
102
</tr>
 
103
<tr>
 
104
<td><p><span class="term">direction</span></p></td>
 
105
<td>sink</td>
 
106
</tr>
 
107
<tr>
 
108
<td><p><span class="term">presence</span></p></td>
 
109
<td>always</td>
 
110
</tr>
 
111
<tr>
 
112
<td><p><span class="term">details</span></p></td>
 
113
<td>video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
114
</tr>
 
115
<tr>
 
116
<td><p><span class="term"></span></p></td>
 
117
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
118
</tr>
 
119
<tr>
 
120
<td><p><span class="term"></span></p></td>
 
121
<td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
122
</tr>
 
123
<tr>
 
124
<td><p><span class="term"></span></p></td>
 
125
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
126
</tr>
 
127
<tr>
 
128
<td><p><span class="term"></span></p></td>
 
129
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
130
</tr>
 
131
<tr>
 
132
<td><p><span class="term"></span></p></td>
 
133
<td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
134
</tr>
 
135
<tr>
 
136
<td><p><span class="term"></span></p></td>
 
137
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
138
</tr>
 
139
<tr>
 
140
<td><p><span class="term"></span></p></td>
 
141
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
142
</tr>
 
143
<tr>
 
144
<td><p><span class="term"></span></p></td>
 
145
<td> video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
146
</tr>
 
147
<tr>
 
148
<td><p><span class="term"></span></p></td>
 
149
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
150
</tr>
 
151
<tr>
 
152
<td><p><span class="term"></span></p></td>
 
153
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term"></span></p></td>
 
157
<td> video/x-raw-gray, bpp=(int)8, depth=(int)8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
158
</tr>
 
159
<tr>
 
160
<td><p><span class="term"></span></p></td>
 
161
<td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)4321, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
162
</tr>
 
163
<tr>
 
164
<td><p><span class="term"></span></p></td>
 
165
<td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)1234, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
166
</tr>
 
167
</tbody>
 
168
</table></div>
 
169
<div class="variablelist"><table border="0">
 
170
<col align="left" valign="top">
 
171
<tbody>
 
172
<tr>
 
173
<td><p><span class="term">name</span></p></td>
 
174
<td>src</td>
 
175
</tr>
 
176
<tr>
 
177
<td><p><span class="term">direction</span></p></td>
 
178
<td>source</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term">presence</span></p></td>
 
182
<td>always</td>
 
183
</tr>
 
184
<tr>
 
185
<td><p><span class="term">details</span></p></td>
 
186
<td>video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
187
</tr>
 
188
<tr>
 
189
<td><p><span class="term"></span></p></td>
 
190
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
191
</tr>
 
192
<tr>
 
193
<td><p><span class="term"></span></p></td>
 
194
<td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
195
</tr>
 
196
<tr>
 
197
<td><p><span class="term"></span></p></td>
 
198
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
199
</tr>
 
200
<tr>
 
201
<td><p><span class="term"></span></p></td>
 
202
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
203
</tr>
 
204
<tr>
 
205
<td><p><span class="term"></span></p></td>
 
206
<td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
207
</tr>
 
208
<tr>
 
209
<td><p><span class="term"></span></p></td>
 
210
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
211
</tr>
 
212
<tr>
 
213
<td><p><span class="term"></span></p></td>
 
214
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
215
</tr>
 
216
<tr>
 
217
<td><p><span class="term"></span></p></td>
 
218
<td> video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
219
</tr>
 
220
<tr>
 
221
<td><p><span class="term"></span></p></td>
 
222
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
223
</tr>
 
224
<tr>
 
225
<td><p><span class="term"></span></p></td>
 
226
<td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
227
</tr>
 
228
<tr>
 
229
<td><p><span class="term"></span></p></td>
 
230
<td> video/x-raw-gray, bpp=(int)8, depth=(int)8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
231
</tr>
 
232
<tr>
 
233
<td><p><span class="term"></span></p></td>
 
234
<td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)4321, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
235
</tr>
 
236
<tr>
 
237
<td><p><span class="term"></span></p></td>
 
238
<td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)1234, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 
239
</tr>
 
240
</tbody>
 
241
</table></div>
 
242
</div>
 
243
</div>
 
244
<p>
 
245
</p>
 
246
</div>
 
247
<div class="refsect1" title="Details">
 
248
<a name="gst-plugins-bad-plugins-square.details"></a><h2>Details</h2>
 
249
<div class="refsect2" title="GstSquare">
 
250
<a name="GstSquare-struct"></a><h3>GstSquare</h3>
 
251
<pre class="programlisting">typedef struct _GstSquare GstSquare;</pre>
 
252
<p>
 
253
</p>
 
254
</div>
 
255
</div>
 
256
<div class="refsect1" title="Property Details">
 
257
<a name="gst-plugins-bad-plugins-square.property-details"></a><h2>Property Details</h2>
 
258
<div class="refsect2" title='The "height" property'>
 
259
<a name="GstSquare--height"></a><h3>The <code class="literal">"height"</code> property</h3>
 
260
<pre class="programlisting">  "height"                   <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
261
<p>Height of the square, relative to the frame height.</p>
 
262
<p>Allowed values: [0,1]</p>
 
263
<p>Default value: 0.5</p>
 
264
</div>
 
265
<hr>
 
266
<div class="refsect2" title='The "width" property'>
 
267
<a name="GstSquare--width"></a><h3>The <code class="literal">"width"</code> property</h3>
 
268
<pre class="programlisting">  "width"                    <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
269
<p>Width of the square, relative to the frame width.</p>
 
270
<p>Allowed values: [0,1]</p>
 
271
<p>Default value: 0.5</p>
 
272
</div>
 
273
<hr>
 
274
<div class="refsect2" title='The "zoom" property'>
 
275
<a name="GstSquare--zoom"></a><h3>The <code class="literal">"zoom"</code> property</h3>
 
276
<pre class="programlisting">  "zoom"                     <a href="http://library.gnome.org/devel/glib/stable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
277
<p>Zoom amount in the center region.</p>
 
278
<p>Allowed values: [1,100]</p>
 
279
<p>Default value: 2</p>
 
280
</div>
 
281
</div>
 
282
</div>
 
283
<div class="footer">
 
284
<hr>
 
285
          Generated by GTK-Doc V1.15</div>
 
286
</body>
 
287
</html>
 
 
b'\\ No newline at end of file'