/usr/share/qt5/doc/qtmultimedia/qabstractplanarvideobuffer.html is in qtmultimedia5-doc-html 5.9.5-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qabstractvideobuffer.cpp -->
<title>QAbstractPlanarVideoBuffer Class | Qt Multimedia 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QAbstractPlanarVideoBuffer</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAbstractPlanarVideoBuffer Class</h1>
<!-- $$$QAbstractPlanarVideoBuffer-brief -->
<p>The <a href="qabstractplanarvideobuffer.html">QAbstractPlanarVideoBuffer</a> class is an abstraction for planar video data. <a href="#details">More...</a></p>
<!-- @@@QAbstractPlanarVideoBuffer -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAbstractPlanarVideoBuffer></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qabstractvideobuffer.html">QAbstractVideoBuffer</a></td></tr></table></div><ul>
<li><a href="qabstractplanarvideobuffer-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractplanarvideobuffer.html#QAbstractPlanarVideoBuffer">QAbstractPlanarVideoBuffer</a></b>(HandleType <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qabstractplanarvideobuffer.html#dtor.QAbstractPlanarVideoBuffer">~QAbstractPlanarVideoBuffer</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qabstractplanarvideobuffer.html#map">map</a></b>(MapMode <i>mode</i>, int *<i>numBytes</i>, int[4] <i>bytesPerLine</i>, uchar *[4] <i>data</i>) = 0</td></tr>
</table></div>
<ul>
<li class="fn">7 public functions inherited from <a href="qabstractvideobuffer.html#public-functions">QAbstractVideoBuffer</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAbstractPlanarVideoBuffer-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qabstractplanarvideobuffer.html">QAbstractPlanarVideoBuffer</a> class is an abstraction for planar video data.</p>
<p><a href="qabstractplanarvideobuffer.html">QAbstractPlanarVideoBuffer</a> extends <a href="qabstractvideobuffer.html">QAbstractVideoBuffer</a> to support mapping non-continuous planar video data. Implement this instead of <a href="qabstractvideobuffer.html">QAbstractVideoBuffer</a> when the abstracted video data stores planes in separate buffers or includes padding between planes which would interfere with calculating offsets from the bytes per line and frame height.</p>
</div>
<p><b>See also </b><a href="qabstractvideobuffer.html#mapPlanes">QAbstractVideoBuffer::mapPlanes</a>().</p>
<!-- @@@QAbstractPlanarVideoBuffer -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAbstractPlanarVideoBuffer[overload1]$$$QAbstractPlanarVideoBufferHandleType -->
<h3 class="fn" id="QAbstractPlanarVideoBuffer"><a name="QAbstractPlanarVideoBuffer"></a>QAbstractPlanarVideoBuffer::<span class="name">QAbstractPlanarVideoBuffer</span>(<span class="type"><a href="qabstractvideobuffer.html#HandleType-enum">HandleType</a></span> <i>type</i>)</h3>
<p>Constructs an abstract planar video buffer of the given <i>type</i>.</p>
<!-- @@@QAbstractPlanarVideoBuffer -->
<!-- $$$~QAbstractPlanarVideoBuffer[overload1]$$$~QAbstractPlanarVideoBuffer -->
<h3 class="fn" id="dtor.QAbstractPlanarVideoBuffer"><a name="dtor.QAbstractPlanarVideoBuffer"></a><code>[virtual] </code>QAbstractPlanarVideoBuffer::<span class="name">~QAbstractPlanarVideoBuffer</span>()</h3>
<p>Destroys an abstract planar video buffer.</p>
<!-- @@@~QAbstractPlanarVideoBuffer -->
<!-- $$$map[overload1]$$$mapMapModeint*int[4]uchar*[4] -->
<h3 class="fn" id="map"><a name="map"></a><code>[pure virtual] </code><span class="type">int</span> QAbstractPlanarVideoBuffer::<span class="name">map</span>(<span class="type"><a href="qabstractvideobuffer.html#MapMode-enum">MapMode</a></span> <i>mode</i>, <span class="type">int</span> *<i>numBytes</i>, <span class="type">int</span>[<span class="type">4</span>] <i>bytesPerLine</i>, <span class="type"><a href="../qtcore/qtglobal.html#uchar-typedef">uchar</a></span> *[<span class="type">4</span>] <i>data</i>)</h3>
<p>Maps the contents of a video buffer to memory.</p>
<p>The map <i>mode</i> indicates whether the contents of the mapped memory should be read from and/or written to the buffer. If the map mode includes the <code>QAbstractVideoBuffer::ReadOnly</code> flag the mapped memory will be populated with the content of the buffer when initially mapped. If the map mode includes the <code>QAbstractVideoBuffer::WriteOnly</code> flag the content of the possibly modified mapped memory will be written back to the buffer when unmapped.</p>
<p>When access to the data is no longer needed be sure to call the <a href="qabstractvideobuffer.html#unmap">unmap</a>() function to release the mapped memory and possibly update the buffer contents.</p>
<p>Returns the number of planes in the mapped video data. For each plane the line stride of that plane will be returned in <i>bytesPerLine</i>, and a pointer to the plane data will be returned in <i>data</i>. The accumulative size of the mapped data is returned in <i>numBytes</i>.</p>
<p><b>See also </b><a href="qabstractvideobuffer.html#map">QAbstractVideoBuffer::map</a>(), <a href="qabstractvideobuffer.html#unmap">QAbstractVideoBuffer::unmap</a>(), and <a href="qabstractvideobuffer.html#mapMode">QAbstractVideoBuffer::mapMode</a>().</p>
<!-- @@@map -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|