← Back to branch summary

~ubuntu-branches/ubuntu/quantal/qtmobility/quantal

« back to all changes in this revision

Viewing changes to doc/html/qvideosurfaceformat.html

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-16 16:18:07 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20101116161807-k2dzt2nyse975r3l
Tags: 1.1.0-0ubuntu1
* New upstream release
* Syncronise with Debian, no remaining changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qvideosurfaceformat.html
47
47
    </div>
48
48
    <div id="shortCut">
49
49
      <ul>
50
 
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1 BETA</a></span></li>
 
50
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1</a></span></li>
51
51
        <li class="shortCut-topleft-active"><a href="http://doc.qt.nokia.com">ALL VERSIONS        </a></li>
52
52
      </ul>
53
53
     </div>
231
231
<h2>Member Function Documentation</h2>
232
232
<h3 class="fn"><a name="QVideoSurfaceFormat"></a>QVideoSurfaceFormat::QVideoSurfaceFormat ()</h3>
233
233
<p>Constructs a null video stream format.</p>
234
 
<h3 class="fn"><a name="QVideoSurfaceFormat-2"></a>QVideoSurfaceFormat::QVideoSurfaceFormat ( const QSize &amp; <i>size</i>, <a href="qvideoframe.html#PixelFormat-enum">QVideoFrame::PixelFormat</a> <i>format</i>, <a href="qabstractvideobuffer.html#HandleType-enum">QAbstractVideoBuffer::HandleType</a> <i>type</i> = QAbstractVideoBuffer::NoHandle )</h3>
 
234
<h3 class="fn"><a name="QVideoSurfaceFormat-2"></a>QVideoSurfaceFormat::QVideoSurfaceFormat ( const <a href="http://qt.nokia.com/doc/4.6/qsize.html">QSize</a> &amp; <i>size</i>, <a href="qvideoframe.html#PixelFormat-enum">QVideoFrame::PixelFormat</a> <i>format</i>, <a href="qabstractvideobuffer.html#HandleType-enum">QAbstractVideoBuffer::HandleType</a> <i>type</i> = QAbstractVideoBuffer::NoHandle )</h3>
235
235
<p>Contructs a description of stream which receives stream of <i>type</i> buffers with given frame <i>size</i> and pixel <i>format</i>.</p>
236
236
<h3 class="fn"><a name="QVideoSurfaceFormat-3"></a>QVideoSurfaceFormat::QVideoSurfaceFormat ( const QVideoSurfaceFormat &amp; <i>other</i> )</h3>
237
237
<p>Constructs a copy of <i>other</i>.</p>
239
239
<p>Destroys a video stream description.</p>
240
240
<h3 class="fn"><a name="frameHeight"></a>int QVideoSurfaceFormat::frameHeight () const</h3>
241
241
<p>Returns the height of frame in a video stream.</p>
242
 
<h3 class="fn"><a name="frameRate"></a>qreal QVideoSurfaceFormat::frameRate () const</h3>
 
242
<h3 class="fn"><a name="frameRate"></a><a href="http://qt.nokia.com/doc/4.6/qtglobal.html#qreal-typedef">qreal</a> QVideoSurfaceFormat::frameRate () const</h3>
243
243
<p>Returns the frame rate of a video stream in frames per second.</p>
244
244
<p>See also <a href="qvideosurfaceformat.html#setFrameRate">setFrameRate</a>().</p>
245
 
<h3 class="fn"><a name="frameSize"></a>QSize QVideoSurfaceFormat::frameSize () const</h3>
 
245
<h3 class="fn"><a name="frameSize"></a><a href="http://qt.nokia.com/doc/4.6/qsize.html">QSize</a> QVideoSurfaceFormat::frameSize () const</h3>
246
246
<p>Returns the size of frames in a video stream.</p>
247
247
<p>See also <a href="qvideosurfaceformat.html#setFrameSize">setFrameSize</a>(), <a href="qvideosurfaceformat.html#frameWidth">frameWidth</a>(), and <a href="qvideosurfaceformat.html#frameHeight">frameHeight</a>().</p>
248
248
<h3 class="fn"><a name="frameWidth"></a>int QVideoSurfaceFormat::frameWidth () const</h3>
254
254
<h3 class="fn"><a name="isValid"></a>bool QVideoSurfaceFormat::isValid () const</h3>
255
255
<p>Identifies if a video surface format has a valid pixel format and frame size.</p>
256
256
<p>Returns true if the format is valid, and false otherwise.</p>
257
 
<h3 class="fn"><a name="pixelAspectRatio"></a>QSize QVideoSurfaceFormat::pixelAspectRatio () const</h3>
 
257
<h3 class="fn"><a name="pixelAspectRatio"></a><a href="http://qt.nokia.com/doc/4.6/qsize.html">QSize</a> QVideoSurfaceFormat::pixelAspectRatio () const</h3>
258
258
<p>Returns a video stream's pixel aspect ratio.</p>
259
259
<p>See also <a href="qvideosurfaceformat.html#setPixelAspectRatio">setPixelAspectRatio</a>().</p>
260
260
<h3 class="fn"><a name="pixelFormat"></a><a href="qvideoframe.html#PixelFormat-enum">QVideoFrame::PixelFormat</a> QVideoSurfaceFormat::pixelFormat () const</h3>
261
261
<p>Returns the pixel format of frames in a video stream.</p>
262
 
<h3 class="fn"><a name="property"></a>QVariant QVideoSurfaceFormat::property ( const char * <i>name</i> ) const</h3>
 
262
<h3 class="fn"><a name="property"></a><a href="http://qt.nokia.com/doc/4.6/qvariant.html">QVariant</a> QVideoSurfaceFormat::property ( const char * <i>name</i> ) const</h3>
263
263
<p>Returns the value of the video format's <i>name</i> property.</p>
264
264
<p>See also <a href="qvideosurfaceformat.html#setProperty">setProperty</a>().</p>
265
 
<h3 class="fn"><a name="propertyNames"></a>QList&lt;QByteArray&gt; QVideoSurfaceFormat::propertyNames () const</h3>
 
265
<h3 class="fn"><a name="propertyNames"></a><a href="http://qt.nokia.com/doc/4.6/qlist.html">QList</a>&lt;<a href="http://qt.nokia.com/doc/4.6/qbytearray.html">QByteArray</a>&gt; QVideoSurfaceFormat::propertyNames () const</h3>
266
266
<p>Returns a list of video format dynamic property names.</p>
267
267
<h3 class="fn"><a name="scanLineDirection"></a><a href="qvideosurfaceformat.html#Direction-enum">Direction</a> QVideoSurfaceFormat::scanLineDirection () const</h3>
268
268
<p>Returns the direction of scan lines.</p>
269
269
<p>See also <a href="qvideosurfaceformat.html#setScanLineDirection">setScanLineDirection</a>().</p>
270
 
<h3 class="fn"><a name="setFrameRate"></a>void QVideoSurfaceFormat::setFrameRate ( qreal <i>rate</i> )</h3>
 
270
<h3 class="fn"><a name="setFrameRate"></a>void QVideoSurfaceFormat::setFrameRate ( <a href="http://qt.nokia.com/doc/4.6/qtglobal.html#qreal-typedef">qreal</a> <i>rate</i> )</h3>
271
271
<p>Sets the frame <i>rate</i> of a video stream in frames per second.</p>
272
272
<p>See also <a href="qvideosurfaceformat.html#frameRate">frameRate</a>().</p>
273
 
<h3 class="fn"><a name="setFrameSize"></a>void QVideoSurfaceFormat::setFrameSize ( const QSize &amp; <i>size</i> )</h3>
 
273
<h3 class="fn"><a name="setFrameSize"></a>void QVideoSurfaceFormat::setFrameSize ( const <a href="http://qt.nokia.com/doc/4.6/qsize.html">QSize</a> &amp; <i>size</i> )</h3>
274
274
<p>Sets the size of frames in a video stream to <i>size</i>.</p>
275
275
<p>This will reset the <a href="qvideosurfaceformat.html#viewport">viewport</a>() to fill the entire frame.</p>
276
276
<p>See also <a href="qvideosurfaceformat.html#frameSize">frameSize</a>().</p>
278
278
<p>This is an overloaded function.</p>
279
279
<p>Sets the <i>width</i> and <i>height</i> of frames in a video stream.</p>
280
280
<p>This will reset the <a href="qvideosurfaceformat.html#viewport">viewport</a>() to fill the entire frame.</p>
281
 
<h3 class="fn"><a name="setPixelAspectRatio"></a>void QVideoSurfaceFormat::setPixelAspectRatio ( const QSize &amp; <i>ratio</i> )</h3>
 
281
<h3 class="fn"><a name="setPixelAspectRatio"></a>void QVideoSurfaceFormat::setPixelAspectRatio ( const <a href="http://qt.nokia.com/doc/4.6/qsize.html">QSize</a> &amp; <i>ratio</i> )</h3>
282
282
<p>Sets a video stream's pixel aspect <i>ratio</i>.</p>
283
283
<p>See also <a href="qvideosurfaceformat.html#pixelAspectRatio">pixelAspectRatio</a>().</p>
284
284
<h3 class="fn"><a name="setPixelAspectRatio-2"></a>void QVideoSurfaceFormat::setPixelAspectRatio ( int <i>horizontal</i>, int <i>vertical</i> )</h3>
285
285
<p>This is an overloaded function.</p>
286
286
<p>Sets the <i>horizontal</i> and <i>vertical</i> elements of a video stream's pixel aspect ratio.</p>
287
 
<h3 class="fn"><a name="setProperty"></a>void QVideoSurfaceFormat::setProperty ( const char * <i>name</i>, const QVariant &amp; <i>value</i> )</h3>
 
287
<h3 class="fn"><a name="setProperty"></a>void QVideoSurfaceFormat::setProperty ( const char * <i>name</i>, const <a href="http://qt.nokia.com/doc/4.6/qvariant.html">QVariant</a> &amp; <i>value</i> )</h3>
288
288
<p>Sets the video format's <i>name</i> property to <i>value</i>.</p>
289
289
<p>See also <a href="qvideosurfaceformat.html#property">property</a>().</p>
290
290
<h3 class="fn"><a name="setScanLineDirection"></a>void QVideoSurfaceFormat::setScanLineDirection ( <a href="qvideosurfaceformat.html#Direction-enum">Direction</a> <i>direction</i> )</h3>
291
291
<p>Sets the <i>direction</i> of scan lines.</p>
292
292
<p>See also <a href="qvideosurfaceformat.html#scanLineDirection">scanLineDirection</a>().</p>
293
 
<h3 class="fn"><a name="setViewport"></a>void QVideoSurfaceFormat::setViewport ( const QRect &amp; <i>viewport</i> )</h3>
 
293
<h3 class="fn"><a name="setViewport"></a>void QVideoSurfaceFormat::setViewport ( const <a href="http://qt.nokia.com/doc/4.6/qrect.html">QRect</a> &amp; <i>viewport</i> )</h3>
294
294
<p>Sets the viewport of a video stream to <i>viewport</i>.</p>
295
295
<p>See also <a href="qvideosurfaceformat.html#viewport">viewport</a>().</p>
296
296
<h3 class="fn"><a name="setYCbCrColorSpace"></a>void QVideoSurfaceFormat::setYCbCrColorSpace ( <a href="qvideosurfaceformat.html#YCbCrColorSpace-enum">YCbCrColorSpace</a> <i>space</i> )</h3>
297
297
<p>Sets the Y'CbCr color <i>space</i> of a video stream. It is only used with raw YUV frame types.</p>
298
298
<p>See also <a href="qvideosurfaceformat.html#yCbCrColorSpace">yCbCrColorSpace</a>().</p>
299
 
<h3 class="fn"><a name="sizeHint"></a>QSize QVideoSurfaceFormat::sizeHint () const</h3>
 
299
<h3 class="fn"><a name="sizeHint"></a><a href="http://qt.nokia.com/doc/4.6/qsize.html">QSize</a> QVideoSurfaceFormat::sizeHint () const</h3>
300
300
<p>Returns a suggested size in pixels for the video stream.</p>
301
301
<p>This is the size of the viewport scaled according to the pixel aspect ratio.</p>
302
 
<h3 class="fn"><a name="viewport"></a>QRect QVideoSurfaceFormat::viewport () const</h3>
 
302
<h3 class="fn"><a name="viewport"></a><a href="http://qt.nokia.com/doc/4.6/qrect.html">QRect</a> QVideoSurfaceFormat::viewport () const</h3>
303
303
<p>Returns the viewport of a video stream.</p>
304
304
<p>The viewport is the region of a video frame that is actually displayed.</p>
305
305
<p>By default the viewport covers an entire frame.</p>